Class MonitorWorker

java.lang.Object

javax.swing.SwingWorker<ExitStatus, Integer>

com.xinapse.util.MonitorWorker

All Implemented Interfaces:

Runnable, Future<ExitStatus>, RunnableFuture<ExitStatus>

Direct Known Subclasses:

AbstractDynamicWorker, ContourWorker, MultiContrastAnalysisFrame.ShowResponseWorker, SmootherWorker

public abstract class MonitorWorker
extends SwingWorker<ExitStatus, Integer>

A class to implement a SwingWorker that can pop up a ProgressMonitor or IndeterminateProgressMonitor to allow user cancellation. It is up to the MonitorWorker's doInBackground() method to check whether cancellation has occured using either the setMonitorProgress(int progress) method, which throws a CancelledException, or directly with the SwingWorker.isCancelled() method.

Nested Class Summary

Nested classes/interfaces inherited from class SwingWorker

SwingWorker.StateValue

Nested classes/interfaces inherited from interface Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
IndeterminateProgressMonitor	indeterminateMonitor	An IndeterminateProgressMonitor which may pop up.
final Logger	logger	The Logger the program that is running this MonitorWorker.
ProgressMonitor	monitor	A ProgressMonitor which may pop up.

Method Summary

Modifier and Type	Method	Description
void	checkCancelled()	Tests whether this MonitorWorker has been cancelled.
void	checkCancelled(Integer progress)	Tests whether this MonitorWorker has been cancelled, and sets the progress through this operation.
void	checkCancelled(String message)	Tests whether this MonitorWorker has been cancelled.
void	checkCancelled(String message, Integer progress)	Tests whether this MonitorWorker has been cancelled, and sets the progress through this operation.
abstract ExitStatus	doInBackground()	Overrides the doInBackground() method.
void	done()	Overrides the done() method.
Component	getComponent()	Returns the component from which this MonitorWorker was launched.
String	getErrorMessage()	Returns the error message set for this MonitorWorker.
void	setAction(String descr)	Set the action description for the ProgressMonitor or IndeterminateProgressMonitor.
void	setAction(String descr, int min, int max)	Set the action description for the ProgressMonitor.
void	setErrorMessage(String message)	Sets the error message for this MonitorWorker,

Methods inherited from class SwingWorker

addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, removePropertyChangeListener, run

Methods inherited from class Object

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

Methods inherited from interface Future

exceptionNow, resultNow, state

Field Details

logger

public final Logger logger

The Logger the program that is running this MonitorWorker.

monitor

public ProgressMonitor monitor

A ProgressMonitor which may pop up.

indeterminateMonitor

public IndeterminateProgressMonitor indeterminateMonitor

An IndeterminateProgressMonitor which may pop up.

Method Details

getComponent

public Component getComponent()

Returns the component from which this MonitorWorker was launched.

Returns:

the component (if non-null) from which this MonitorWorker was launched.

setAction

public void setAction(String descr,
 int min,
 int max)

Set the action description for the ProgressMonitor.

Parameters:

descr - the action description.

min - the minimum for the ProgressMonitor.

max - the maximum for the ProgressMonitor.

setAction

public void setAction(String descr)

Set the action description for the ProgressMonitor or IndeterminateProgressMonitor.

Parameters:

descr - the action description.

checkCancelled

public void checkCancelled()
                    throws CancelledException

Tests whether this MonitorWorker has been cancelled.

Throws:

CancelledException - if the operation has been cancelled.

checkCancelled

public void checkCancelled(String message)
                    throws CancelledException

Tests whether this MonitorWorker has been cancelled.

Parameters:

message - a message to put to the IndeterminateProgressMonitor.

Throws:

CancelledException - if the operation has been cancelled.

checkCancelled

public void checkCancelled(Integer progress)
                    throws CancelledException

Tests whether this MonitorWorker has been cancelled, and sets the progress through this operation.

Parameters:

progress - the progress of the ProgressMonitor.

Throws:

CancelledException - if the operation has been cancelled.

checkCancelled

public void checkCancelled(String message,
 Integer progress)
                    throws CancelledException

Tests whether this MonitorWorker has been cancelled, and sets the progress through this operation.

Parameters:

message - a message to put to the IndeterminateProgressMonitor.

progress - the progress of the ProgressMonitor.

Throws:

CancelledException - if the operation has been cancelled.

doInBackground

public abstract ExitStatus doInBackground()

Overrides the doInBackground() method.

Returns:

the ExitStatus indicating whether the processing was successful, and if not why not.

done

public void done()

Overrides the done() method. Closes the ProgressMonitor or IndeterminateProgressMonitor.

setErrorMessage

public void setErrorMessage(String message)

Sets the error message for this MonitorWorker,

Parameters:

message - the error message.

getErrorMessage

public String getErrorMessage()

Returns the error message set for this MonitorWorker.

Returns:

the error message, or null if no error message has been set.