at.mug.iqm.img.bundle.jai.stuff

Class ImageProcessingTask

java.lang.Object

java.lang.Thread

at.mug.iqm.img.bundle.jai.stuff.ImageProcessingTask

All Implemented Interfaces:

IProgressEmitter, ICancelable, IProcessingTask, Runnable

Direct Known Subclasses:

FuzzyCMeansImageClustering, FuzzyLICMeansImageClustering, KMeansImageClustering, TemplateMatchingWithIterators, TemplateMatchingWithRasters

public abstract class ImageProcessingTask
extends Thread
implements IProgressEmitter, ICancelable, IProcessingTask

This abstract class represents a image processing task that is executed on its own thread. This class uses the concept of processing task size and position - if one can estimate the size (in steps, for example) of the task, an application could get the position of the processing, i.e. how far we are on the task.

Author:

Rafael Santos, Philipp Kainz

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isCancelable A flag, whether the operator can be cancelled or not.
protected AbstractProcessingTask	parentTask A reference to the task, an operator is executed in.
private PropertyChangeSupport	pcs PropertyChangeSupport for the Operator class.
protected boolean	virtual A flag whether or not the processing task uses temporary hard disk storage for large data formats.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ImageProcessingTask()

Method Summary

Modifier and Type	Method and Description
void	addProgressListener(PropertyChangeListener listener, String propertyName) Adds the IProgressListener for the given property name.
void	fireProgressChanged(int progress) Fire the progress of the operator to any IProgressListener.
AbstractProcessingTask	getParentTask()
PropertyChangeSupport	getPcs() Get the PropertyChangeSupport for this object.
abstract long	getPosition() This method returns the position on the image processing task, i.e.
PropertyChangeListener[]	getProgressListeners(String propertyName) List all registered IProgressListeners for a given property name.
abstract long	getSize() This method returns the size of the image processing task.
boolean	isCancelable()
boolean	isCancelled(AbstractProcessingTask task) This method should be invoked within long-running operators which shall be cancelable.
abstract boolean	isFinished() This method returns true if the task is finished.
boolean	isVirtual() Returns whether or not the virtual flag has been set at the execution start of a task.
abstract void	run() This is the method (inherited from Thread) which will do the bulk image processing.
void	setCancelable(boolean isCancelable)
void	setParentTask(AbstractProcessingTask parentTask)
void	setPcs(PropertyChangeSupport pcs) Set the PropertyChangeSupport for this object (should be done in constructor of the implementing class).
void	setVirtual(boolean virtual)

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

pcs

private PropertyChangeSupport pcs

PropertyChangeSupport for the Operator class. Use this variable to emit property changes like status updates from 0 to 100%.

virtual

protected boolean virtual

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

parentTask

protected AbstractProcessingTask parentTask

A reference to the task, an operator is executed in.

isCancelable

protected boolean isCancelable

A flag, whether the operator can be cancelled or not.

Constructor Detail

ImageProcessingTask

public ImageProcessingTask()

Method Detail

run

public abstract void run()

This is the method (inherited from Thread) which will do the bulk image processing. It is declared as abstract as a reminder to the programmer, which must implement it.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

getSize

public abstract long getSize()

This method returns the size of the image processing task. The size can be any estimated value measured in any unit (e.g. number of loops or processed pixels). This method must be implemented on classes which inherit from this one and its result should be constant, i.e. not rely on variables or counters that may change during the execution of the algorithm.

Returns:

the size of the image processing size.

getPosition

public abstract long getPosition()

This method returns the position on the image processing task, i.e. how many processing steps were already done. The classes that inherits from this one must implement this method.

Returns:

the position of the task processing.

isFinished

public abstract boolean isFinished()

This method returns true if the task is finished. Please notice that it is not implemented as (position == size) since there may be cases where the task size is estimated and the position may not be ever equal to the exact size. This method must be implemented on classes which inherit from this one.

Returns:

true if the processing task has finished.

getPcs

public PropertyChangeSupport getPcs()

Get the PropertyChangeSupport for this object.

Returns:

the pcs

setPcs

public void setPcs(PropertyChangeSupport pcs)

Set the PropertyChangeSupport for this object (should be done in constructor of the implementing class).

Parameters:

pcs - the pcs to set

addProgressListener

public void addProgressListener(PropertyChangeListener listener,
                                String propertyName)

Description copied from interface: IProgressEmitter

Adds the IProgressListener for the given property name.

Specified by:

addProgressListener in interface IProgressEmitter

Parameters:

listener - the IProgressListener to be added

propertyName - the name of the property declared in the corresponding PropertyChangeEvent, or null if the IProgressListener shall receive all events.

getProgressListeners

public PropertyChangeListener[] getProgressListeners(String propertyName)

Description copied from interface: IProgressEmitter

List all registered IProgressListeners for a given property name.

Specified by:

getProgressListeners in interface IProgressEmitter

Parameters:

propertyName - the name of the property declared in the corresponding PropertyChangeEvent, or null if all IProgressListeners shall be retrieved.

Returns:

an array of IProgressListeners

fireProgressChanged

public void fireProgressChanged(int progress)

Description copied from interface: IProgressEmitter

Fire the progress of the operator to any IProgressListener.

Specified by:

fireProgressChanged in interface IProgressEmitter

isCancelled

public boolean isCancelled(AbstractProcessingTask task)

This method should be invoked within long-running operators which shall be cancelable.

Specified by:

isCancelled in interface ICancelable

See Also:

ICancelable.isCancelled(AbstractProcessingTask)

isCancelable

public boolean isCancelable()

Specified by:

isCancelable in interface ICancelable

Returns:

the isCancelable

setCancelable

public void setCancelable(boolean isCancelable)

Specified by:

setCancelable in interface ICancelable

Parameters:

isCancelable - the isCancelable to set

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)

setParentTask

public void setParentTask(AbstractProcessingTask parentTask)

Specified by:

setParentTask in interface IProcessingTask

getParentTask

public AbstractProcessingTask getParentTask()

Specified by:

getParentTask in interface IProcessingTask