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


Public Member Functions

default void generateReport (String baseReportDir, ReportProgressPanel progressPanel)
void generateReport (GeneralReportSettings settings, ReportProgressPanel progressPanel)
default ReportModuleSettings getConfiguration ()
JPanel getConfigurationPanel ()
default ReportModuleSettings getDefaultConfiguration ()
String getDescription ()
String getName ()
String getRelativeFilePath ()
default void setConfiguration (ReportModuleSettings settings)
boolean supportsDataSourceSelection ()

Static Private Attributes

static final Logger logger = Logger.getLogger(ExtractAllTermsReport.class.getName())
static final String OUTPUT_FILE_NAME = "Unique Words.txt"

Detailed Description

Instances of this class plug in to the reporting infrastructure to provide a convenient way to extract all unique terms from Solr index.

Definition at line 40 of file

Member Function Documentation

default void ( String  baseReportDir,
ReportProgressPanel  progressPanel 

Called to generate the report. Method is responsible for saving the file at the path specified and updating progress via the progressPanel object.

baseReportDirBase directory that reports are being stored in. Report should go into baseReportDir + getRelativeFilePath().
progressPanelpanel to update the report's progress with
Use generateReport(GeneralReportSettings settings, ReportProgressPanel progressPanel) instead. The baseReportDir is stored in the settings instance.

Implemented in

Definition at line 36 of file

Referenced by

void org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.generateReport ( GeneralReportSettings  settings,
ReportProgressPanel  progressPanel 
default ReportModuleSettings ( )

Get current configuration for this report module.

Object which contains current report module settings.

Implemented in,, and

Definition at line 79 of file

JPanel org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.getConfigurationPanel ( )

Returns the configuration panel for the report, which is displayed in the report configuration step of the report wizard.

Configuration panel or null if the module does not need configuration.


Definition at line 131 of file

default ReportModuleSettings ( )
String org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.getDescription ( )

Gets a one-line, user friendly description of the type of report this module generates.


Definition at line 127 of file

String org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.getName ( )

Get the name of the report this module generates.


Definition at line 48 of file

String org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.getRelativeFilePath ( )

Gets the relative path of the report file, if any, generated by this module. The path should be relative to the location that gets passed in to generateReport() (or similar).

Relative path to where report will be stored. Return an empty string if the location passed to generateReport() is the output location. Return null to indicate that there is no report file.


Definition at line 136 of file

default void ( ReportModuleSettings  settings)
boolean org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.supportsDataSourceSelection ( )

Determines if the module supports report generation on a subset of data sources in a case. Defaults to false. The data source selections are stored in the GeneralReportSettings instance.

True if the module can be configured to run on a subset of data sources.


Definition at line 120 of file

Member Data Documentation

final Logger org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.logger = Logger.getLogger(ExtractAllTermsReport.class.getName())

Definition at line 42 of file

final String org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.OUTPUT_FILE_NAME = "Unique Words.txt"

Definition at line 43 of file

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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.