Package adams.flow.core

Interface ActorHandler

All Superinterfaces:

Actor, AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, ErrorHandler, Flushable, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, Serializable, ShallowCopySupporter<Actor>, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Subinterfaces:

ActorReferenceHandler, FixedNameActorHandler, LocalScopeHandler, MutableActorHandler, ScopeHandler, SortableActorHandler, StandaloneGroup<T>, StandaloneMutableGroup<T>

All Known Implementing Classes:

AbstractConnectedControlActor, AbstractContainerUpdater, AbstractControlActor, AbstractDataContainerFileChecker, AbstractDirectedControlActor, AbstractMultiView, AbstractMutableActorDaemonEvent, AbstractMutableStandaloneGroupItem, AbstractStandaloneGroup, AbstractStandaloneGroupItemGroup, AbstractStandaloneGroupItemMutableGroup, AbstractStandaloneMutableGroup, AbstractTee, ArrayGenerate, ArrayProcess, AutogeneratedSink, AutogeneratedSource, AutogeneratedStandalone, AutogeneratedTransformer, Branch, CallableActors, ClipboardActorContainer, CollectionProcess, ConditionalSequence, ConditionalStandalones, ConditionalSubProcess, ConditionalTee, ConditionalTrigger, ContainerValuePicker, Count, Cron, DelayedEvent, DirWatch, Events, FileProcessor, Flow, GridView, IfStorageValue, IfThenElse, InactiveSink, InactiveSource, InactiveStandalone, InactiveTransformer, InputOutputListener, JavaExec, JMap, LaunchTee, LaunchTrigger, LoadBalancer, LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger, LogEvent, MutableConnectedControlActor, MutableControlActor, Once, PlotContainerUpdater, QueueEvent, Rejector, RemoteExecutionTrigger, Sequence, SequenceSource, SinkReset, SourceReset, Standalones, StorageValueSequence, SubProcess, Switch, SwitchedSource, TabView, Tee, TimedSubProcess, TimedTee, TimedTrigger, TransformerReset, Trigger, TriggerOnce, TryCatch, UpdateContainerValue, UpdateProperties, VariableChangedEvent, WhileLoop

public interface ActorHandler
extends Actor, Flushable

For actors that handle "sub-actors".

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
String	check()	Performs checks on the "sub-actors".
Actor	firstActive()	Returns the first non-skipped actor.
void	flushExecution()	Stops the processing of tokens without stopping the flow.
Actor	get(int index)	Returns the actor at the given position.
ActorHandlerInfo	getActorHandlerInfo()	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
int	indexOf(String actor)	Returns the index of the actor.
Actor	lastActive()	Returns the last non-skipped actor.
String	set(int index, Actor actor)	Sets the actor at the given position.
int	size()	Returns the size of the group.

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

getActorHandlerInfo

ActorHandlerInfo getActorHandlerInfo()

Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.

Returns:

the info

check

String check()

Performs checks on the "sub-actors".

Returns:

null if everything is fine, otherwise the error

size

int size()

Returns the size of the group.

Returns:

the size

get

Actor get(int index)

Returns the actor at the given position.

Parameters:

index - the position

Returns:

the actor

set

String set(int index,
           Actor actor)

Sets the actor at the given position.

Parameters:

index - the position

actor - the actor to set at this position

Returns:

null if successful, otherwise error message

indexOf

int indexOf(String actor)

Returns the index of the actor.

Parameters:

actor - the name of the actor to look for

Returns:

the index of -1 if not found

firstActive

Actor firstActive()

Returns the first non-skipped actor.

Returns:

the first 'active' actor, null if none available

lastActive

Actor lastActive()

Returns the last non-skipped actor.

Returns:

the last 'active' actor, null if none available

flushExecution

void flushExecution()

Stops the processing of tokens without stopping the flow.

Specified by:

flushExecution in interface Flushable