weka.core.progress

Class AbstractProgressBar

java.lang.Object

weka.core.progress.AbstractProgressBar

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CommandLineProgressBar, GUIProgressBar

public abstract class AbstractProgressBar
extends java.lang.Object
implements java.io.Serializable

Handles common tasks between the GUI and Command line progress bar.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractProgressBar(double maxProgress, java.lang.String progressMessage) Create a new progress bar.

Method Summary

Modifier and Type	Method and Description
abstract void	finish() Perform any teardown (e.g., close popup window, display completion message)
java.lang.String	getETAString() Gets the estimated time remaining of the task, or "" if indeterminate
double	getMaxProgress() Get the max progress value
java.lang.String	getProgressMessage() Return the user supplied progress message
void	increment() Helper methods so consumers don't need to keep track of iterations.
boolean	isIndeterminate() Gets the indeterminate status of the progress bar
abstract void	refreshDisplay() Update the progress bar display.
void	setIndeterminate(boolean m_indeterminate) Sets the indeterminate status of the progress bar
void	setMaxProgress(double max) Set the max progress value
void	setProgress(double progress) Main update method.
void	setProgressMessage(java.lang.String message) Set the progress message
void	start() Initialize all values to 0 and start the progress manager.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractProgressBar

public AbstractProgressBar(double maxProgress,
                           java.lang.String progressMessage)

Create a new progress bar.

Parameters:

maxProgress - Max progress the bar can reach.

progressMessage - Message to display.

Method Detail

start

public void start()

Initialize all values to 0 and start the progress manager.

increment

public void increment()

Helper methods so consumers don't need to keep track of iterations.

finish

public abstract void finish()

Perform any teardown (e.g., close popup window, display completion message)

refreshDisplay

public abstract void refreshDisplay()

Update the progress bar display.

setProgress

public void setProgress(double progress)

Main update method. Recalculates the current level of progress and refreshes the progress display.

Parameters:

progress - Actual progress value (e.g., current iteration number)

getMaxProgress

public double getMaxProgress()

Get the max progress value

Returns:

Maximum progress (e.g., max number of iterations)

setMaxProgress

public void setMaxProgress(double max)

Set the max progress value

Parameters:

max - Maximum value for progress (e.g., max number of iterations)

getProgressMessage

public java.lang.String getProgressMessage()

Return the user supplied progress message

Returns:

User supplied progress message

setProgressMessage

public void setProgressMessage(java.lang.String message)

Set the progress message

Parameters:

message - Progress Message (e.g., Processing data...)

getETAString

public java.lang.String getETAString()

Gets the estimated time remaining of the task, or "" if indeterminate

Returns:

Formatted ETA string

isIndeterminate

public boolean isIndeterminate()

Gets the indeterminate status of the progress bar

Returns:

Indeterminate status

setIndeterminate

public void setIndeterminate(boolean m_indeterminate)

Sets the indeterminate status of the progress bar

Parameters:

m_indeterminate - Indeterminate status