AbstractGenericTask

java.lang.Object
- javax.swing.SwingWorker<java.lang.Boolean,java.lang.Object>
- - repicea.app.AbstractGenericTask

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, java.util.concurrent.Future<java.lang.Boolean>, java.util.concurrent.RunnableFuture<java.lang.Boolean>, Executable, GenericTask

Direct Known Subclasses:

CATTask, DataSet, ExportTool.InternalSwingWorkerForRecordSet, JavaProcessWrapper, REpiceaExportTool.InternalSwingWorkerForRecordSet, REpiceaRecordReader.InternalTask, ServerTask
```
public abstract class AbstractGenericTask
extends javax.swing.SwingWorker<java.lang.Boolean,java.lang.Object>
implements GenericTask, java.io.Serializable
```
This class is the basic class for all the GenericTask classes. It extends the SwingWorker class. The result of the task as whether or not it was correclty terminated is set during the done() method. NOTE: The super methods get(), and cancel(boolean) are not recommended. The user should use the methods isCorrectlyTerminated() and cancel() instead.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.SwingWorker
  javax.swing.SwingWorker.StateValue

Field Summary

Fields
Modifier and Type Field and Description

protected boolean isCancelled
Member isCancelled should be used in the doThisJob() method to ensure a proper cancellation.

Fields
Modifier and Type	Field and Description
`protected boolean`	`isCancelled` Member isCancelled should be used in the doThisJob() method to ensure a proper cancellation.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractGenericTask()
Empty constructor.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractGenericTask()` Empty constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` This method is called to cancel a running task.
`protected java.lang.Boolean`	`doInBackground()` Compared to the super class, the doInBackground() no longer throws exceptions.
`protected void`	`done()`
`protected abstract void`	`doThisJob()` This method is the inner part of the doInBackground method.
`java.lang.Exception`	`getFailureReason()` This method returns the exception that has caused the task to terminate incorrectly.
`java.lang.String`	`getName()` This method returns the name of the task.
`boolean`	`hasBeenCancelled()` This method returns true if the method cancel() has been called.
`boolean`	`isCorrectlyTerminated()` This method returns true if the task is correctly terminated or false otherwise.
`boolean`	`isVerbose()` This method returns true if the task displays messages.
`protected void`	`setCorrectlyTerminated(boolean correctlyTerminated)` This methods sets the correctlyTerminated member.
`protected void`	`setFailureReason(java.lang.Exception failureReason)` This method sets the failureReason member.
`protected void`	`setName(java.lang.String name)` This method sets the name of the task.
`java.lang.String`	`toString()`

Methods inherited from class javax.swing.SwingWorker
addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Runnable
run

- Field Detail
  - isCancelled
```
protected boolean isCancelled
```
    Member isCancelled should be used in the doThisJob() method to ensure a proper cancellation.
- Constructor Detail
  - AbstractGenericTask
```
protected AbstractGenericTask()
```
    Empty constructor.
- Method Detail
  - isCorrectlyTerminated
```
public boolean isCorrectlyTerminated()
```
    Description copied from interface: Executable
    
    This method returns true if the task is correctly terminated or false otherwise.
    
    Specified by:
    
    isCorrectlyTerminated in interface Executable
    
    Returns:
    
    a Boolean instance
  - setCorrectlyTerminated
```
protected void setCorrectlyTerminated(boolean correctlyTerminated)
```
    This methods sets the correctlyTerminated member.
    
    Parameters:
    
    correctlyTerminated - a boolean
  - getFailureReason
```
public java.lang.Exception getFailureReason()
```
    Description copied from interface: Executable
    
    This method returns the exception that has caused the task to terminate incorrectly.
    
    Specified by:
    
    getFailureReason in interface Executable
    
    Returns:
    
    an Exception
  - setFailureReason
```
protected void setFailureReason(java.lang.Exception failureReason)
```
    This method sets the failureReason member.
    
    Parameters:
    
    failureReason - an Exception instance
  - setName
```
protected void setName(java.lang.String name)
```
    This method sets the name of the task.
    
    Parameters:
    
    name - a String
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: GenericTask
    
    This method returns the name of the task.
    
    Specified by:
    
    getName in interface GenericTask
    
    Returns:
    
    a String object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - cancel
```
public void cancel()
```
    Description copied from interface: GenericTask
    
    This method is called to cancel a running task.
    
    Specified by:
    
    cancel in interface GenericTask
  - hasBeenCancelled
```
public final boolean hasBeenCancelled()
```
    Description copied from interface: GenericTask
    
    This method returns true if the method cancel() has been called.
    
    Specified by:
    
    hasBeenCancelled in interface GenericTask
    
    Returns:
    
    a boolean
  - doInBackground
```
protected final java.lang.Boolean doInBackground()
```
    Compared to the super class, the doInBackground() no longer throws exceptions. The exceptions are rather catched and registred as failure reasons.
    
    Specified by:
    
    doInBackground in class javax.swing.SwingWorker<java.lang.Boolean,java.lang.Object>
    
    Returns:
    
    a Boolean true if the task ended correctly or false otherwise
  - doThisJob
```
protected abstract void doThisJob()
                           throws java.lang.Exception
```
    This method is the inner part of the doInBackground method. It should be defined in derived classes.
    
    Throws:
    
    java.lang.Exception
  - done
```
protected final void done()
```
    Overrides:
    
    done in class javax.swing.SwingWorker<java.lang.Boolean,java.lang.Object>
  - isVerbose
```
public boolean isVerbose()
```
    Description copied from interface: GenericTask
    
    This method returns true if the task displays messages.
    
    Specified by:
    
    isVerbose in interface GenericTask
    
    Returns:
    
    a boolean

Class AbstractGenericTask

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.swing.SwingWorker

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Runnable

Field Detail

isCancelled

Constructor Detail

AbstractGenericTask

Method Detail

isCorrectlyTerminated

setCorrectlyTerminated

getFailureReason

setFailureReason

setName

getName

toString

cancel

hasBeenCancelled

doInBackground

doThisJob

done

isVerbose