weka.core.progress

Class ProgressManager

java.lang.Object

weka.core.progress.ProgressManager

All Implemented Interfaces:

java.io.Serializable

public class ProgressManager
extends java.lang.Object
implements java.io.Serializable

Main entrypoint for any progress-bar related tasks. Handles switching between GUI and command line, based on whether WEKA is being run from GUI or command line (or Java code)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProgressManager() Init the progress manager.
ProgressManager(double maxProgress, java.lang.String progressMessage) Init a new progress manager, setting the maximum progress and progress message.
ProgressManager(java.lang.String indeterminateProgressMessage) Init a new indeterminate progress manager (no notion of iterating progress).

Method Summary

Modifier and Type	Method and Description
boolean	checkIfRunByGUI() Checks the stacktrace for a call to anything in the weka.gui package.
void	finish() Close out the progress bar.
void	increment() Increment the progress bar.
void	setMaxProgress(double maxProgress) Set the maximum progress value of the progress bar
void	setProgress(double progress) Set the progress to a specific value
void	setProgressMessage(java.lang.String progressMessage) Set the progress message to be displayed in the progress bar
void	start() Show the progress bar and start the timer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressManager

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

Init a new progress manager, setting the maximum progress and progress message.

Parameters:

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

progressMessage - Progress message to display

ProgressManager

public ProgressManager(java.lang.String indeterminateProgressMessage)

Init a new indeterminate progress manager (no notion of iterating progress).

Parameters:

indeterminateProgressMessage - Progress message to display

ProgressManager

public ProgressManager()

Init the progress manager.

Method Detail

checkIfRunByGUI

public boolean checkIfRunByGUI()

Checks the stacktrace for a call to anything in the weka.gui package. If that exists, WEKA was started by the GUIChooser

Returns:

True if being run within the GUI.

start

public void start()

Show the progress bar and start the timer.

increment

public void increment()

Increment the progress bar.

setProgress

public void setProgress(double progress)

Set the progress to a specific value

Parameters:

progress - Current progress

finish

public void finish()

Close out the progress bar.

setMaxProgress

public void setMaxProgress(double maxProgress)

Set the maximum progress value of the progress bar

Parameters:

maxProgress - Maximum progress value

setProgressMessage

public void setProgressMessage(java.lang.String progressMessage)

Set the progress message to be displayed in the progress bar

Parameters:

progressMessage - Progress message