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

Inherits org.sleuthkit.autopsy.textextractors.TextExtractor.

Public Member Functions

 TextFileExtractor (AbstractFile file)
Charset getEncoding ()
default Map< String, String > getMetadata ()
Reader getReader ()
boolean isSupported ()
default void setExtractionSettings (Lookup context)

Static Public Attributes

static final Charset UNKNOWN_CHARSET

Private Member Functions

Reader getReader (Charset encoding)

Private Attributes

Charset encoding = null
final AbstractFile file

Static Private Attributes

static final Logger logger = Logger.getLogger(SqliteTextExtractor.class.getName())
static final double MIN_DECODETECT_MATCH_CONFIDENCE = 0.4

Detailed Description

A TextExtractor that is used to extract text from a text file.

Definition at line 45 of file

Constructor & Destructor Documentation

org.sleuthkit.autopsy.textextractors.TextFileExtractor.TextFileExtractor ( AbstractFile  file)

Constructs a TextExtractor that is used to extract text from a text file.

fileThe file.

Definition at line 94 of file

References org.sleuthkit.autopsy.textextractors.TextFileExtractor.file.

Member Function Documentation

Charset org.sleuthkit.autopsy.textextractors.TextFileExtractor.getEncoding ( )
default Map<String, String> org.sleuthkit.autopsy.textextractors.TextExtractor.getMetadata ( )

Retrieves content metadata, if any.

Metadata as key -> value map

Definition at line 72 of file

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractTextAndIndex().

Reader org.sleuthkit.autopsy.textextractors.TextFileExtractor.getReader ( )
Reader org.sleuthkit.autopsy.textextractors.TextFileExtractor.getReader ( Charset  encoding)

Definition at line 107 of file

boolean org.sleuthkit.autopsy.textextractors.TextFileExtractor.isSupported ( )

Determines if this extractor supports the given Content and configurations passed into it in org.sleuthkit.autopsy.textextractors.TextExtractorFactory.

true if content is supported, false otherwise

Implements org.sleuthkit.autopsy.textextractors.TextExtractor.

Definition at line 112 of file

default void org.sleuthkit.autopsy.textextractors.TextExtractor.setExtractionSettings ( Lookup  context)

Determines how the extraction process will proceed given the settings stored in the context instance.

contextInstance containing file config classes

Definition at line 63 of file

Referenced by org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor().

Member Data Documentation

Charset org.sleuthkit.autopsy.textextractors.TextFileExtractor.encoding = null
final AbstractFile org.sleuthkit.autopsy.textextractors.TextFileExtractor.file
final Logger org.sleuthkit.autopsy.textextractors.TextFileExtractor.logger = Logger.getLogger(SqliteTextExtractor.class.getName())

Definition at line 84 of file

final int org.sleuthkit.autopsy.textextractors.TextFileExtractor.MIN_CHARSETDETECT_MATCH_CONFIDENCE = 41
final double org.sleuthkit.autopsy.textextractors.TextFileExtractor.MIN_DECODETECT_MATCH_CONFIDENCE = 0.4
final Charset org.sleuthkit.autopsy.textextractors.TextFileExtractor.UNKNOWN_CHARSET
Initial value:
= new Charset("unknown", null) {
public boolean contains(Charset cs) {
return false;
public CharsetDecoder newDecoder() {
return null;
public CharsetEncoder newEncoder() {
return null;

Definition at line 51 of file

Referenced by org.sleuthkit.autopsy.textextractors.TextFileExtractor.getEncoding(), and org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getMIMEType().

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

Copyright © 2012-2019 Basis Technology. Generated on: Tue Jan 7 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.