Package adams.flow.core

Interface MutableActorHandler

All Superinterfaces:

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

All Known Subinterfaces:

ActorReferenceHandler, SortableActorHandler, StandaloneMutableGroup<T>

All Known Implementing Classes:

AbstractContainerUpdater, AbstractDataContainerFileChecker, AbstractMultiView, AbstractMutableActorDaemonEvent, AbstractMutableStandaloneGroupItem, 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, InactiveSink, InactiveSource, InactiveStandalone, InactiveTransformer, InputOutputListener, JMap, LoadBalancer, 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, UpdateContainerValue, VariableChangedEvent, WhileLoop

public interface MutableActorHandler
extends ActorHandler

Interface for actors that allow to add/remove sub-actors as well.

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	add(int index, Actor actor)	Inserts the actor at the given position.
String	add(Actor actor)	Inserts the actor at the end.
Actor	remove(int index)	Removes the actor at the given position and returns the removed object.
void	removeAll()	Removes all actors.

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.flow.core.ActorHandler

check, firstActive, flushExecution, get, getActorHandlerInfo, indexOf, lastActive, set, size

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

add

String add(Actor actor)

Inserts the actor at the end.

Parameters:

actor - the actor to insert

Returns:

null if successful, otherwise error message

add

String add(int index,
           Actor actor)

Inserts the actor at the given position.

Parameters:

index - the position

actor - the actor to insert

Returns:

null if successful, otherwise error message

remove

Actor remove(int index)

Removes the actor at the given position and returns the removed object.

Parameters:

index - the position

Returns:

the removed actor

removeAll

void removeAll()

Removes all actors.