at.mug.iqm.api.operator

Class AbstractOperator

java.lang.Object

at.mug.iqm.api.operator.AbstractOperator

All Implemented Interfaces:

IProgressEmitter, ICancelable, IOperator

Direct Known Subclasses:

IqmOpACF, IqmOpAffine, IqmOpAlign, IqmOpBorder, IqmOpBUnwarpJ, IqmOpCalcImage, IqmOpCalcValue, IqmOpCoGReg, IqmOpColDecon, IqmOpComplexLogDepth, IqmOpConvert, IqmOpCreateFracSurf, IqmOpCreateImage, IqmOpCrop, IqmOpDFT, IqmOpDirLocal, IqmOpDistMap, IqmOpEdge, IqmOpFracBox, IqmOpFracFFT, IqmOpFracGenDim, IqmOpFracHiguchi, IqmOpFracHRM, IqmOpFracIFS, IqmOpFracLac, IqmOpFracMinkowski, IqmOpFracPyramid, IqmOpFracScan, IqmOpFracSurrogate, IqmOpHistoModify, IqmOpImgStabilizer, IqmOpInvert, IqmOpKMeans, IqmOpKMeansFuzzy, IqmOpMorph, IqmOpNexelScan, IqmOpRank, IqmOpRegGrow, IqmOpResize, IqmOpRGBRelative, IqmOpROISegment, IqmOpSmooth, IqmOpStackStat, IqmOpStatistics, IqmOpStatRegMerge, IqmOpTempMatch, IqmOpThreshold, IqmOpTurboReg, IqmOpUnsharpMask, IqmOpWatershed, IqmOpWhiteBalance, PlotOpAutoCorrelation, PlotOpComplLogDepth, PlotOpCut, PlotOpDCMGenerator, PlotOpEntropy, PlotOpFFT, PlotOpFilter, PlotOpFracAllomScale, PlotOpFracHiguchi, PlotOpFracHurst, PlotOpFracSurrogate, PlotOpFractalGenerator, PlotOpMath, PlotOpPointFinder, PlotOpSignalGenerator, PlotOpStatistics, PlotOpSymbolicAggregation

public abstract class AbstractOperator
extends Object
implements IOperator

This class is the parent class for all operators in IQM.

PlotOperators and ImageOperators inherit from this class.

Author:

Philipp Kainz

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isCancelable A flag, whether the operator can be cancelled or not.
protected String	name The cached unique name of the operator.
protected AbstractProcessingTask	parentTask A reference to the task, an operator is executed in.
protected PropertyChangeSupport	pcs PropertyChangeSupport for the Operator class.
protected OperatorType	type The type of the operator.

Constructor Summary

Constructors

Constructor and Description
AbstractOperator()

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.
abstract String	getName() Gets the unique name of the IOperator by returning the "GlobalName" element from the resources[][] of the associated IOperatorDescriptor.
AbstractProcessingTask	getParentTask() Get the executing task of this operator.
PropertyChangeSupport	getPcs() Get the PropertyChangeSupport for this object.
PropertyChangeListener[]	getProgressListeners(String propertyName) List all registered IProgressListeners for a given property name.
abstract OperatorType	getType() Gets the type of the operator listed in an enumeration.
protected void	initializeOperator() Common initialization method for all operators.
boolean	isCancelable()
boolean	isCancelled(AbstractProcessingTask task) This method should be invoked within long-running operators which shall be cancelled at certain execution stages.
abstract IResult	run(IWorkPackage wp) This method contains the entire logic (algorithm) of the operator.
void	setCancelable(boolean isCancelable)
void	setParentTask(AbstractProcessingTask parentTask) Set the executing task of this operator.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The cached unique name of the operator.

type

protected OperatorType type

The type of the operator.

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. Default is true.

pcs

protected PropertyChangeSupport pcs

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

Constructor Detail

AbstractOperator

public AbstractOperator()

Method Detail

initializeOperator

protected void initializeOperator()

Common initialization method for all operators. This initialization sets all operators cancelable true per default.

run

public abstract IResult run(IWorkPackage wp)
                     throws Exception

Description copied from interface: IOperator

This method contains the entire logic (algorithm) of the operator. An IOperator does not declare any class members, since the execution of this code must be thread-safe.

Specified by:

run in interface IOperator

Parameters:

wp - the parameters and sources

Returns:

a IResult containing all processed data

Throws:

Exception - if something went wrong

getName

public abstract String getName()

Description copied from interface: IOperator

Gets the unique name of the IOperator by returning the "GlobalName" element from the resources[][] of the associated IOperatorDescriptor.

Specified by:

getName in interface IOperator

Returns:

the unique name of the operator

getType

public abstract OperatorType getType()

Description copied from interface: IOperator

Gets the type of the operator listed in an enumeration.

Specified by:

getType in interface IOperator

Returns:

the OperatorType

setParentTask

public void setParentTask(AbstractProcessingTask parentTask)

Description copied from interface: IOperator

Set the executing task of this operator.

Specified by:

setParentTask in interface IOperator

getParentTask

public AbstractProcessingTask getParentTask()

Description copied from interface: IOperator

Get the executing task of this operator.

Specified by:

getParentTask in interface IOperator

Returns:

the parent task of this operator

isCancelled

public boolean isCancelled(AbstractProcessingTask task)

This method should be invoked within long-running operators which shall be cancelled at certain execution stages.

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

getPcs

public PropertyChangeSupport getPcs()

Get the PropertyChangeSupport for this object.

Specified by:

getPcs in interface IOperator

Returns:

the pcs

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