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

Classes

class  NoTextExtractorFound
 

Static Public Member Functions

static TextExtractor getExtractor (Content content, Lookup context) throws NoTextExtractorFound
 
static TextExtractor getExtractor (Content content) throws NoTextExtractorFound
 
static TextExtractor getStringsExtractor (Content content, Lookup context)
 

Static Private Member Functions

static List< TextExtractorgetFileExtractors (AbstractFile content, Lookup context)
 

Detailed Description

Factory for creating TextExtractors given a Content instance

See org.sleuthkit.autopsy.textextractors.configs for available extractor configuration options.

See also
org.openide.util.Lookup

Definition at line 37 of file TextExtractorFactory.java.

Member Function Documentation

static TextExtractor org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor ( Content  content,
Lookup  context 
) throws NoTextExtractorFound
static

Returns a TextExtractor containing the Content text. Configuration files can be added to the Lookup.

See org.sleuthkit.autopsy.textextractors.configs for available extractor configuration options.

Parameters
contentContent source that will be read from
contextContains extraction configurations for certain file types
Returns
TextExtractor containing file text
Exceptions
NoTextExtractorFoundEncountered when there is no Reader found for the given content type or there was an error while creating the reader.
See also
org.openide.util.Lookup

Definition at line 57 of file TextExtractorFactory.java.

References org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getFileExtractors(), and org.sleuthkit.autopsy.textextractors.TextExtractor.setExtractionSettings().

Referenced by org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.getExtractor(), org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.ExtractAndTranslateTextTask.getTextExtractor(), org.sleuthkit.autopsy.keywordsearch.SolrSearchService.index(), and org.sleuthkit.autopsy.keywordsearch.SolrSearchService.indexArtifact().

static TextExtractor org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor ( Content  content) throws NoTextExtractorFound
static

Returns a TextExtractor containing the Content text.

Parameters
contentContent instance that will be read from
Returns
TextExtractor containing file text
Exceptions
NoTextExtractorFoundEncountered when there is no Reader was found for the given content type. Use getStringsExtractor(Content,Lookup) method instead.

Definition at line 116 of file TextExtractorFactory.java.

References org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor().

static List<TextExtractor> org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getFileExtractors ( AbstractFile  content,
Lookup  context 
)
staticprivate

Initializes, orders, and returns all file extractors that can read AbstractFile instances.

Parameters
contentAbstractFile content
contextLookup containing extractor configurations
Returns
List of all extractors in priority order. Not all will support the passed in content. @@ PERHAPS ONLY SUPPORTED SHOULD BE RETURNED

This should go last to ensure the more specific ones are picked first.

Definition at line 90 of file TextExtractorFactory.java.

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

static TextExtractor org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getStringsExtractor ( Content  content,
Lookup  context 
)
static

Returns a TextExtractor containing the Content strings. This method supports all content types. This method should be used as a backup in the event that no reader was found using getExtractor(Content) or getExtractor(Content, Lookup).

Configure this extractor with the StringsConfig in org.sleuthkit.autopsy.textextractors.configs

Parameters
contentContent source to read from
contextContains extraction configurations for certain file types
Returns
TextExtractor containing file text
See also
org.openide.util.Lookup

Definition at line 136 of file TextExtractorFactory.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.Indexer.extractStringsAndIndex(), org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.ExtractAndTranslateTextTask.getTextExtractor(), and org.sleuthkit.autopsy.keywordsearch.SolrSearchService.index().


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

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