Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | List of all members
org.sleuthkit.autopsy.textextractors.TextExtractor Interface Reference

Inherited by org.sleuthkit.autopsy.textextractors.ArtifactTextExtractor, org.sleuthkit.autopsy.textextractors.HtmlTextExtractor, org.sleuthkit.autopsy.textextractors.SqliteTextExtractor, org.sleuthkit.autopsy.textextractors.StringsTextExtractor, org.sleuthkit.autopsy.textextractors.TextFileExtractor, and org.sleuthkit.autopsy.textextractors.TikaTextExtractor.

Classes

class  InitReaderException
 

Public Member Functions

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

Detailed Description

Extracts the text out of Content instances and exposes them as a Reader. Concrete implementations can be obtained from org.sleuthkit.autopsy.textextractors.TextExtractorFactory

Definition at line 33 of file TextExtractor.java.

Member Function Documentation

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

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.TextExtractor.getReader ( ) throws InitReaderException
boolean org.sleuthkit.autopsy.textextractors.TextExtractor.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

Implemented in org.sleuthkit.autopsy.textextractors.TextFileExtractor.

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.

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 ( )

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.


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

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