org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator Class Reference

Inherits org.sleuthkit.autopsy.report.ReportProgressPanel.

Public Member Functions
	ReportProgressIndicator (ProgressIndicator progressIndicator)
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 Attributes
final ProgressIndicator	progressIndicator
int	workUnitsCompleted

Static Private Attributes
static final long	serialVersionUID = 1L

Detailed Description

An adapter that adapts the ReportProgressPanel interface to the ProgressIndicator interface so that a given progress indicator can be used where a ReportProgressPanel is expected.

Definition at line 30 of file ReportProgressIndicator.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.ReportProgressIndicator

(

ProgressIndicator

progressIndicator

)

Constructs an adapter that adapts the ReportProgressPanel interface to the ProgressIndicator interface so that a given progress indicator can be used where a ReportProgressPanel is expected.

Parameters

progressIndicator

The progress indicator to be adapted.

Definition at line 43 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.progressIndicator.

Member Function Documentation

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.cancel

(

)

Definition at line 126 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus(), org.sleuthkit.autopsy.progress.ProgressIndicator.progress(), and org.sleuthkit.autopsy.report.ReportProgressPanel.setStatus().

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.complete

(

ReportStatus

reportStatus

)

Definition at line 96 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.progress.ProgressIndicator.finish(), org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

Definition at line 116 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.complete(), org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

inherited

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

inherited

Gets the current status of the generation of the report.

Returns

The report generation status as a ReportStatus enum.

Definition at line 159 of file ReportProgressPanel.java.

Referenced by org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.addArtifactsToPortableCase(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.addFilesToPortableCase(), org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.cancel(), org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.complete(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.compressCase(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.generateFileListReport(), org.sleuthkit.autopsy.report.modules.stix.STIXReportModule.generateReport(), org.sleuthkit.autopsy.report.modules.taggedhashes.SaveTaggedHashesToHashDb.generateReport(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.generateReport(), and org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.updateStatusLabel().

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.increment

(

)

Definition at line 66 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.progress(), and org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.workUnitsCompleted.

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.setIndeterminate

(

boolean

indeterminate

)

Definition at line 81 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.switchToIndeterminate().

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

inherited

Sets label text.

Parameters

reportName	The name of the report being generated.
reportPath	The 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.infrastructure.ReportProgressIndicator.setMaximumProgress

(

int

max

)

Definition at line 61 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.switchToDeterminate().

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.setProgress

(

int

value

)

Definition at line 72 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

protectedinherited

Sets the current status of the generation of the report.

Parameters

status

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

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.start

(

)

Definition at line 51 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.RUNNING, org.sleuthkit.autopsy.report.ReportProgressPanel.setStatus(), and org.sleuthkit.autopsy.progress.ProgressIndicator.start().

void org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.updateStatusLabel

(

String

statusMessage

)

Definition at line 86 of file ReportProgressIndicator.java.

References org.sleuthkit.autopsy.report.ReportProgressPanel.ReportStatus.CANCELED, org.sleuthkit.autopsy.report.ReportProgressPanel.getStatus(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

Member Data Documentation

final ProgressIndicator org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.progressIndicator

private

Definition at line 33 of file ReportProgressIndicator.java.

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

final long org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.serialVersionUID = 1L

staticprivate

Definition at line 32 of file ReportProgressIndicator.java.

int org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.workUnitsCompleted

private

Definition at line 34 of file ReportProgressIndicator.java.

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

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/report/infrastructure/ReportProgressIndicator.java