at.mug.iqm.core.processing

Class SingleProcessingTask

java.lang.Object

javax.swing.SwingWorker<Object,Object>

at.mug.iqm.api.processing.AbstractProcessingTask

at.mug.iqm.core.processing.SingleProcessingTask

All Implemented Interfaces:

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

public class SingleProcessingTask
extends AbstractProcessingTask
implements IExplicitProcessingTask

This class performs a processing task on a single image. The image calculation can only be performed in RAM, hence, no virtual mode is possible.

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
private Class<?>	caller
private static org.apache.log4j.Logger	logger

Fields inherited from class at.mug.iqm.api.processing.AbstractProcessingTask

childTask, duration, headless, operator, operatorGUI, parentTask, startTime, virtual, workPackage

Constructor Summary

Constructors

Constructor and Description
SingleProcessingTask()
SingleProcessingTask(IWorkPackage wp) This constructor sets the required variables directly.
SingleProcessingTask(IWorkPackage wp, IOperatorGUI opGUI) This constructor sets the required variables directly.

Method Summary

Modifier and Type	Method and Description
protected IResult	doInBackground() The invocation of SwingWorker.execute() causes the creation of a new background swing worker.
IResult	processExplicit() This method performs the actual calculation on a single image.

Methods inherited from class at.mug.iqm.api.processing.AbstractProcessingTask

done, getChildTask, getOperator, getOperatorGUI, getParentTask, getWorkPackage, isHeadless, isVirtual, process, setChildTask, setHeadless, setOperator, setOperatorGUI, setParentTask, setVirtual, setWorkPackage

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

caller

private Class<?> caller

logger

private static final org.apache.log4j.Logger logger

Constructor Detail

SingleProcessingTask

public SingleProcessingTask()

SingleProcessingTask

public SingleProcessingTask(IWorkPackage wp)

This constructor sets the required variables directly. headless will be set to true. This constructor shall be used when no GUI is needed to be updated. virtual is always false.

SingleProcessingTask

public SingleProcessingTask(IWorkPackage wp,
                            IOperatorGUI opGUI)

This constructor sets the required variables directly. headless will be set to false. This constructor shall be used when a GUI is needed to be updated. virtual is always false.

Method Detail

processExplicit

public IResult processExplicit()
                        throws Exception

This method performs the actual calculation on a single image. Multiple image processing routines might utilize this method in a loop.

Specified by:

processExplicit in interface IExplicitProcessingTask

Returns:

IqmDataBox - a resulting IqmDataBox object containing the processed image/file

Throws:

Exception - if the requested operator is not defined

doInBackground

protected IResult doInBackground()
                          throws Exception

The invocation of SwingWorker.execute() causes the creation of a new background swing worker. The SwingWorker.get() method has to be called in order to block on the calling thread and wait for the result. If you want to do this in one statement, use processExplicit() and the calculation will be performed in the same thread as the call occurs.

Specified by:

doInBackground in class AbstractProcessingTask

Returns:

an IqmDataBox, which is the result of processExplicit()

Throws:

Exception