org.apache.cayenne.modeler.util

Class LongRunningTask

java.lang.Object

org.apache.cayenne.modeler.util.LongRunningTask

public abstract class LongRunningTask
extends Object

A base class for monitoring progress of long running tasks. It can runshowing the exact percentage of the task progress or in "indeterminate" mode.

Warning: If the task started via "startAndWait()", caller must ensure that she is not running in the Swing EventDispatchThread, otherwise an exception is thrown, as the EvenDispatchThread will be blocked, preventing LongRunningTask from showing progress dialog.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canceled
protected static int	DEFAULT_MS_TO_DECIDE_TO_POPUP
protected ProgressDialog	dialog
protected boolean	finished
protected JFrame	frame
protected int	maxValue
protected int	minValue
protected Timer	taskPollingTimer
protected String	title

Constructor Summary

Constructors

Constructor and Description
LongRunningTask(JFrame frame, String title)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	execute() Runs the actual task, consulting "isCanceled()" state to make sure that the task wasn't canceled.
protected abstract String	getCurrentNote()
protected abstract int	getCurrentValue()
int	getMaxValue()
int	getMinValue()
protected void	internalExecute()
boolean	isCanceled()
boolean	isFinished()
protected abstract boolean	isIndeterminate()
void	setCanceled(boolean b)
void	setMaxValue(int maxValue)
void	setMinValue(int minValue)
protected void	showProgress() Starts progress dialog if the task is not finished yet.
void	start() Configures the task to run in a separate thread, and immediately exits the method.
void	startAndWait() Starts current task, and blocks current thread until the task is done.
protected void	stop()
protected void	updateProgress() Updates current state of the progress dialog.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MS_TO_DECIDE_TO_POPUP

protected static final int DEFAULT_MS_TO_DECIDE_TO_POPUP

See Also:

Constant Field Values

dialog

protected ProgressDialog dialog

frame

protected JFrame frame

title

protected String title

taskPollingTimer

protected Timer taskPollingTimer

canceled

protected boolean canceled

minValue

protected int minValue

maxValue

protected int maxValue

finished

protected boolean finished

Constructor Detail

LongRunningTask

public LongRunningTask(JFrame frame,
               String title)

Method Detail

startAndWait

public void startAndWait()

Starts current task, and blocks current thread until the task is done.

start

public void start()

Configures the task to run in a separate thread, and immediately exits the method. This method is allowed to be invoked from EventDispatchThread.

showProgress

protected void showProgress()

Starts progress dialog if the task is not finished yet.

updateProgress

protected void updateProgress()

Updates current state of the progress dialog.

stop

protected void stop()

isFinished

public boolean isFinished()

isCanceled

public boolean isCanceled()

setCanceled

public void setCanceled(boolean b)

internalExecute

protected void internalExecute()

execute

protected abstract void execute()

Runs the actual task, consulting "isCanceled()" state to make sure that the task wasn't canceled.

getCurrentNote

protected abstract String getCurrentNote()

getCurrentValue

protected abstract int getCurrentValue()

isIndeterminate

protected abstract boolean isIndeterminate()

getMaxValue

public int getMaxValue()

setMaxValue

public void setMaxValue(int maxValue)

getMinValue

public int getMinValue()

setMinValue

public void setMinValue(int minValue)