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

Inherits JPanel.

Inherited by org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.

Classes

enum  ReportStatus
 

Public Member Functions

 ReportProgressPanel ()
 
 ReportProgressPanel (String reportName, String reportPath)
 
void cancel ()
 
void complete (ReportStatus reportStatus)
 
void complete (ReportStatus reportStatus, String statusMessage)
 
void complete ()
 
ReportStatus getStatus ()
 
void increment ()
 
void setIndeterminate (boolean indeterminate)
 
final void setLabels (String reportName, String reportPath)
 
void setMaximumProgress (int max)
 
void setProgress (int value)
 
void start ()
 
void updateStatusLabel (String statusMessage)
 

Protected Member Functions

void setStatus (ReportStatus status)
 

Private Member Functions

void initComponents ()
 
String shortenPath (String path)
 

Private Attributes

javax.swing.JLabel pathLabel
 
javax.swing.JLabel reportLabel
 
javax.swing.JProgressBar reportProgressBar
 
javax.swing.JLabel separationLabel
 
volatile ReportStatus status
 
javax.swing.JLabel statusMessageLabel
 

Static Private Attributes

static final Color GREEN = new Color(50, 205, 50)
 
static final Logger logger = Logger.getLogger(ReportProgressPanel.class.getName())
 
static final Color RED = new Color(178, 34, 34)
 
static final long serialVersionUID = 1L
 

Detailed Description

A panel used by a report generation module to show progress.

Definition at line 37 of file ReportProgressPanel.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel ( )

Constructs a panel used by report generation module to show progress.

Definition at line 82 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.QUEUING.

org.sleuthkit.autopsy.report.ReportProgressPanel.ReportProgressPanel ( String  reportName,
String  reportPath 
)

Constructs a panel used by a report generation module to show progress.

Parameters
reportNameThe report name.
reportPathThe report path.
Deprecated:
Use ReportProgressPanel() and setLabels() instead.

Definition at line 437 of file ReportProgressPanel.java.

Member Function Documentation

void org.sleuthkit.autopsy.report.ReportProgressPanel.cancel ( )

Makes the components of this panel indicate generation of the report was cancelled.

Definition at line 319 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED.

Referenced by org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.generateReport().

void org.sleuthkit.autopsy.report.ReportProgressPanel.complete ( ReportStatus  reportStatus)
void org.sleuthkit.autopsy.report.ReportProgressPanel.complete ( ReportStatus  reportStatus,
String  statusMessage 
)

Makes the components of this panel indicate the final status of generation of the report.

Parameters
reportStatusThe final status, must be COMPLETE or ERROR.
statusMessageString to use as label or error text.

Definition at line 278 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE, and org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.ERROR.

void org.sleuthkit.autopsy.report.ReportProgressPanel.complete ( )

Makes the components of this panel indicate the generation of the report is completed.

Deprecated:
Use complete(ReportStatus)

Definition at line 449 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.COMPLETE.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.complete().

ReportStatus org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus ( )
void org.sleuthkit.autopsy.report.ReportProgressPanel.increment ( )
void org.sleuthkit.autopsy.report.ReportProgressPanel.initComponents ( )
private

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

Definition at line 365 of file ReportProgressPanel.java.

void org.sleuthkit.autopsy.report.ReportProgressPanel.setIndeterminate ( boolean  indeterminate)
final void org.sleuthkit.autopsy.report.ReportProgressPanel.setLabels ( String  reportName,
String  reportPath 
)

Sets label text.

Parameters
reportNameThe name of the report being generated.
reportPathThe path to the report file.

Definition at line 98 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.geolocation.GeolocationTopComponent.reportButtonActionPerformed().

void org.sleuthkit.autopsy.report.ReportProgressPanel.setMaximumProgress ( int  max)
void org.sleuthkit.autopsy.report.ReportProgressPanel.setProgress ( int  value)

Sets the current value of the progress bar component of this panel.

Parameters
valueThe value to be set.

Definition at line 212 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED.

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport().

void org.sleuthkit.autopsy.report.ReportProgressPanel.setStatus ( ReportStatus  status)
protected

Sets the current status of the generation of the report.

Parameters
statusThe current status.

Definition at line 168 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.cancel(), and org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.start().

String org.sleuthkit.autopsy.report.ReportProgressPanel.shortenPath ( String  path)
private

Gets a shortened version of a file path.

Parameters
pathThe path to shorten.
Returns
The shortened path.

Definition at line 349 of file ReportProgressPanel.java.

void org.sleuthkit.autopsy.report.ReportProgressPanel.start ( )
void org.sleuthkit.autopsy.report.ReportProgressPanel.updateStatusLabel ( String  statusMessage)

Changes the status message label component of this panel to show a given processing status message. For example, updateStatusLabel("Now processing files...") sets the label text to "Now processing files..."

Parameters
statusMessageString to use as label text.

Definition at line 242 of file ReportProgressPanel.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED.

Referenced by org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.copyContentToPortableCase(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.displayReportErrors(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.generateCaseUcoReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateFileListReport(), org.sleuthkit.autopsy.keywordsearch.ExtractAllTermsReport.generateReport(), org.sleuthkit.autopsy.report.modules.stix.STIXReportModule.generateReport(), org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.generateReport(), org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport(), org.sleuthkit.autopsy.report.modules.kml.KMLReport.generateReport(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.generateReport(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateReports(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.getFiles(), org.sleuthkit.autopsy.report.modules.stix.STIXReportModule.saveResultsAsArtifacts(), and org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.warnIngest().

Member Data Documentation

final Color org.sleuthkit.autopsy.report.ReportProgressPanel.GREEN = new Color(50, 205, 50)
staticprivate

Definition at line 41 of file ReportProgressPanel.java.

final Logger org.sleuthkit.autopsy.report.ReportProgressPanel.logger = Logger.getLogger(ReportProgressPanel.class.getName())
staticprivate

Definition at line 40 of file ReportProgressPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.pathLabel
private

Definition at line 420 of file ReportProgressPanel.java.

final Color org.sleuthkit.autopsy.report.ReportProgressPanel.RED = new Color(178, 34, 34)
staticprivate

Definition at line 42 of file ReportProgressPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.reportLabel
private

Definition at line 421 of file ReportProgressPanel.java.

javax.swing.JProgressBar org.sleuthkit.autopsy.report.ReportProgressPanel.reportProgressBar
private

Definition at line 422 of file ReportProgressPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.separationLabel
private

Definition at line 423 of file ReportProgressPanel.java.

final long org.sleuthkit.autopsy.report.ReportProgressPanel.serialVersionUID = 1L
staticprivate

Definition at line 39 of file ReportProgressPanel.java.

volatile ReportStatus org.sleuthkit.autopsy.report.ReportProgressPanel.status
private

Definition at line 43 of file ReportProgressPanel.java.

javax.swing.JLabel org.sleuthkit.autopsy.report.ReportProgressPanel.statusMessageLabel
private

Definition at line 424 of file ReportProgressPanel.java.


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.