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

Inherits org.sleuthkit.autopsy.report.ReportModule.

Inherited by org.sleuthkit.autopsy.report.modules.excel.ExcelReport, and org.sleuthkit.autopsy.report.modules.html.HTMLReport.

Public Member Functions

void addRow (List< String > row)
 
void addSetElement (String elementName)
 
void addSetIndex (List< String > sets)
 
String dateToString (long date)
 
void endDataType ()
 
void endReport ()
 
void endSet ()
 
void endTable ()
 
default ReportModuleSettings getConfiguration ()
 
default JPanel getConfigurationPanel ()
 
default ReportModuleSettings getDefaultConfiguration ()
 
String getDescription ()
 
String getName ()
 
String getRelativeFilePath ()
 
default void setConfiguration (ReportModuleSettings settings)
 
void startDataType (String title, String description)
 
void startReport (String baseReportDir)
 
void startSet (String setName)
 
void startTable (List< String > titles)
 

Detailed Description

ReportModule that implements a tabular style of reporting.

All TableReportModules will be sent the exact data to report, and will only have to determine how to write and display this data.

The data sent consists of user-chosen fields such as Blackboard Artifacts and File/Result Tags.

Definition at line 33 of file TableReportModule.java.

Member Function Documentation

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.addRow ( List< String >  row)

Add a row with the cell values given to the current table.

Parameters
rowList of String cell values

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.addSetElement ( String  elementName)

Add an element to the current set. An element is considered the 'title' of a table in a set, a sub-set in a sense.

Parameters
elementNameString name of element

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.addSetIndex ( List< String >  sets)

Add an index of all the sets to the report's current data type. This method is guaranteed to be called before any sets are added to the data type, and may be ignored.

Parameters
setsList of all the String set names

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

String org.sleuthkit.autopsy.report.infrastructure.TableReportModule.dateToString ( long  date)

Returns a String date, created by the module. All date values will query the module for its interpretation of the date before sending it a row with the date value.

Parameters
datelong date as long
Returns
String date as String

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.endDataType ( )

End the current data type and prepare for either the end of the report or the start of a new data type.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.endReport ( )

End the report. Close all output streams and write any end-of-report files.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.endSet ( )

End the current set and prepare for either the end of the current data type or the start of a new set.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.endTable ( )

End the current table.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

default ReportModuleSettings org.sleuthkit.autopsy.report.ReportModule.getConfiguration ( )
inherited

Get current configuration for this report module.

Returns
Object which contains current report module settings.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Definition at line 79 of file ReportModule.java.

default JPanel org.sleuthkit.autopsy.report.ReportModule.getConfigurationPanel ( )
inherited
default ReportModuleSettings org.sleuthkit.autopsy.report.ReportModule.getDefaultConfiguration ( )
inherited

Get default configuration for this report module.

Returns
Object which contains default report module settings.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Definition at line 70 of file ReportModule.java.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports().

String org.sleuthkit.autopsy.report.ReportModule.getDescription ( )
inherited
String org.sleuthkit.autopsy.report.ReportModule.getName ( )
inherited
String org.sleuthkit.autopsy.report.ReportModule.getRelativeFilePath ( )
inherited

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

Returns
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.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport, org.sleuthkit.autopsy.report.modules.kml.KMLReport, org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule, org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport, org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule, org.sleuthkit.autopsy.report.modules.datasourcesummaryexport.DataSourceSummaryReport, org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb, and org.sleuthkit.autopsy.report.GeneralReportModuleAdapter.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.setupProgressPanel().

default void org.sleuthkit.autopsy.report.ReportModule.setConfiguration ( ReportModuleSettings  settings)
inherited

Set report module configuration.

Parameters
settingsObject which contains report module settings.

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport, and org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.

Definition at line 88 of file ReportModule.java.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports().

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.startDataType ( String  title,
String  description 
)

Start a new data type for the report. This is how the report will differentiate between the start and end of a certain type of data, such as a blackboard artifact Type. It is up to the report how the differentiation is shown.

Parameters
titleString name of the data type
descriptionDescription of the data type

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.startReport ( String  baseReportDir)

Start the report. Open any output streams, initialize member variables, write summary and navigation pages. Considered the "constructor" of the report.

Parameters
baseReportDirDirectory to save the report file into. Report should go into baseReportDir + getRelativeFilePath().

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.startSet ( String  setName)

Start a new set, or sub-category, for the current data type.

Parameters
setNameString name of the set

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.

void org.sleuthkit.autopsy.report.infrastructure.TableReportModule.startTable ( List< String >  titles)

Create a table with the column names given.

Parameters
titlesList of String column names

Implemented in org.sleuthkit.autopsy.report.modules.html.HTMLReport.


The documentation for this interface 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.