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	indexToSolr
Boolean	limitedOCREnabled
HashSet< String >	namesOfDisabledKeywordLists
final HashSet< String >	namesOfEnabledKeywordLists
Boolean	ocrEnabled
boolean	ocrOnly

Static Private Attributes
static final boolean	DEFAULT_INDEX_TO_SOLR = true
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 158 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

(

)

Whether or not OCR is enabled for keyword search.

Returns

Whether or not OCR is enabled for keyword search.

Definition at line 92 of file KeywordSearchJobSettings.java.

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

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.getExtractor(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettingsPanel.initializeKeywordListSettings(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.process().

void org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.setOCREnabled

(

boolean

ocrEnabled

)

Sets whether or not OCR is enabled for keyword search.

Parameters

ocrEnabled

Whether or not OCR is enabled for keyword search.

Definition at line 105 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 200 of file KeywordSearchJobSettings.java.

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

Member Data Documentation

final boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.DEFAULT_INDEX_TO_SOLR = true

staticprivate

Definition at line 32 of file KeywordSearchJobSettings.java.

Boolean org.sleuthkit.autopsy.keywordsearch.KeywordSearchJobSettings.indexToSolr

private

Definition at line 47 of file KeywordSearchJobSettings.java.

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

private

Definition at line 42 of file KeywordSearchJobSettings.java.

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

private

Definition at line 35 of file KeywordSearchJobSettings.java.

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

private

Definition at line 34 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 41 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 44 of file KeywordSearchJobSettings.java.

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

staticprivate

Definition at line 31 of file KeywordSearchJobSettings.java.

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

---

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

• /home/carriersleuth/repos/autopsy/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchJobSettings.java