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

Inherits JPanel.

Classes

enum  ReportStatus
 

Public Member Functions

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

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 ( String  reportName,
String  reportPath 
)

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

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

Definition at line 64 of file ReportProgressPanel.java.

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

Member Function Documentation

void org.sleuthkit.autopsy.report.ReportProgressPanel.complete ( ReportStatus  reportStatus)
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 373 of file ReportProgressPanel.java.

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

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

Gets the current status of the generation of the report.

Returns
The report generation status as a ReportStatus enum.

Definition at line 124 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb.generateReport(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

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

Increments the current value of the progress bar component of this panel by one unit.

Definition at line 155 of file ReportProgressPanel.java.

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

Referenced by org.sleuthkit.autopsy.modules.stix.STIXReportModule.processFile().

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 299 of file ReportProgressPanel.java.

void org.sleuthkit.autopsy.report.ReportProgressPanel.setIndeterminate ( boolean  indeterminate)

Changes the the progress bar component of this panel to be determinate or indeterminate.

Parameters
indeterminateTrue if the progress bar should be set to indeterminate.

Definition at line 183 of file ReportProgressPanel.java.

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

Referenced by org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb.generateReport(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

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

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

Parameters
maxThe maximum value.

Definition at line 143 of file ReportProgressPanel.java.

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

Referenced by org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

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 168 of file ReportProgressPanel.java.

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

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 283 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 198 of file ReportProgressPanel.java.

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

Referenced by org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb.generateReport(), and org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport().

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 359 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 360 of file ReportProgressPanel.java.

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

Definition at line 361 of file ReportProgressPanel.java.

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

Definition at line 362 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 363 of file ReportProgressPanel.java.


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

Copyright © 2012-2018 Basis Technology. Generated on: Tue Dec 18 2018
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.