de.jstacs.utils
Interface ProgressUpdater

All Known Implementing Classes:
DefaultProgressUpdater, GUIProgressUpdater, NullProgressUpdater, TimeLimitedProgressUpdater

public interface ProgressUpdater

Interface for supervising the progress of long time processes like cross validation.

Author:
Andre Gohr, Jan Grau

Method Summary
 boolean isCancelled()
          Specifies if the process is cancelled by the user.
 void setMax(int max)
          Sets the maximal value that will be set by setValue(int), so a value of max indicates the end of the supervised method call.
 void setValue(int value)
          Sets the current value the supervised process has reached.
 

Method Detail

setMax

void setMax(int max)
Sets the maximal value that will be set by setValue(int), so a value of max indicates the end of the supervised method call.

Parameters:
max - the maximal value

setValue

void setValue(int value)
Sets the current value the supervised process has reached.

Parameters:
value - the current value

isCancelled

boolean isCancelled()
Specifies if the process is cancelled by the user.

Returns:
true if process was cancelled, false otherwise