org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress Class Reference

Public Member Functions
void	progress (int workUnits)
void	progress (String message)
void	progress (String currentTask, int workUnits)
void	switchToDeterminate (int workUnits)
void	switchToIndeterminate ()

Private Attributes
final DataSourceIngestJob	job

Detailed Description

Used by data source ingest modules to report progress.

Definition at line 24 of file DataSourceIngestModuleProgress.java.

Member Function Documentation

void org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.progress

(

int

workUnits

)

Updates the progress bar with the number of work units performed, if in the determinate mode.

Parameters

workUnits

Number of work units performed so far by the module.

Definition at line 58 of file DataSourceIngestModuleProgress.java.

Referenced by org.sleuthkit.autopsy.modules.e01verify.E01VerifyIngestModule.process(), and org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process().

void org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.progress

(

String

message

)

Updates the sub-title on the progress bar

Parameters

message

Message to display

Definition at line 67 of file DataSourceIngestModuleProgress.java.

void org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.progress	(	String	currentTask,
		int	workUnits
	)

Updates the progress bar with a new task name and the number of work units performed, if in the determinate mode.

Parameters

currentTask	The task name.
workUnits	Number of work units performed so far by the module.

Definition at line 78 of file DataSourceIngestModuleProgress.java.

void org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.switchToDeterminate

(

int

workUnits

)

Updates the progress bar and switches it to determinate mode. This should be called by the module as soon as the number of total work units required to process the data source is known.

Parameters

workUnits

Total number of work units for the processing of the data source.

Definition at line 40 of file DataSourceIngestModuleProgress.java.

Referenced by org.sleuthkit.autopsy.modules.e01verify.E01VerifyIngestModule.process(), and org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process().

void org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.switchToIndeterminate

(

)

Switches the progress bar to indeterminate mode. This should be called if the total work units to process the data source is unknown.

Definition at line 48 of file DataSourceIngestModuleProgress.java.

Member Data Documentation

final DataSourceIngestJob org.sleuthkit.autopsy.ingest.DataSourceIngestModuleProgress.job

private

Definition at line 26 of file DataSourceIngestModuleProgress.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestModuleProgress.java