Autopsy  4.19.3
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.textextractors.TextFileExtractor Class Reference

Inherits org.sleuthkit.autopsy.textextractors.TextExtractor.

Public Member Functions

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

Private Member Functions

Reader getReader (Charset encoding)
 

Private Attributes

Charset encoding = null
 
final AbstractFile file
 

Static Private Attributes

static final Logger logger = Logger.getLogger(TextFileExtractor.class.getName())
 
static final String PLAIN_TEXT_MIME_TYPE = "text/plain"
 

Detailed Description

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

Definition at line 39 of file TextFileExtractor.java.

Constructor & Destructor Documentation

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

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

Parameters
fileThe file.

Definition at line 52 of file TextFileExtractor.java.

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

Member Function Documentation

default Map<String, String> org.sleuthkit.autopsy.textextractors.TextExtractor.getMetadata ( )
inherited

Retrieves content metadata, if any.

Returns
Metadata as key -> value map

Definition at line 74 of file TextExtractor.java.

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

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

Definition at line 74 of file TextFileExtractor.java.

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.

Returns
true if content is supported, false otherwise

Implements org.sleuthkit.autopsy.textextractors.TextExtractor.

Definition at line 79 of file TextFileExtractor.java.

References org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.getMIMEType().

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

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

Parameters
contextInstance containing file config classes

Definition at line 65 of file TextExtractor.java.

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

default boolean org.sleuthkit.autopsy.textextractors.TextExtractor.willUseOCR ( )
inherited

Returns true if this text extractor, based on the provided settings, will perform ocr.

Returns
True if will perform OCR.

Definition at line 84 of file TextExtractor.java.

Member Data Documentation

Charset org.sleuthkit.autopsy.textextractors.TextFileExtractor.encoding = null
private

Definition at line 45 of file TextFileExtractor.java.

final AbstractFile org.sleuthkit.autopsy.textextractors.TextFileExtractor.file
private
final Logger org.sleuthkit.autopsy.textextractors.TextFileExtractor.logger = Logger.getLogger(TextFileExtractor.class.getName())
staticprivate

Definition at line 41 of file TextFileExtractor.java.

final String org.sleuthkit.autopsy.textextractors.TextFileExtractor.PLAIN_TEXT_MIME_TYPE = "text/plain"
staticprivate

Definition at line 43 of file TextFileExtractor.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Wed Oct 5 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.