ucar.nc2.ui.widget

Class ProgressMonitorTask

java.lang.Object

ucar.nc2.ui.widget.ProgressMonitorTask

All Implemented Interfaces:

java.lang.Runnable, CancelTask

public abstract class ProgressMonitorTask
extends java.lang.Object
implements java.lang.Runnable, CancelTask

Subclass this for use in a ProgressMonitor. Responsibilities of your subclass:

• You must provide the run method, which actually does the work that the ProgressMonitor is showing progress for.
• You must set the done flag for the ProgressMonitor to complete. To avoid race conditions, do eveything else before you set the done flag.
• You should override setProgress() and return a real count that corresponds to progressMaxCount in ProgressMonitor.start().
• If possible, you should stop working if isCancel(). Usually this means checking the cancel flag in an iteration.
• You should set the success flag if everything worked ok.
• You should set an error message if there is an error. Normally you would also set done=true, and stop working. The ProgressMonitor will detect this and exit.

The ProgressMonitor will:

• Call cancel() if the user pressed cancel.
• Set progress value by counting elapsed seconds. You may overrride this by overridding getProgress() and/or getNote().

See Also:

ProgressMonitor

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancel
protected boolean	done
protected java.lang.String	error
protected java.lang.String	note
protected int	progress
protected boolean	success

Constructor Summary

Constructors

Constructor and Description
ProgressMonitorTask()

Method Summary

Modifier and Type	Method and Description
void	cancel() ProgressMonitor will call this when the user cancels.
java.lang.String	getErrorMessage() Applications call this to get an error message.
java.lang.String	getNote() ProgressMonitor displays this note in the ProgressMonitor.
int	getProgress() ProgressMonitor displays this progress value in the ProgressMonitor.
boolean	isCancel() Application calls to see if task is cancelled.
boolean	isDone() ProgressMonitor calls to see if task is done.
boolean	isError() Applications call this to find out if there was an error.
boolean	isSuccess() Application calls to see if task is success.
abstract void	run() Here is where the work gets done.
void	setError(java.lang.String error) for compatibility with ucar.nc2.CancelTask
void	setProgress(java.lang.String msg, int progress) Called routine may optionally show a progress message for calling program to show to user.

Methods inherited from class java.lang.Object

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

Field Detail

done

protected boolean done

success

protected boolean success

cancel

protected boolean cancel

error

protected java.lang.String error

note

protected java.lang.String note

progress

protected int progress

Constructor Detail

ProgressMonitorTask

public ProgressMonitorTask()

Method Detail

run

public abstract void run()

Here is where the work gets done.

Specified by:

run in interface java.lang.Runnable

isSuccess

public boolean isSuccess()

Application calls to see if task is success.

isCancel

public boolean isCancel()

Application calls to see if task is cancelled.

Specified by:

isCancel in interface CancelTask

Returns:

true if task was cancelled

isError

public boolean isError()

Applications call this to find out if there was an error.

getErrorMessage

public java.lang.String getErrorMessage()

Applications call this to get an error message.

isDone

public boolean isDone()

ProgressMonitor calls to see if task is done.

cancel

public void cancel()

ProgressMonitor will call this when the user cancels.

getNote

public java.lang.String getNote()

ProgressMonitor displays this note in the ProgressMonitor. If null, ProgressMonitor will show elasped seconds.

getProgress

public int getProgress()

ProgressMonitor displays this progress value in the ProgressMonitor. If <0, ProgressMonitor will show elasped seconds.

setError

public void setError(java.lang.String error)

for compatibility with ucar.nc2.CancelTask

Specified by:

setError in interface CancelTask

Parameters:

error - message to show user

setProgress

public void setProgress(java.lang.String msg,
                        int progress)

Description copied from interface: CancelTask

Called routine may optionally show a progress message for calling program to show to user.

Specified by:

setProgress in interface CancelTask

Parameters:

msg - message to show user

progress - count of progress