es.unex.sextante.core
Interface ITaskMonitor

All Known Implementing Classes:
DefaultTaskMonitor, SilentTaskMonitor

public interface ITaskMonitor

This interface must be implemented by all classes used to monitor the execution of a GeoAlgorithm or any other process within SEXTANTE

Author:
volaya

Method Summary
 void close()
          Closes the monitor.
 boolean isCanceled()
          Returns rue is the task that is being monitored has been canceled using this monitor
 void setDeterminate(boolean bDeterminate)
          Set whether the process is determinate or not
 void setProcessDescription(java.lang.String sDescription)
          Sets the description of the process being monitored
 void setProgress(int iStep)
          Sets the current progress
 void setProgress(int step, int totalNumberOfSteps)
          Sets the current progress
 void setProgressText(java.lang.String sText)
          Sets the current text to display by this task monitor
 

Method Detail

setProgress

void setProgress(int iStep)
Sets the current progress

Parameters:
iStep - the current progress, in percentage (0-100)

setProgress

void setProgress(int step,
                 int totalNumberOfSteps)
Sets the current progress

Parameters:
step - the current step
totalNumberOfSteps - the total number of steps in the task

setProgressText

void setProgressText(java.lang.String sText)
Sets the current text to display by this task monitor

Parameters:
sText - The text to display

isCanceled

boolean isCanceled()
Returns rue is the task that is being monitored has been canceled using this monitor

Returns:
true is the task that is being monitored has been canceled using this monitor

close

void close()
Closes the monitor. This is called once the task has been finished


setDeterminate

void setDeterminate(boolean bDeterminate)
Set whether the process is determinate or not

Parameters:
bDeterminate - whether the process to monitor is determinate (the number of total steps to complete is known)

setProcessDescription

void setProcessDescription(java.lang.String sDescription)
Sets the description of the process being monitored

Parameters:
sDescription - the description of the process being monitored