org.cishell.framework.algorithm
Interface ProgressTrackable


public interface ProgressTrackable

An additional interface an Algorithm can implement that allows for monitoring of progress, process cancellation, and current work description. This was not included in the Algorithm interface because many of the algorithms will not be able to support these features (especially the algorithms that are wrapping executable programs). Even algorithms that do implement this interface do not have to provide all of the features. For instance, an algorithm may only support progress notification and not cancellation.

Author:
Bruce Herr (bh2@bh2.net)

Method Summary
 ProgressMonitor getProgressMonitor()
          Returns the progress monitor currently in use, or null if no monitor has been set
 void setProgressMonitor(ProgressMonitor monitor)
          Sets the progress monitor this algorithm is to use.
 

Method Detail

setProgressMonitor

void setProgressMonitor(ProgressMonitor monitor)
Sets the progress monitor this algorithm is to use. This method should be called before an algorithm is executed. If this method is not set prior to execution, the algorithm must run without it.

Parameters:
monitor - The monitor the algorithm is to use

getProgressMonitor

ProgressMonitor getProgressMonitor()
Returns the progress monitor currently in use, or null if no monitor has been set

Returns:
The current progress monitor, or null if there isn't one set