Uses of Interface
adams.flow.core.ControlActor

Packages that use ControlActor

Package	Description
adams.flow.control
adams.flow.sink
adams.flow.source
adams.flow.standalone
adams.flow.transformer

Uses of ControlActor in adams.flow.control

Classes in adams.flow.control that implement ControlActor

Modifier and Type	Class	Description
class	AbstractConnectedControlActor	Ancestor for all actors that control (connected) sub-actors in some way.
class	AbstractContainerUpdater	Ancestor for control actors that update a specific value of a container using the defined sub-actors.
class	AbstractControlActor	Ancestor for all actors that control sub-actors in some way.
class	AbstractDataContainerFileChecker<T extends DataContainer>	Abstract ancestor for transformers that check data container files whether they are consistents before passing on the file/file arrays.
class	AbstractDirectedControlActor	Ancestor for all actors that control sub-actors in some way.
class	AbstractTee	Abstract ancestor for actors that tee-off tokens.
class	ArrayGenerate	Applies all sub-actors to the input token and generates an array from the collected output. Each of the branches is expected to produce at most one output token (ideally one per branch, otherwise there will be null elements in the output array).
class	ArrayProcess	Applies all sub-actors to each of the array elements.
class	Block	Blocks the propagation of tokens if the condition evaluates to 'true', therefore acts like the 'continue' control statement. In case of integer or double tokens that arrive at the input, these can be accessed in the expression via 'X'. The following grammar is used for evaluating the boolean expressions (depends on the selected condition): expr_list ::= '=' expr_list expr_part | expr_part ; expr_part ::= expr ; expr ::= ( expr ) # data types | number | string | boolean | date # constants | true | false | pi | e | now() | today() # negating numeric value | -expr # comparisons | expr < expr | expr <= expr | expr > expr | expr >= expr | expr = expr | expr != expr (or: expr <> expr) # boolean operations | ! expr (or: not expr) | expr & expr (or: expr and expr) | expr | expr (or: expr or expr) | if[else] ( expr , expr (if true) , expr (if false) ) | ifmissing ( variable , expr (default value if variable is missing) ) # arithmetics | expr + expr | expr - expr | expr * expr | expr / expr | expr ^ expr (power of) | expr % expr (modulo) ; # numeric functions | abs ( expr ) | sqrt ( expr ) | log ( expr ) | exp ( expr ) | sin ( expr ) | cos ( expr ) | tan ( expr ) | rint ( expr ) | floor ( expr ) | pow[er] ( expr , expr ) | ceil ( expr ) | year ( expr ) | month ( expr ) | day ( expr ) | hour ( expr ) | minute ( expr ) | second ( expr ) | weekday ( expr ) | weeknum ( expr ) # string functions | substr ( expr , start [, end] ) | left ( expr , len ) | mid ( expr , start , len ) | right ( expr , len ) | rept ( expr , count ) | concatenate ( expr1 , expr2 [, expr3-5] ) | lower[case] ( expr ) | upper[case] ( expr ) | trim ( expr ) | matches ( expr , regexp ) | trim ( expr ) | len[gth] ( str ) | find ( search , expr [, pos] ) | replace ( str , pos , len , newstr ) | substitute ( str , find , replace [, occurrences] ) ; Notes: - Variables are either all upper case letters (e.g., "ABC") or any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]"). - 'start' and 'end' for function 'substr' are indices that start at 1. - Index 'end' for function 'substr' is excluded (like Java's 'String.substring(int,int)' method) - Line comments start with '#' - Semi-colons (';') or commas (',') can be used as separator in the formulas, e.g., 'pow(2,2)' is equivalent to 'pow(2;2)' - dates have to be of format 'yyyy-MM-dd' or 'yyyy-MM-dd HH:mm:ss' - times have to be of format 'HH:mm:ss' or 'yyyy-MM-dd HH:mm:ss' - the characters in square brackets in function names are optional: e.g.
class	Branch	Branches off the flow into several sub-branches, each being supplied with a copy of the same object being passed into this meta-actor.
class	Breakpoint	Allows to pause the execution of the flow when this actor is reached and the condition evaluates to 'true'.
class	CallableActorScreenshot	Takes a screenshot of a callable actor whenever a token passes through. The screenshot can either be written to disk (and the input token is forwarded), or the screenshot is forwarded as adams.data.image.BufferedImageContainer (dropping the input token).
class	Cast	Casts the incoming data to the specified classname.
class	ClearCallableDisplay	Clears the referenced callable graphical actor whenever a token passes through.
class	CloseCallableDisplay	Closes the referenced callable graphical actor whenever a token passes through.
class	CollectionProcess	Applies all sub-actors to each of the collection elements.
class	ConditionalSequence	The sequence gets only executed if the condition holds true.
class	ConditionalSubProcess	Encapsulates a sequence of flow items.
class	ConditionalTee	Tees off the tokens if the condition evaluates to 'true'.
class	ConditionalTrigger	Executes the tee-actor whenever a token gets passed through.
class	ContainerValuePicker	Picks a named value from any container object and tees it off. With the 'switch-outputs' option it is possible to forward the named value and teeing off the container instead. If 'ignore missing' is turned off, any value that cannot be found will generate an error logging message and, in case of switched outputs, an actual error.
class	Count	Counts the number of tokens that pass through and meet the condition and tees off the current count every n-th token.
class	DesktopScreenshot	Takes a screenshot of the desktop whenever a token passes through.
class	FileProcessor
class	Flow	Container object for actors, used for executing a flow.
class	FreeMemory	Attempts to free up memory of the sub-flow that it belongs to. This actor is useful in case when sub-flows are only executed once, but still keep their data-structures and gobble up unnecessary memory.
class	GC	Calls the garbage collector.
class	HeapDump	Generates a heapdump and saves it to the specified file (with .hprof extension) whenever a token passes through.
class	IfStorageValue	An If-Then-Else source actor for storage values.
class	IfThenElse	Emulates an If-Then-Else construct.
class	Injector	Injects a string token into the token sequence. The string can be inject before or after the current token.
class	InputOutputListener	Listens to the input/output tokens of the sub-actors, sending them to callable actors.
class	JMap	Runs jmap whenever a token gets passed through.
class	LaunchTee	Launches the sub-flow in a separate thread each time a token arrives. Internally, a adams.flow.control.LocalScopeTee is used to manage the scope and forward the token.
class	LaunchTrigger	Launches the sub-flow in a separate thread each time a token arrives. Internally, a adams.flow.control.LocalScopeTrigger is used to manage the scope.
class	LoadBalancer	Runs the specified 'load actor' in as many separate threads as specified with the 'num-threads' parameter. Always uses a copy of the variables. NB: no callable transformer or sink allowed.
class	LocalScopeSubProcess	Provides a local scope for the sub-actors. It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.
class	LocalScopeTee	Executes the sub-actors whenever a token gets passed through, just like the adams.flow.control.Tee actor, but also provides its own scope for variables and internal storage. It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.
class	LocalScopeTransformer	Provides a local scope for the sub-actors. It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.
class	LocalScopeTrigger	Executes the sub-actors whenever a token gets passed through, just like the adams.flow.control.Trigger actor, but also provides its own scope for variables and internal storage. It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.
class	MissionControl	Displays a control panel for pausing/resuming/stopping the flow. Useful when executing flows from command-line with the flow runner, offering a minimal control interface.
class	MutableConnectedControlActor	Abstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).
class	MutableControlActor	Abstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).
class	Once	Tees off a token only once to its sub-actors. However, this can be reset when the monitored variable changes.
class	PlotContainerUpdater	Applies all sub-actors to process either the selected value of the plot container.
class	RaiseError	Raises a java.lang.Error if the condition evaluates to 'true', using the provided error message. See also: adams.flow.control.TryCatch Input/output: - accepts: adams.flow.core.Unknown - generates: adams.flow.core.Unknown
class	Rejector	Rejects data containers with errors attached.
class	RemoteExecutionTrigger	Transfers the actors below itself, the specified storage items and variables using the specified connection for remote execution. Uses the adams.scripting.command.flow.RemoteFlowExecution remote command behind the scenes.
class	Sequence	Encapsulates a sequence of flow items.
class	SetContainerValue	Updates a single item in the container passing through, using either the data obtained from a callable actor or a storage item. Using the 'force' option, additional meta-data can be stored in the container as well.
class	SinkReset	Resets all sub-actors in case the monitored variable changed since the last execution.
class	Sleep	Waits for a fixed amount of milliseconds.
class	SourceReset	Resets all sub-actors in case the monitored variable changed since the last execution.
class	Stop	Stops the execution of the flow when triggered.
class	StorageValueSequence	After executing a sequence of actors, the stored item is forwarded in the flow.
class	SubProcess	Encapsulates a sequence of flow items.
class	Switch	Emulates a Switch control statement.
class	Tee	Allows to tap into the flow and tee-off tokens.
class	TimedSubProcess	Encapsulates a sequence of flow items.
class	TimedTee	Allows to tap into the flow and tee-off tokens. Times how long the sub-flow execution takes and sends the time in milli-seconds (as double) in a adams.flow.container.TimingContainer container to the specified callable actor.
class	TimedTrigger	Executes the subs-actors whenever a token gets passed through.
class	TransformerReset	Resets all sub-actors in case the monitored variable changed since the last execution.
class	Trigger	Executes the tee-actor whenever a token gets passed through.
class	TriggerEvent	Triggers the specified event.
class	TriggerOnce	Triggers the sub-flow only once. However, this can be reset when the monitored variable changes.
class	TryCatch	Safe-guards the execution of the 'try' sequence of actors.
class	UpdateCallableDisplay	Updates callable display actors that implement adams.flow.core.DataPlotUpdaterHandler.
class	UpdateContainerValue	Applies all sub-actors to process the specified value of the container passing through.
class	UpdateProperties	Updates the properties of the sub-actor using the values associated with the specfiied variables.
class	WhileLoop	Emulates a while-loop.

