de.unihalle.informatik.Alida.demo

Class ALDDemoOpControllableHandle

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.Alida.operator.ALDOperatorControllable

de.unihalle.informatik.Alida.demo.ALDDemoOpControllableHandle

All Implemented Interfaces:

ALDConfigurationValidator, ALDConfigurationEventListener, ALDConfigurationEventReporter, ALDControlEventListener, ALDControlEventReporter, ALDOperatorExecutionProgressEventListener, EventListener

@ALDAOperator(genericExecutionMode=ALL,
              level=STANDARD,
              shortDescription="Demonstrates the capabilities of controllable operators in Alida and the interaction with them via handles.")
public class ALDDemoOpControllableHandle
extends ALDOperatorControllable

Controllable demo operator for testing interaction using the status handle.

Author:

moeller

Nested Class Summary

Nested classes/interfaces inherited from class de.unihalle.informatik.Alida.operator.ALDOperatorControllable

ALDOperatorControllable.OperatorControlStatus, ALDOperatorControllable.OperatorControlStatusHandle, ALDOperatorControllable.OperatorExecutionStatus

Nested classes/interfaces inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

ALDOperator.HidingMode, ALDOperator.HistoryConstructionMode

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	operatorID Operator identifier.

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperatorControllable

configurationEventlistenerList, controlEventlistenerList, notifyListenersRecursively, operatorExecStatus, stepSize, stepWiseExecution

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
ALDDemoOpControllableHandle() Default constructor.

Method Summary

Modifier and Type	Method and Description
String	getDocumentation() Full description of the operator, e.g., to be shown as documentation in GUI.
protected void	operate() This method does the actual work and needs to be implemented by every subclass.
boolean	supportsStepWiseExecution() Function for indicating if step-wise execution is supported.

Methods inherited from class de.unihalle.informatik.Alida.operator.ALDOperatorControllable

addALDConfigurationEventListener, addALDControlEventListener, fireALDConfigurationEvent, fireALDControlEvent, getControlStatus, getControlStatusHandle, getExecutionStatus, handleALDConfigurationEvent, handleALDControlEvent, removeALDConfigurationEventListener, removeALDControlEventListener, setControlStatus, setNotifyRecursiveFlag

Methods inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getHidingMode, getInactiveParameterNames, getInInoutNames, getInInoutNames, getInNames, getInOutNames, getMissingRequiredInputs, getName, getNumParameters, getOutInoutNames, getOutNames, getParameter, getParameterDescriptor, getParameterDescriptorUnconditioned, getParameterNames, getParameterUnconditioned, getSupplementalNames, getVerbose, getVersion, handleOperatorExecutionProgressEvent, hasInOutParameters, hasParameter, isAnnotatedParameter, isConfigured, print, print, print, printInterface, printInterface, readHistory, readResolve, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setParameterUnconditioned, setVerbose, toStringVerbose, unconfiguredItems, validate, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory

Methods inherited from class java.lang.Object

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

Field Detail

operatorID

protected static final String operatorID

Operator identifier.

See Also:

Constant Field Values

Constructor Detail

ALDDemoOpControllableHandle

public ALDDemoOpControllableHandle()
                            throws ALDOperatorException

Default constructor.

Throws:

ALDOperatorException - Thrown in case of failure.

Method Detail

supportsStepWiseExecution

public boolean supportsStepWiseExecution()

Description copied from class: ALDOperatorControllable

Function for indicating if step-wise execution is supported.

Specified by:

supportsStepWiseExecution in class ALDOperatorControllable

Returns:

If true, operator may be executed step-wise.

operate

protected final void operate()

Description copied from class: ALDOperator

This method does the actual work and needs to be implemented by every subclass.

Specified by:

operate in class ALDOperator

getDocumentation

public String getDocumentation()

Description copied from class: ALDOperator

Full description of the operator, e.g., to be shown as documentation in GUI.

Overrides:

getDocumentation in class ALDOperator

Returns:

Full description of the operator, maybe null.