Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings Class Reference

Inherits org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings.

Public Member Functions

long getVersionNumber ()
 
boolean isOCREnabled ()
 
void setOCREnabled (boolean ocrEnabled)
 

Private Member Functions

void upgradeFromOlderVersions ()
 

Private Attributes

Boolean limitedOCREnabled
 
HashSet< String > namesOfDisabledKeywordLists
 
HashSet< String > namesOfEnabledKeywordLists
 
Boolean ocrEnabled
 
boolean ocrOnly
 

Static Private Attributes

static final long serialVersionUID = 1L
 

Detailed Description

Ingest job settings for the keywords search module.

Definition at line 29 of file KeywordSearchJobSettings.java.

Member Function Documentation

long org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.getVersionNumber ( )

Returns the version number of the settings object. The version number should be a private final static long per the documentation of the Serializable interface.

Returns
A serialization version number.

Implements org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings.

Definition at line 152 of file KeywordSearchJobSettings.java.

References org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.serialVersionUID, and org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.upgradeFromOlderVersions().

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.isOCREnabled ( )
void org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.setOCREnabled ( boolean  ocrEnabled)

Sets whether or not OCR is enabled for keyword search.

Parameters
ocrEnabledWhether or not OCR is enabled for keyword search.

Definition at line 99 of file KeywordSearchJobSettings.java.

References org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.ocrEnabled.

void org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.upgradeFromOlderVersions ( )
private

Initialize fields set to null when an instance of a previous, but still compatible, version of this class is de-serialized.

Definition at line 194 of file KeywordSearchJobSettings.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.getVersionNumber().

Member Data Documentation

Boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.limitedOCREnabled
private

Definition at line 41 of file KeywordSearchJobSettings.java.

HashSet<String> org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.namesOfDisabledKeywordLists
private

Definition at line 34 of file KeywordSearchJobSettings.java.

HashSet<String> org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.namesOfEnabledKeywordLists
private

Definition at line 33 of file KeywordSearchJobSettings.java.

Boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.ocrEnabled
private

These are nullable so that if no serialized setting, the setting can defer to legacy KeywordSearchSettings.

Definition at line 40 of file KeywordSearchJobSettings.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.isOCREnabled(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.setOCREnabled().

boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.ocrOnly
private

Definition at line 43 of file KeywordSearchJobSettings.java.

final long org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.serialVersionUID = 1L
staticprivate

The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.