Autopsy  4.21.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 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

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.

A serialization version number.

Implements org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings.

Definition at line 158 of file

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.

ocrEnabledWhether or not OCR is enabled for keyword search.

Definition at line 105 of file

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

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

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

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

Member Data Documentation

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

Definition at line 32 of file

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

Definition at line 47 of file

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

Definition at line 42 of file

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

Definition at line 35 of file

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

Definition at line 34 of file

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

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

Definition at line 41 of file

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

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

Definition at line 44 of file

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

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

Copyright © 2012-2022 Basis Technology. Generated on: Tue Feb 6 2024
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.