Inherited by org.sleuthkit.autopsy.progress.LoggingProgressIndicator, org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

Public Member Functions
void	finish ()

void	progress (String message)

void	progress (int workUnitsCompleted)

void	progress (String message, int workUnitsCompleted)

void	start (String message, int totalWorkUnits)

void	start (String message)

void	switchToDeterminate (String message, int workUnitsCompleted, int totalWorkUnits)

void	switchToIndeterminate (String message)

Detailed Description

An interface for progress indicators. A progress indicator can run in determinate mode (the total number of work units to be completed is known) or indeterminate mode. Switching back and forth between the two modes is supported. Starting, finishing, and starting again is supported.

Definition at line 27 of file ProgressIndicator.java.

Member Function Documentation

void org.sleuthkit.autopsy.progress.ProgressIndicator.finish ( )

Finishes the progress indicator when the task is completed.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

Referenced by org.sleuthkit.autopsy.casemodule.Case.close(), org.sleuthkit.autopsy.casemodule.Case.closeAppServiceCaseResources(), org.sleuthkit.autopsy.casemodule.Case.deleteCase(), org.sleuthkit.autopsy.communications.CommunicationsGraph.RebuildWorker.done(), org.sleuthkit.autopsy.casemodule.Case.open(), org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources(), and org.sleuthkit.autopsy.test.TestAutopsyService.openCaseResources().

void org.sleuthkit.autopsy.progress.ProgressIndicator.progress ( String message )

Updates the progress indicator with a progress message.

Parameters

message The progress message.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

void org.sleuthkit.autopsy.progress.ProgressIndicator.progress ( int workUnitsCompleted )

Updates the progress indicator with the number of work units completed so far when in determinate mode (the total number of work units to be completed is known).

Parameters

workUnitsCompleted Number of work units completed so far.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

void org.sleuthkit.autopsy.progress.ProgressIndicator.progress	(	String	message,
		int	workUnitsCompleted
	)

Updates the progress indicator with a progress message and the number of work units completed so far when in determinate mode (the total number of work units to be completed is known).

Parameters

message	The progress message.
workUnitsCompleted	Number of work units completed so far.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

void org.sleuthkit.autopsy.progress.ProgressIndicator.start	(	String	message,
		int	totalWorkUnits
	)

Starts the progress indicator in determinate mode (the total number of work units to be completed is known).

Parameters

message	The initial progress message.
totalWorkUnits	The total number of work units.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

void org.sleuthkit.autopsy.progress.ProgressIndicator.start ( String message )

Starts the progress indicator in indeterminate mode (the total number of work units to be completed is unknown).

Parameters

message The initial progress message.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

void org.sleuthkit.autopsy.progress.ProgressIndicator.switchToDeterminate	(	String	message,
		int	workUnitsCompleted,
		int	totalWorkUnits
	)

Switches the progress indicator to determinate mode (the total number of work units to be completed is known).

Parameters

message	The initial progress message.
workUnitsCompleted	The number of work units completed so far.
totalWorkUnits	The total number of work units to be completed.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

Referenced by org.sleuthkit.autopsy.communications.CommunicationsGraph.RebuildWorker.doInBackground().

void org.sleuthkit.autopsy.progress.ProgressIndicator.switchToIndeterminate ( String message )

Switches the progress indicator to indeterminate mode (the total number of work units to be completed is unknown).

Parameters

message The initial progress message.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

Referenced by org.sleuthkit.autopsy.keywordsearch.SolrSearchService.openCaseResources().

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/progress/ProgressIndicator.java

Public Member Functions

Detailed Description

Member Function Documentation