public abstract class ALDOperatorControllable extends ALDOperator implements ALDControlEventListener, ALDControlEventReporter, ALDConfigurationEventListener, ALDConfigurationEventReporter
This operator acts as listener for `Alida` control events. On receiving events the operator changes its control status which may be used to control operator execution, and in particular to interrupt calculations in a controlled fashion, i.e. to keep results already obtained.
| Modifier and Type | Class and Description |
|---|---|
static class |
ALDOperatorControllable.OperatorControlStatus
Commands for controlling the operator.
|
static class |
ALDOperatorControllable.OperatorExecutionStatus
Actual operator status.
|
ALDOperator.ConstructioMode, ALDOperator.HidingMode| Modifier and Type | Field and Description |
|---|---|
protected EventListenerList |
configurationEventlistenerList
List of configuration event listeners attached to this reporter.
|
protected EventListenerList |
controlEventlistenerList
List of control event listeners attached to this reporter.
|
protected boolean |
notifyListenersRecursively
Flag for recursive propagation of events to nested listeners.
|
protected ALDOperatorControllable.OperatorExecutionStatus |
operatorExecStatus
Actual execution state of operator.
|
protected ALDOperatorControllable.OperatorControlStatus |
operatorStatus
Control status of operator, used to stop/pause/resume calculations.
|
protected int |
stepSize
Step size in step-wise execution mode.
|
protected boolean |
stepWiseExecution
Flag for step-wise execution.
|
completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider| Constructor and Description |
|---|
ALDOperatorControllable()
Default constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addALDConfigurationEventListener(ALDConfigurationEventListener listener)
Adds a listener to this reporter.
|
void |
addALDControlEventListener(ALDControlEventListener listener)
Adds a listener to this reporter.
|
void |
fireALDConfigurationEvent(ALDConfigurationEvent event)
Sends an event to all registered listeners.
|
void |
fireALDControlEvent(ALDControlEvent event)
Sends the given event to all registered listeners.
|
ALDOperatorControllable.OperatorExecutionStatus |
getExecutionStatus()
Get the current execution status of the operator.
|
void |
handleALDConfigurationEvent(ALDConfigurationEvent event)
Method which is called on event occurence.
|
void |
handleALDControlEvent(ALDControlEvent event)
Method which is called on event occurence.
|
void |
removeALDConfigurationEventListener(ALDConfigurationEventListener listener)
Removes a listener from this reporter.
|
void |
removeALDControlEventListener(ALDControlEventListener listener)
Removes a listener from this reporter.
|
void |
setNotifyRecursiveFlag(boolean flag)
Specify if events are to be passed forward to nested listeners or not.
|
abstract boolean |
supportsStepWiseExecution()
Function for indicating if step-wise execution is supported.
|
addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getHidingMode, getInInoutNames, getInInoutNames, getInNames, getInOutNames, getMissingRequiredInputs, getName, getNumParameters, getOutInoutNames, getOutNames, getParameter, getParameterDescriptor, getParameterNames, getSupplementalNames, getVerbose, getVersion, handleOperatorExecutionProgressEvent, hasInOutParameters, hasParameter, isAnnotatedParameter, isConfigured, operate, print, print, print, printInterface, printInterface, readHistory, readResolve, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setVerbose, toStringVerbose, unconfiguredItems, validate, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistoryprotected boolean stepWiseExecution
protected int stepSize
protected boolean notifyListenersRecursively
protected volatile EventListenerList controlEventlistenerList
protected volatile EventListenerList configurationEventlistenerList
protected volatile ALDOperatorControllable.OperatorControlStatus operatorStatus
protected volatile ALDOperatorControllable.OperatorExecutionStatus operatorExecStatus
public ALDOperatorControllable()
throws ALDOperatorException
ALDOperatorExceptionpublic void setNotifyRecursiveFlag(boolean flag)
public ALDOperatorControllable.OperatorExecutionStatus getExecutionStatus()
public abstract boolean supportsStepWiseExecution()
public void handleALDControlEvent(ALDControlEvent event)
ALDControlEventListenerhandleALDControlEvent in interface ALDControlEventListenerevent - Event to be handled.public void addALDControlEventListener(ALDControlEventListener listener)
ALDControlEventReporteraddALDControlEventListener in interface ALDControlEventReporterlistener - Listener to be added.public void removeALDControlEventListener(ALDControlEventListener listener)
ALDControlEventReporterremoveALDControlEventListener in interface ALDControlEventReporterlistener - Listener to be removed.public void fireALDControlEvent(ALDControlEvent event)
ALDControlEventReporterfireALDControlEvent in interface ALDControlEventReporterevent - Event to be send to all listeners.public void addALDConfigurationEventListener(ALDConfigurationEventListener listener)
ALDConfigurationEventReporteraddALDConfigurationEventListener in interface ALDConfigurationEventReporterlistener - Listener to be added.public void removeALDConfigurationEventListener(ALDConfigurationEventListener listener)
ALDConfigurationEventReporterremoveALDConfigurationEventListener in interface ALDConfigurationEventReporterlistener - Listener to be removed.public void fireALDConfigurationEvent(ALDConfigurationEvent event)
ALDConfigurationEventReporterfireALDConfigurationEvent in interface ALDConfigurationEventReporterevent - Event to be send to all listeners.public void handleALDConfigurationEvent(ALDConfigurationEvent event)
ALDConfigurationEventListenerhandleALDConfigurationEvent in interface ALDConfigurationEventListenerevent - Event to be handled.Copyright © 2010–2015 Martin Luther University Halle-Wittenberg, Institute of Computer Science, Pattern Recognition and Bioinformatics. All rights reserved.