at.mug.iqm.api.processing

Class AbstractProcessingTask

java.lang.Object

javax.swing.SwingWorker<Object,Object>

at.mug.iqm.api.processing.AbstractProcessingTask

All Implemented Interfaces:

IProcessingTask, Runnable, Future<Object>, RunnableFuture<Object>

Direct Known Subclasses:

CreateCopiesTask, ExecutorServiceProcessingTask, ImageDataBoxLoader, PreviewProcessingTask, SerialProcessingTask, SingleProcessingTask, TankItemLoader

public abstract class AbstractProcessingTask
extends SwingWorker<Object,Object>
implements IProcessingTask

Author:

Philipp Kainz

Nested Class Summary

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

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractProcessingTask	childTask A reference to the child task, if present.
protected long	duration A variable for recording the actual running time.
protected boolean	headless A flag whether or not the processing task is launched without GUI.
protected IOperator	operator The cached IOperator of this task.
protected IOperatorGUI	operatorGUI The IOperatorGUI of the operator in this task.
protected AbstractProcessingTask	parentTask A reference to the parent task, if present.
protected long	startTime The start time will be set, when the processing starts.
protected boolean	virtual A flag whether or not the processing task uses temporary hard disk storage for large data formats.
protected IWorkPackage	workPackage The cached IWorkPackage.

Constructor Summary

Constructors

Constructor and Description
AbstractProcessingTask() Empty default constructor.
AbstractProcessingTask(IWorkPackage workPackage) Create a new task from a given IWorkPackage.

Method Summary

Modifier and Type	Method and Description
protected abstract Object	doInBackground() This method must be implemented by all subclasses.
protected void	done() This method is called after the doInBackground() method and must be implemented by all subclasses.
AbstractProcessingTask	getChildTask()
IOperator	getOperator()
IOperatorGUI	getOperatorGUI()
AbstractProcessingTask	getParentTask()
IWorkPackage	getWorkPackage()
boolean	isHeadless()
boolean	isVirtual() Returns whether or not the virtual flag has been set at the execution start of a task.
protected void	process(List<Object> chunks) This method is called by the EventDispatcherThread, when publish() is called within the doInBackground() method.
void	setChildTask(AbstractProcessingTask childTask)
void	setHeadless(boolean headless)
void	setOperator(IOperator operator)
void	setOperatorGUI(IOperatorGUI operatorGUI)
void	setParentTask(AbstractProcessingTask parentTask)
void	setVirtual(boolean virtual)
void	setWorkPackage(IWorkPackage workPackage)

Methods inherited from class javax.swing.SwingWorker

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

Methods inherited from class java.lang.Object

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

Field Detail

virtual

protected boolean virtual

A flag whether or not the processing task uses temporary hard disk storage for large data formats.

headless

protected boolean headless

A flag whether or not the processing task is launched without GUI.

startTime

protected long startTime

The start time will be set, when the processing starts.

duration

protected long duration

A variable for recording the actual running time.

workPackage

protected IWorkPackage workPackage

The cached IWorkPackage.

operator

protected IOperator operator

The cached IOperator of this task. Usually the operator shares the reference with the IOperator in the work package.

operatorGUI

protected IOperatorGUI operatorGUI

The IOperatorGUI of the operator in this task.

parentTask

protected AbstractProcessingTask parentTask

A reference to the parent task, if present.

childTask

protected AbstractProcessingTask childTask

A reference to the child task, if present.

Constructor Detail

AbstractProcessingTask

public AbstractProcessingTask()

Empty default constructor.

AbstractProcessingTask

public AbstractProcessingTask(IWorkPackage workPackage)

Create a new task from a given IWorkPackage.

Parameters:

workPackage -

Method Detail

doInBackground

protected abstract Object doInBackground()
                                  throws Exception

This method must be implemented by all subclasses.

Specified by:

doInBackground in class SwingWorker<Object,Object>

Returns:

the processed result, retrievable by get().

Throws:

Exception

process

protected void process(List<Object> chunks)

This method is called by the EventDispatcherThread, when publish() is called within the doInBackground() method.

Overrides:

process in class SwingWorker<Object,Object>

Parameters:

chunks - - the objects to process

done

protected void done()

This method is called after the doInBackground() method and must be implemented by all subclasses. It is called too, when the SwingWorker is cancelled.

Overrides:

done in class SwingWorker<Object,Object>

getWorkPackage

public IWorkPackage getWorkPackage()

Returns:

the workPackage

setWorkPackage

public void setWorkPackage(IWorkPackage workPackage)

Parameters:

workPackage - the workPackage to set

getOperator

public IOperator getOperator()

Returns:

the operator

setOperator

public void setOperator(IOperator operator)

Parameters:

operator - the operator to set

getOperatorGUI

public IOperatorGUI getOperatorGUI()

setOperatorGUI

public void setOperatorGUI(IOperatorGUI operatorGUI)

isVirtual

public boolean isVirtual()

Description copied from interface: IProcessingTask

Returns whether or not the virtual flag has been set at the execution start of a task.

Specified by:

isVirtual in interface IProcessingTask

Returns:

true if every item is serialized to the hard disk and loaded again on demand,
false if the entire processing is performed within the memory.

setVirtual

public void setVirtual(boolean virtual)

isHeadless

public boolean isHeadless()

setHeadless

public void setHeadless(boolean headless)

getParentTask

public AbstractProcessingTask getParentTask()

Specified by:

getParentTask in interface IProcessingTask

setParentTask

public void setParentTask(AbstractProcessingTask parentTask)

Specified by:

setParentTask in interface IProcessingTask

getChildTask

public AbstractProcessingTask getChildTask()

setChildTask

public void setChildTask(AbstractProcessingTask childTask)