Uses of ControlActor in adams.flow.sink

Classes in adams.flow.sink that implement ControlActor

Modifier and Type	Class	Description
class	AutogeneratedSink	Encapsulates a sequence of auto-generated actors. Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.
class	InactiveSink	Encapsulates a sequence of inactive actors. Can be removed with the adams.flow.processor.ReactivateActors processor.

Uses of ControlActor in adams.flow.source

Classes in adams.flow.source that implement ControlActor

Modifier and Type	Class	Description
class	AutogeneratedSource	Encapsulates a sequence of auto-generated actors, with the last one generating the output for this meta-source. Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.
class	InactiveSource	Encapsulates a sequence of flow items, with the last one generating the output for this meta-source. Can be removed with the adams.flow.processor.ReactivateActors processor.
class	SequenceSource	Encapsulates a sequence of flow items, with the last one generating the output for this meta-source.

Uses of ControlActor in adams.flow.standalone

Classes in adams.flow.standalone that implement ControlActor

Modifier and Type	Class	Description
class	AbstractMutableStandaloneGroupItem<T extends Actor>	Ancestor for group items that can contain other actors.
class	AutogeneratedStandalone	Container for auto-generated standalone actors. Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.
class	CallableActors	Container for actors that need to be accessed via their name.
class	ConditionalStandalones	Executes the sub-actors only when the boolean condition evaluates to 'true'.
class	Events	Container for event actors.
class	InactiveStandalone	Container for inactive standalone actors. Can be activated with the adams.flow.processor.ReactivateActors processor.
class	JavaExec	Forks off a new JVM with the same classpath by default.
class	Standalones	Container for standalone actors.

Uses of ControlActor in adams.flow.transformer

Classes in adams.flow.transformer that implement ControlActor

Modifier and Type	Class	Description
class	AutogeneratedTransformer	Encapsulates a sequence of auto-generated actors.
class	InactiveTransformer	Encapsulates a sequence of inactive actors.