Uses of Interface
adams.flow.core.Actor
-
-
Uses of Actor in adams.core.command
Fields in adams.core.command declared as Actor Modifier and Type Field Description protected ActorAbstractExternalCommand. m_FlowContextthe flow context.Methods in adams.core.command that return Actor Modifier and Type Method Description ActorAbstractExternalCommand. getFlowContext()Returns the flow context, if any.Methods in adams.core.command with parameters of type Actor Modifier and Type Method Description voidAbstractExternalCommand. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.core.command.stderr
Fields in adams.core.command.stderr declared as Actor Modifier and Type Field Description protected ActorCallableActorSink. m_CallableActorthe callable actor.Methods in adams.core.command.stderr that return Actor Modifier and Type Method Description ActorCallableActorSink. getCallableActor()Returns the currently set callable actor. -
Uses of Actor in adams.core.command.stdout
Fields in adams.core.command.stdout declared as Actor Modifier and Type Field Description protected ActorCallableActorSink. m_CallableActorthe callable actor.Methods in adams.core.command.stdout that return Actor Modifier and Type Method Description ActorCallableActorSink. getCallableActor()Returns the currently set callable actor. -
Uses of Actor in adams.core.option
Fields in adams.core.option declared as Actor Modifier and Type Field Description ActorAbstractDocumentationProducer.ActorPosition. actorthe actor.Methods in adams.core.option that return Actor Modifier and Type Method Description ActorCompactFlowProducer. strip(Actor actor)Returns a stripped down version of the actor, i.e., for ActorHandlers, a copy of the actor without any sub-actors gets returned.Methods in adams.core.option with parameters of type Actor Modifier and Type Method Description protected StringFlowStructureDotProducer. addNode(Actor actor)Adds the actor as node.protected StringFlowStructureDotProducer. addNode(Actor actor, String shape, String style)Adds the actor as node.protected StringFlowStructureGraphMLProducer. addNode(Actor actor)Adds the actor as node.protected voidAbstractDocumentationProducer. addPosition(Actor actor, int nesting, int index)Adds the position to the internal list/map.protected voidCompactFlowProducer. process(Actor actor)Processes the actor.ActorCompactFlowProducer. strip(Actor actor)Returns a stripped down version of the actor, i.e., for ActorHandlers, a copy of the actor without any sub-actors gets returned.Constructors in adams.core.option with parameters of type Actor Constructor Description ActorPosition(Actor actor, int nesting, int index)Initializes the container. -
Uses of Actor in adams.core.tags
Methods in adams.core.tags with parameters of type Actor Modifier and Type Method Description static List<BaseKeyValuePair>TagProcessorHelper. getAllTags(Actor actor, boolean traverse)Retrieves all tags from the actor, going up in the actor tree, with lower ones overriding ones defined higher up. -
Uses of Actor in adams.data.image
Fields in adams.data.image declared as Actor Modifier and Type Field Description protected ActorAbstractImageTransformer. m_FlowContextthe flow context.Methods in adams.data.image that return Actor Modifier and Type Method Description ActorAbstractImageTransformer. getFlowContext()Returns the flow context, if any.Methods in adams.data.image with parameters of type Actor Modifier and Type Method Description voidAbstractImageTransformer. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.data.io.input
Methods in adams.data.io.input that return Actor Modifier and Type Method Description protected ActorAbstractFlowReader. doReadActor(File file)Performs the actual reading.protected ActorAbstractFlowReader. doReadActor(InputStream in)Performs the actual reading.protected ActorAbstractFlowReader. doReadActor(Reader r)Performs the actual reading.protected ActorDefaultFlowReader. doReadActor(File file)Performs the actual reading.protected ActorDefaultFlowReader. doReadActor(InputStream in)Performs the actual reading.protected ActorDefaultFlowReader. doReadActor(Reader r)Performs the actual reading.protected ActorJsonFlowReader. doReadActor(File file)Performs the actual reading.ActorAbstractFlowReader. readActor(File file)Reads the flow from the specified file.ActorAbstractFlowReader. readActor(InputStream stream)Reads the flow from the stream.ActorAbstractFlowReader. readActor(Reader r)Reads the flow from the given reader.ActorAbstractFlowReader. readActor(String filename)Reads the flow from the given file.protected ActorDefaultFlowReader. readActor(List<String> lines)Performs the actual reading.ActorFlowReader. readActor(File file)Reads the flow from the specified file.ActorFlowReader. readActor(InputStream stream)Reads the flow from the stream.ActorFlowReader. readActor(Reader r)Reads the flow from the given reader.ActorFlowReader. readActor(String filename)Reads the flow from the given file.protected ActorDefaultFlowReader. readNonCompact(List<String> lines)Reads the actor from the non-compact format. -
Uses of Actor in adams.data.io.output
Methods in adams.data.io.output with parameters of type Actor Modifier and Type Method Description protected booleanAbstractFlowWriter. doWrite(Actor content, File file)Performs the actual writing.protected booleanAbstractFlowWriter. doWrite(Actor content, OutputStream out)Performs the actual writing.protected booleanAbstractFlowWriter. doWrite(Actor content, Writer writer)Performs the actual writing.protected booleanDefaultFlowWriter. doWrite(Actor content, File file)Writes the given content to the specified file.protected booleanDefaultFlowWriter. doWrite(Actor content, OutputStream out)Performs the actual writing.protected booleanDefaultFlowWriter. doWrite(Actor content, Writer writer)Performs the actual writing.protected booleanJsonFlowWriter. doWrite(Actor content, File file)Writes the given content to the specified file.protected StringDefaultFlowWriter. toCompactString(Actor actor)Turns the actor into a compact string.booleanAbstractFlowWriter. write(Actor content, File file)Writes the given content to the specified file.booleanAbstractFlowWriter. write(Actor content, OutputStream stream)Writes the content to the given output stream.booleanAbstractFlowWriter. write(Actor content, Writer writer)Writes the content to the given writer.booleanAbstractFlowWriter. write(Actor content, String filename)Writes the content to the given file.booleanFlowWriter. write(Actor content, File file)Writes the given content to the specified file.booleanFlowWriter. write(Actor content, OutputStream stream)Writes the content to the given output stream.booleanFlowWriter. write(Actor content, Writer writer)Writes the content to the given writer.booleanFlowWriter. write(Actor content, String filename)Writes the content to the given file. -
Uses of Actor in adams.data.objectfilter
Fields in adams.data.objectfilter declared as Actor Modifier and Type Field Description protected ActorTransformMetaData. m_CallableActorthe callable actor.protected ActorAbstractObjectFilter. m_FlowContextthe flow context.Methods in adams.data.objectfilter that return Actor Modifier and Type Method Description protected ActorTransformMetaData. findCallableActor()Tries to find the callable actor referenced by its callable name.ActorAbstractObjectFilter. getFlowContext()Returns the flow context, if any.Methods in adams.data.objectfilter with parameters of type Actor Modifier and Type Method Description voidAbstractObjectFilter. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.data.spreadsheet
Methods in adams.data.spreadsheet with parameters of type Actor Modifier and Type Method Description static HashMap<String,Object>LookUpHelper. getTable(Actor context, StorageName name)Returns the specified lookup table. -
Uses of Actor in adams.event
Methods in adams.event that return Actor Modifier and Type Method Description ActorFlowPauseStateEvent. getActor()Returns the actor that triggered the event.Constructors in adams.event with parameters of type Actor Constructor Description FlowPauseStateEvent(Actor source, FlowPauseStateEvent.Type type)Initializes the event. -
Uses of Actor in adams.flow
Fields in adams.flow declared as Actor Modifier and Type Field Description protected ActorFlowRunner. m_Actorthe actor to execute.protected ActorFlowRunner. m_LastActorthe last actor that was executed.Methods in adams.flow that return Actor Modifier and Type Method Description ActorFlowRunner. getLastActor()Returns the instance of the last actor that was executed. -
Uses of Actor in adams.flow.condition.bool
Methods in adams.flow.condition.bool with parameters of type Actor Modifier and Type Method Description protected abstract booleanAbstractAttributeCapabilities. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected abstract booleanAbstractBooleanCondition. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanAbstractScriptedCondition. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanAdamsInstanceCapabilities. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanAnd. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanBinaryFile. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanBooleanReportValue. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanBytesComplete. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanCounting. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanDirectoriesMatch. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanDirectoryExists. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanExpression. doEvaluate(Actor owner, Token token)Evaluates the expression.protected booleanFalse. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanFileComplete. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanFileExists. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanFileInUse. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanFilesMatch. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasClass. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasColumn. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasElements. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasExifTag. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHashSet. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasInterface. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasLength. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasMapValue. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasProperty. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasQueue. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasRows. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasSize. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasStorageValue. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasVariable. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanHasVariableValue. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanInList. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsAndroid. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsArm64. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsArray. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsBoolean. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsByte. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsBzip2Compressed. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsDouble. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsFloat. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsGzipCompressed. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsInteger. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsLinux. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsLong. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsMac. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsMat5Array. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsMat5Matrix. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsMat5Struct. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsNull. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsNumeric. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsRarCompressed. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsShort. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsSubClass. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsWindows. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsXzCompressed. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsZipCompressed. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanIsZstdCompressed. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanNot. doEvaluate(Actor owner, Token token)Evaluates the condition.protected booleanNotesErrors. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanOr. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanPromptUser. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanRegExp. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanReportValueExists. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanStorageFlagSet. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanTableExists. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanTrue. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanVariableFlagSet. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanWekaCapabilities. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected booleanWekaClassification. doEvaluate(Actor owner, Token token)Performs the actual evaluation.protected abstract booleanAbstractScriptedCondition. doScriptEvaluate(Actor owner, Token token)Runs the script evaluation.protected booleanGroovy. doScriptEvaluate(Actor owner, Token token)Runs the script evaluation.protected booleanScripted. doScriptEvaluate(Actor owner, Token token)Runs the script evaluation.booleanAbstractBooleanCondition. evaluate(Actor owner, Token token)Uses the token to determine the evaluation.booleanBooleanCondition. evaluate(Actor owner, Token token)Evaluates whether to executed the "then" or "else" branch.intIndexedBooleanCondition. getCaseIndex(Actor owner, Token token)Returns the index of the case that should get executed.intWekaClassification. getCaseIndex(Actor owner, Token token)Returns the index of the case that should get executed.protected AbstractDatabaseConnectionAbstractBooleanDatabaseCondition. getConnection(Actor actor)Returns the database connection from the flow.intIndexedBooleanCondition. getDefaultCaseIndex(Actor owner, Token token)Returns the index of the default case.intWekaClassification. getDefaultCaseIndex(Actor owner, Token token)Returns the index of the default case.protected StringAbstractBooleanCondition. preEvaluate(Actor owner, Token token)Uses the token to determine the evaluation.protected StringAbstractBooleanDatabaseCondition. preEvaluate(Actor owner, Token token)Uses the token to determine the evaluation.StringAbstractAttributeCapabilities. setUp(Actor owner)Configures the condition.StringAbstractBooleanCondition. setUp(Actor owner)Configures the condition.StringAbstractExpression. setUp(Actor owner)Configures the condition.StringAbstractMultiCondition. setUp(Actor owner)Configures the condition.StringAbstractScriptedCondition. setUp(Actor owner)Configures the condition.StringBinaryFile. setUp(Actor owner)Configures the condition.StringBooleanCondition. setUp(Actor owner)Configures the condition.StringBooleanReportValue. setUp(Actor owner)Configures the condition.StringDirectoriesMatch. setUp(Actor owner)Configures the condition.StringDirectoryExists. setUp(Actor owner)Configures the condition.StringFileComplete. setUp(Actor owner)Configures the condition.StringFileExists. setUp(Actor owner)Configures the condition.StringFileInUse. setUp(Actor owner)Configures the condition.StringFilesMatch. setUp(Actor owner)Configures the condition.StringHasClass. setUp(Actor owner)Configures the condition.StringHasInterface. setUp(Actor owner)Configures the condition.StringIsSubClass. setUp(Actor owner)Configures the condition.StringNot. setUp(Actor owner)Configures the condition.StringReportValueExists. setUp(Actor owner)Configures the condition.StringWekaClassification. setUp(Actor owner)Initializes the item for flow execution.protected StringWekaClassification. setUpModel(Actor owner)Loads the model from the model file. -
Uses of Actor in adams.flow.container
Constructors in adams.flow.container with parameters of type Actor Constructor Description EncapsulatedActorsContainer(Actor actor, Variables variables, Storage storage)Initializes the container with the actors, variables and storage.EncapsulatedActorsContainer(Actor actor, Variables variables, Storage storage, Object input, StorageName inputName)Initializes the container with the actors, variables and storage.EncapsulatedActorsContainer(Actor actor, Variables variables, Storage storage, Object input, StorageName inputName, Object output, StorageName outputName)Initializes the container with the actors, variables and storage.ProcessActorContainer(Actor actor)Initializes the container with the actor.ProcessActorContainer(Actor actor, String[] list)Initializes the container with the actor and list. -
Uses of Actor in adams.flow.control
Subinterfaces of Actor in adams.flow.control Modifier and Type Interface Description interfaceAtomicExecutionInterface for actors that can be configured to finish execution first before attempting to be stopped.interfaceFlowStructureModifierInterface for actors that modify the flow structure somehow.interfaceLocalScopeHandlerInterface for actor handlers that provide a local scope for their sub-actors.interfaceScopeHandlerFor actors that define a scope like theFloworLocalScopeTriggeractor.interfaceStorageHandlerInterface for actors that allow the storing of temporary data.Classes in adams.flow.control that implement Actor Modifier and Type Class Description classAbstractConnectedControlActorAncestor for all actors that control (connected) sub-actors in some way.classAbstractContainerUpdaterAncestor for control actors that update a specific value of a container using the defined sub-actors.classAbstractControlActorAncestor for all actors that control sub-actors in some way.classAbstractDataContainerFileChecker<T extends DataContainer>Abstract ancestor for transformers that check data container files whether they are consistents before passing on the file/file arrays.classAbstractDirectedControlActorAncestor for all actors that control sub-actors in some way.classAbstractTeeAbstract ancestor for actors that tee-off tokens.classArrayGenerateApplies 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).classArrayProcessApplies all sub-actors to each of the array elements.classBlockBlocks 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.classBranchBranches off the flow into several sub-branches, each being supplied with a copy of the same object being passed into this meta-actor.classBreakpointAllows to pause the execution of the flow when this actor is reached and the condition evaluates to 'true'.classCallableActorScreenshotTakes 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).classCastCasts the incoming data to the specified classname.classClearCallableDisplayClears the referenced callable graphical actor whenever a token passes through.classCloseCallableDisplayCloses the referenced callable graphical actor whenever a token passes through.classCollectionProcessApplies all sub-actors to each of the collection elements.classConditionalSequenceThe sequence gets only executed if the condition holds true.classConditionalSubProcessEncapsulates a sequence of flow items.classConditionalTeeTees off the tokens if the condition evaluates to 'true'.classConditionalTriggerExecutes the tee-actor whenever a token gets passed through.classContainerValuePickerPicks 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.classCountCounts the number of tokens that pass through and meet the condition and tees off the current count every n-th token.classDesktopScreenshotTakes a screenshot of the desktop whenever a token passes through.classFileProcessorclassFlowContainer object for actors, used for executing a flow.classForceFlushForces all actors that implement adams.flow.core.FlushSupporter
See also:
adams.flow.sink.DumpFile
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classFreeMemoryAttempts 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.classGCCalls the garbage collector.classHeapDumpGenerates a heapdump and saves it to the specified file (with .hprof extension) whenever a token passes through.classIfStorageValueAn If-Then-Else source actor for storage values.classIfThenElseEmulates an If-Then-Else construct.classInjectorInjects a string token into the token sequence.
The string can be inject before or after the current token.classInputOutputListenerListens to the input/output tokens of the sub-actors, sending them to callable actors.classInspectAllows the user to inspect tokens with the specified viewer.
Inspection can be done interactively, allowing the user to drop tokens, or non-interactively, with the viewer updating whenever a token passes through.
Of course, this actor should only be used during development for debugging purposes as can slow down the execution significantly depending on how expensive the view generation is.classJDepsRuns jdeps on the classname arriving at the input.
The application's classpath is automatically added to the command-line if no classpath directories or jars are provided.
Classpath directories and jars get combined, but directories take precedence over jars.classJMapRuns jmap whenever a token gets passed through.classLoadBalancerRuns 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.classLocalScopeTransformerProvides 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.classLocalScopeTriggerExecutes 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.classMissionControlDisplays 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.classMutableConnectedControlActorAbstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).classMutableControlActorAbstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).classOnceTees off a token only once to its sub-actors.
However, this can be reset when the monitored variable changes.classPlotContainerUpdaterApplies all sub-actors to process either the selected value of the plot container.classPlotProcessorApplies the specified processing algorithm to the stream of plot containers passing through.classRaiseErrorRaises 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
classRejectorRejects data containers with errors attached.classRemoteExecutionTriggerTransfers 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.classRemoveOutliersAllows the user to interactively remove outliers.classSequenceEncapsulates a sequence of flow items.classSetContainerValueUpdates 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.classSinkResetResets all sub-actors in case the monitored variable changed since the last execution.classSleepWaits for a fixed amount of milli-seconds.classSourceResetResets all sub-actors in case the monitored variable changed since the last execution.classStopStops the execution of the flow when triggered.classStorageValueSequenceAfter executing a sequence of actors, the stored item is forwarded in the flow.classSubProcessEncapsulates a sequence of flow items.classSwitchEmulates a Switch control statement.classTeeAllows to tap into the flow and tee-off tokens.classTimedSubProcessEncapsulates a sequence of flow items.classTimedTeeAllows 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.classTimedTriggerExecutes the subs-actors whenever a token gets passed through.classTransformerResetResets all sub-actors in case the monitored variable changed since the last execution.classTriggerExecutes the tee-actor whenever a token gets passed through.classTriggerEventTriggers the specified event.classTriggerOnceTriggers the sub-flow only once.
However, this can be reset when the monitored variable changes.classTryCatchSafe-guards the execution of the 'try' sequence of actors.classUpdateCallableDisplayUpdates callable display actors that implement adams.flow.core.DataPlotUpdaterHandler.classUpdateContainerValueApplies all sub-actors to process the specified value of the container passing through.classUpdatePropertiesUpdates the properties of the sub-actor using the values associated with the specfiied variables.classWhileLoopEmulates a while-loop.Fields in adams.flow.control declared as Actor Modifier and Type Field Description protected ActorFlow. m_AfterExecuteActorthe actor that was executed after the flow finished.protected ActorCallableActorScreenshot. m_CallableActorthe callable actor.protected ActorTimedSubProcess. m_CallableActorthe callable actor.protected ActorTimedTee. m_CallableActorthe callable actor.protected ActorTimedTrigger. m_CallableActorthe callable actor.protected ActorUpdateCallableDisplay. m_CallableActorthe callable actor.protected ActorInputOutputListener. m_CallableInputthe callable actor (input).protected ActorInputOutputListener. m_CallableOutputthe callable actor (output).protected ActorTryCatch. m_Catchthe catch branch.protected ActorIfStorageValue. m_ElseActorthe actor to execute in the "else" branch.protected ActorIfThenElse. m_ElseActorthe actor to execute in the "else" branch.protected ActorTriggerEvent. m_EventActorthe event actor to execute.protected ActorFlow. m_ExecuteOnErrorActorthe external actor to execute in case of an abnormal stop.protected ActorFlow. m_ExecuteOnFinishActorthe external actor to execute in case the flow finishes normal.protected ActorFileProcessor. m_Inputthe actor to use for input.protected ActorStorageQueueHandler. m_Loggingthe (optional) logging actor.protected ActorStorageQueueHandler. m_Monitoringthe (optional) monitoring actor.protected ActorUpdateProperties. m_SubActorthe actor to update the properties foe.protected ActorIfStorageValue. m_ThenActorthe actor to execute in the "then" branch.protected ActorIfThenElse. m_ThenActorthe actor to execute in the "then" branch.protected ActorTryCatch. m_Trythe try branch.Fields in adams.flow.control with type parameters of type Actor Modifier and Type Field Description protected List<Actor>MutableConnectedControlActor. m_Actorsthe actors.protected List<Actor>MutableControlActor. m_Actorsthe actors.protected List<Actor>Branch. m_Branchesthe branches.protected List<Actor>Switch. m_Casesthe "cases" to execute if the corresponding expression matches.protected List<Actor>LoadBalancer. m_ToCleanUpthe actors to clean up in the end.Methods in adams.flow.control that return Actor Modifier and Type Method Description protected ActorSequentialDirector. doExecuteStandalones()Executes all the standalone actors.protected ActorCallableActorScreenshot. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorCloseCallableDisplay. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorTimedSubProcess. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorTimedTee. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorTimedTrigger. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorUpdateCallableDisplay. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorTriggerEvent. findEventActor()Tries to find the event referenced by its global name.ActorAbstractControlActor. firstActive()Returns the first non-skipped actor.ActorFileProcessor. firstActive()Returns the first non-skipped actor.ActorAbstractControlActor. firstInputConsumer()Returns the first non-skipped InputConsumer.abstract ActorAbstractControlActor. get(int index)Returns the actor at the given position.ActorAbstractTee. get(int index)Returns the actor at the given position.ActorBranch. get(int index)Returns the actor at the given position.ActorFileProcessor. get(int index)Returns the actor at the given position.ActorIfStorageValue. get(int index)Returns the actor at the given position.ActorIfThenElse. get(int index)Returns the actor at the given position.ActorLoadBalancer. get(int index)Returns the actor at the given position.ActorLocalScopeTransformer. get(int index)Returns the actor at the given position.ActorMutableConnectedControlActor. get(int index)Returns the actor at the given position.ActorMutableControlActor. get(int index)Returns the actor at the given position.ActorSwitch. get(int index)Returns the actor at the given position.ActorTryCatch. get(int index)Returns the actor at the given position.ActorUpdateProperties. get(int index)Returns the actor at the given position.ActorWhileLoop. get(int index)Returns the actor at the given position.Actor[]AbstractTee. getActors()Returns the actors to tee-off to.Actor[]FileProcessor. getActors()Returns the actors to tee-off to.Actor[]LocalScopeTransformer. getActors()Returns the actors of the loop.Actor[]MutableConnectedControlActor. getActors()Returns the flow items of this sequence.Actor[]MutableControlActor. getActors()Returns the flow items of this sequence.Actor[]WhileLoop. getActors()Returns the actors of the loop.Actor[]Branch. getBranches()Returns the branches.ActorTimedSubProcess. getCallableActor()Returns the currently set callable actor.ActorTimedTee. getCallableActor()Returns the currently set callable actor.ActorTimedTrigger. getCallableActor()Returns the currently set callable actor.Actor[]Switch. getCases()Returns the cases.ActorTryCatch. getCatch()Returns the try branch.protected ActorTryCatch. getDefaultCatch()Returns the default catch branch.protected ActorIfStorageValue. getDefaultElse()Returns the default 'Else' actor.protected ActorIfThenElse. getDefaultElse()Returns the default 'Else' actor.protected ActorIfStorageValue. getDefaultThen()Returns the default 'Then' actor.protected ActorIfThenElse. getDefaultThen()Returns the default 'Then' actor.protected ActorTryCatch. getDefaultTry()Returns the default try branch.ActorIfStorageValue. getElseActor()Returns the actor of the 'else' branch.ActorIfThenElse. getElseActor()Returns the actor of the 'else' branch.Actor[]LoadBalancer. getLoadActors()Returns the load actors.ActorStorageQueueHandler. getLogging()Returns the logging actor.ActorStorageQueueHandler. getMonitoring()Returns the monitoring actor.ActorFlow. getRoot()Returns the root of this actor, e.g., the group at the highest level.ActorUpdateProperties. getSubActor()Returns the sub-actor.ActorIfStorageValue. getThenActor()Returns the actor of the 'then' branch.ActorIfThenElse. getThenActor()Returns the actor of the 'then' branch.ActorTryCatch. getTry()Returns the try branch.ActorAbstractControlActor. lastActive()Returns the last non-skipped actor.ActorFileProcessor. lastActive()Returns the last non-skipped actor.ActorAbstractTee. remove(int index)Removes the actor at the given position and returns the removed object.ActorBranch. remove(int index)Removes the actor at the given position and returns the removed object.ActorFileProcessor. remove(int index)Removes the actor at the given position and returns the removed object.ActorLoadBalancer. remove(int index)Removes the actor at the given position and returns the removed object.ActorLocalScopeTransformer. remove(int index)Removes the actor at the given position and returns the removed object.ActorMutableConnectedControlActor. remove(int index)Removes the actor at the given position and returns the removed object.ActorMutableControlActor. remove(int index)Removes the actor at the given position and returns the removed object.ActorSwitch. remove(int index)Removes the actor at the given position and returns the removed object.ActorWhileLoop. remove(int index)Removes the actor at the given position and returns the removed object.Methods in adams.flow.control with parameters of type Actor Modifier and Type Method Description StringAbstractTee. add(int index, Actor actor)Inserts the actor at the given position.StringAbstractTee. add(Actor actor)Inserts the actor at the end.StringBranch. add(int index, Actor actor)Inserts the actor at the given position.StringBranch. add(Actor actor)Inserts the actor at the end.StringFileProcessor. add(int index, Actor actor)Inserts the actor at the given position.StringFileProcessor. add(Actor actor)Inserts the actor at the end.StringLoadBalancer. add(int index, Actor actor)Inserts the actor at the given position.StringLoadBalancer. add(Actor actor)Inserts the actor at the end.StringLocalScopeTransformer. add(int index, Actor actor)Inserts the actor at the given position.StringLocalScopeTransformer. add(Actor actor)Inserts the actor at the end.StringMutableConnectedControlActor. add(int index, Actor actor)Inserts the actor at the given position.StringMutableConnectedControlActor. add(Actor actor)Inserts the actor at the end.StringMutableControlActor. add(int index, Actor actor)Inserts the actor at the given position.StringMutableControlActor. add(Actor actor)Inserts the actor at the end.StringSwitch. add(int index, Actor actor)Inserts the actor at the given position.StringSwitch. add(Actor actor)Inserts the actor at the end.StringWhileLoop. add(int index, Actor actor)Inserts the actor at the given position.StringWhileLoop. add(Actor actor)Inserts the actor at the end.StringFlow. addCallableName(ActorHandler handler, Actor actor)Adds the callable name to the list of used ones.StringLocalScopeTransformer. addCallableName(ActorHandler handler, Actor actor)Adds the callable name to the list of used ones.StringLocalScopeTrigger. addCallableName(ActorHandler handler, Actor actor)Adds the callable name to the list of used ones.StringScopeHandler. addCallableName(ActorHandler handler, Actor actor)Adds the callable name to the list of used ones.protected StringSequentialDirector. checkActorHasStopped(Actor actor)Checks whether the actor has already stopped.protected StringArrayGenerate. checkBranch(Actor branch)Checks the sub-branch.protected StringBranch. checkBranch(Actor branch)Checks the sub-branch.protected StringFileProcessor. checkSubActor(int index, Actor actor)Checks the tee actor before it is set.protected StringUpdateProperties. checkSubActor(Actor actor)Checks the sub-actor before it is set via the setSubActor method.protected StringFileProcessor. checkSubActors(Actor[] actors)Checks the tee actors before they are set via the setTeeActors method.protected abstract StringAbstractTee. checkTeeActor(int index, Actor actor)Checks the tee actor before it is set.protected StringRemoteExecutionTrigger. checkTeeActor(int index, Actor actor)Checks the tee actor before it is set.protected StringTee. checkTeeActor(int index, Actor actor)Checks the tee actor before it is set.protected StringTrigger. checkTeeActor(int index, Actor actor)Checks the tee actor before it is set.protected abstract StringAbstractTee. checkTeeActors(Actor[] actors)Checks the tee actors before they are set via the setTeeActors method.protected StringRemoteExecutionTrigger. checkTeeActors(Actor[] actors)Checks the tee actors before they are set via the setTeeActors method.protected StringTee. checkTeeActors(Actor[] actors)Checks the tee actor before it is set via the setTeeActor method.protected StringTrigger. checkTeeActors(Actor[] actors)Checks the tee actors before they are set via the setTeeActors method.protected StringSequentialDirector. doExecute(Actor actor)Calls the execute() method of the actor.protected StringSequentialDirector. doExecuteActors(Actor startActor)Peforms the execution of the actors.protected StringSubProcess.SubProcessDirector. doExecuteActors(Actor startActor)Peforms the execution of the actors.protected booleanSequentialDirector. doHasOutput(Actor actor)Checks whether the actor has pending output.protected StringSequentialDirector. doInput(Actor actor, Token input)Presents the specified token to the actor.protected TokenSequentialDirector. doOutput(Actor actor)Retrieves the token from the actor.protected StringSequentialDirector. handleError(Actor actor, String action, String msg)Handles the given error message, calling the actor's error handler, if defined.StringTryCatch. handleError(Actor source, String type, String msg)Handles the given error message with the flow that this actor belongs to, if the flow has error logging turned on.protected StringSequentialDirector. handleException(Actor actor, String msg, Throwable t)Handles the error message, by outputting the exception on stderr and generating/returning a combined error string.booleanFlow. isCallableNameUsed(ActorHandler handler, Actor actor)Checks whether a callable name is already in use.booleanLocalScopeTransformer. isCallableNameUsed(ActorHandler handler, Actor actor)Checks whether a callable name is already in use.booleanLocalScopeTrigger. isCallableNameUsed(ActorHandler handler, Actor actor)Checks whether a callable name is already in use.booleanScopeHandler. isCallableNameUsed(ActorHandler handler, Actor actor)Checks whether a callable name is already in use.protected voidStorageQueueHandler. log(LogEntry log, Actor actor)Logs the log entry with the specified actor.abstract StringAbstractControlActor. set(int index, Actor actor)Sets the actor at the given position.StringAbstractTee. set(int index, Actor actor)Sets the actor at the given position.StringBranch. set(int index, Actor actor)Sets the actor at the given position.StringFileProcessor. set(int index, Actor actor)Sets the actor at the given position.StringIfStorageValue. set(int index, Actor actor)Sets the actor at the given position.StringIfThenElse. set(int index, Actor actor)Sets the actor at the given position.StringLoadBalancer. set(int index, Actor actor)Sets the actor at the given position.StringLocalScopeTransformer. set(int index, Actor actor)Sets the actor at the given position.StringMutableConnectedControlActor. set(int index, Actor actor)Sets the actor at the given position.StringMutableControlActor. set(int index, Actor actor)Sets the actor at the given position.StringSwitch. set(int index, Actor actor)Sets the actor at the given position.StringTryCatch. set(int index, Actor actor)Sets the actor at the given position.StringUpdateProperties. set(int index, Actor actor)Sets the actor at the given position.StringWhileLoop. set(int index, Actor actor)Sets the actor at the given position.voidAbstractTee. setActors(Actor[] value)Sets the actor to tee-off to.voidFileProcessor. setActors(Actor[] value)Sets the actor to tee-off to.voidLocalScopeTransformer. setActors(Actor[] value)Sets the actors of the loop.voidMutableConnectedControlActor. setActors(Actor[] value)Sets the flow items for this sequence.voidMutableControlActor. setActors(Actor[] value)Sets the flow items for this sequence.voidWhileLoop. setActors(Actor[] value)Sets the actors of the loop.voidBranch. setBranches(Actor[] value)Sets the branches.voidSwitch. setCases(Actor[] value)Sets the cases.voidTryCatch. setCatch(Actor value)Sets the catch branch.voidIfStorageValue. setElseActor(Actor value)Sets the actor of the 'else' branch.voidIfThenElse. setElseActor(Actor value)Sets the actor of the 'else' branch.voidLoadBalancer. setLoadActors(Actor[] value)Sets the load actors.voidAbstractControlActor. setParent(Actor value)Sets the parent of this actor, e.g., the group it belongs to.voidUpdateProperties. setSubActor(Actor value)Sets the sub actor.voidIfStorageValue. setThenActor(Actor value)Sets the actor of the 'then' branch.voidIfThenElse. setThenActor(Actor value)Sets the actor of the 'then' branch.voidTryCatch. setTry(Actor value)Sets the try branch.Constructors in adams.flow.control with parameters of type Actor Constructor Description StorageQueueHandler(String name, int limit, Actor logging, Actor monitoring)Initializes the queue with the specified limit and logging. -
Uses of Actor in adams.flow.control.errorpostprocessor
Fields in adams.flow.control.errorpostprocessor declared as Actor Modifier and Type Field Description protected ActorOutOfMemory. m_LogActorthe callable log actor.Methods in adams.flow.control.errorpostprocessor with parameters of type Actor Modifier and Type Method Description protected voidAbstractErrorPostProcessor. check(ErrorHandler handler, Actor source, String type, String msg)Hook method for checks.protected voidOutOfMemory. check(ErrorHandler handler, Actor source, String type, String msg)Hook method for checks.protected abstract voidAbstractErrorPostProcessor. doPostProcessError(ErrorHandler handler, Actor source, String type, String msg)Performs the actual post-processing of the error.protected voidNull. doPostProcessError(ErrorHandler handler, Actor source, String type, String msg)Does nothing.protected voidOutOfMemory. doPostProcessError(ErrorHandler handler, Actor source, String type, String msg)Performs the actual post-processing of the error.voidAbstractErrorPostProcessor. postProcessError(ErrorHandler handler, Actor source, String type, String msg)Post-processes the error.voidErrorPostProcessor. postProcessError(ErrorHandler handler, Actor source, String type, String msg)Post-processes the error. -
Uses of Actor in adams.flow.core
Subinterfaces of Actor in adams.flow.core Modifier and Type Interface Description interfaceActorHandlerFor actors that handle "sub-actors".interfaceActorReferenceHandlerInterface for actors that manage callable actors.interfaceActorWithConditionalEquivalentActors that have an conditional equivalent, i.e., one that implementsBooleanConditionSupporter.interfaceActorWithTimedEquivalentActors that have a timed equivalent, i.e., one that implementsTimedActor.interfaceArrayProviderFor actors that can output the items either as an array or one-by-one.interfaceAutogeneratedActorIndicator interface for actors that have been automatically generated.interfaceAutomatableInteractiveActorInterface for actors that interact with the user, but can also be automated, e.g., for testing purposes.interfaceAutoStartSupporterInterface for actors that support "auto-start" functionality.interfaceConnectionHandlerFor actors that handle "sub-actors" that are connected.interfaceControlActorIndicator interface for control actors.interfaceDaemonEventIndicator interface for events that run in the background and will get executed when the Events actor gets executed.interfaceDataInfoActorIndicator interface for actors that produce information on data structures.interfaceDisplayTypeSupporterInterface for actors that allow how their graphical output is being displayed.interfaceDryRunSupporterInterface for actors that support dry runs.interfaceDynamicInitializerInterface for actors that can be initialized at runtime and files may not be present at startup time.interfaceDynamicModelLoaderSupporterInterface for classes that support model loading.interfaceErrorScopeRestrictorInterface for actors that restrict the error scope.interfaceEventIndicator interface for actors that can be used with the Events standalone.interfaceFixedNameActorHandlerInterface for actor handlers that use fixed names for their sub-actors, e.g., IfThenElse.interfaceFlushableInterface for actors that can be flushed, i.e., the execution stopped without actually stopping the actor.interfaceFlushSupporterInterface for actors that can be flushed.interfaceInactiveActorIndicator interface for actors that have been "put to sleep".interfaceInputConsumerInterface for flow actors that can process input tokens.interfaceInteractiveActorInterface for actors that interact with the user.interfaceInteractiveActorWithCustomParentComponentInterface for interactive actors that allow the selection of a custom parent component using a callable actor; instead of just using the outer dialog/frame.interfaceKeyManagerFactoryProviderInterface for actors that provide an instance to aKeyManagerFactory.interfaceLazySetupSupporterInterface for actors that optionally perform asetUp()call first time they get executed.interfaceMutableActorHandlerInterface for actors that allow to add/remove sub-actors as well.interfaceOptionalOneTimeInitializerInterface for actors that can be fixed to be only initialized once.interfaceOptionalPasswordPromptInterface for actors that prompt the user to enter a password in case no password currently provided.interfaceOptionalStopRestrictorInterface for stop restrictors that can turn on/off stop restrictions.interfaceOutputProducerInterface for flow actors that generate output.interfacePauseStateHandlerInterface for actors that manage the pause state in some sense.interfacePropertiesUpdaterInterface for actors that update one or more properties of a Java object using variables.interfaceRemoteExecutionHandlerInterface for actors that manage remote execution.interfaceRestorableActorInterface for actors that can save their state to disk and restore it again next time they are run.interfaceSortableActorHandlerInterface for actor handlers that can sort their child actors.interfaceSSLContextProviderInterface for actors that provide access to an instance ofSSLContext.interfaceStopModeSupporterInterface for actors that support a specific stop mode.interfaceStopRestrictorInterface for actors that can limit the scope of theStopcontrol actor or other actors that can stop the execution.interfaceSubFlowWrapUpInterface for actors that can wrap-up (i.e., save memory) their sub-actors and, if need be, re-initialize again.interfaceTimedActorInterface for actors that time their execution and send the timing data to a callable actor.interfaceTokenEventHandlerInterface for actors that supportTokenEvents and handleTokenListeners.interfaceTriggerableEventIndicator interface for events that can be triggered with the TriggerEvent actor.interfaceTrustManagerFactoryProviderInterface for actors that provide an instance to aTrustManagerFactory.interfaceWeakExternalActorIndicator interface for weak external actor handlers, which are only used at design time and deactivated at runtime.Classes in adams.flow.core that implement Actor Modifier and Type Class Description classAbstractActorAbstract base class for actors.classAbstractBaseExternalActorAncestor of actors that load another actor from disk and execute it.classAbstractCallableActorAbstract ancestor for all actors that access callable actors.classAbstractCallableActorPropertyUpdaterAbstract ancestor for actors that manipulate properties of callable actors, e.g., WEKA classes.classAbstractCopyCallableActorAncestor for actors that use a copy of a callable actor.classAbstractDisplayAncestor for actors that display stuff.classAbstractExternalActorAncestor of actors that load another actor from disk and execute it.classAbstractGroovyActorAbstract ancestor for actors that execute Groovy scripts.classAbstractIncludeExternalActorAncestor for actors that get replaced with the externally stored actor.classAbstractPropertyUpdaterAbstract ancestor for actors that manipulate properties of objects.classAbstractScriptedActorAbstract ancestor for actors that execute external scripts.classAbstractScriptingHandlerActorAbstract ancestor for actors that execute external scripts using a scripting handler.classAbstractTemplateAbstract ancestor for all actors that use a template to generate the actual actor/sub-flow to be executed.Fields in adams.flow.core declared as Actor Modifier and Type Field Description protected ActorAbstractTemplate. m_Actorthe generated actor.protected ActorActorStatistic. m_Actorthe actor to create the statistics for.protected ActorAbstractGroovyActor. m_ActorObjectthe loaded script object.protected ActorAbstractScriptingHandlerActor. m_ActorObjectthe loaded script object.protected ActorAbstractCallableActor. m_CallableActorthe callable actor.protected ActorAbstractCallableActorPropertyUpdater. m_CallableActorthe callable actor to update the property for.protected ActorAbstractExternalActor. m_ExternalActorthe external actor itself.protected ActorFlowVariables. m_Flowthe flow reference.protected ActorAbstractModelLoader. m_FlowContextthe flow context.protected ActorAbstractPyroCall. m_FlowContextthe flow context.protected ActorObjectRetriever. m_FlowContextthe flow context.protected ActorAbstractActor. m_Parentthe parent actor this actor is part of, e.g., a sequence.protected ActorAbstractActor. m_Selfthe actor itself.Methods in adams.flow.core with type parameters of type Actor Modifier and Type Method Description static <T extends Actor & VariablesHandler>
voidActorUtils. updateProgrammaticVariables(T context, File flow)Adds some programmatic variables.Methods in adams.flow.core that return Actor Modifier and Type Method Description static ActorActorUtils. cleanUpFlow(Actor actor)Cleans up the flow, e.g., removing disabled actors, unused callable actors.static ActorCallableActorHelper. createCallableActor(Actor actor)Turns the specified actor into a callable actor.static ActorActorUtils. createExternalActor(Actor[] actors, ActorHandler suggestion)Ensures that the actors are enclosed in an "instantiable" wrapper.protected ActorAbstractCallableActor. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorAbstractCopyCallableActor. findCallableActor()Tries to find the callable actor referenced by its name.ActorCallableActorHelper. findCallableActor(ActorHandler handler, CallableActorReference name)Checks a control actor's children whether they contain the callable actor that we're looking for.ActorCallableActorHelper. findCallableActor(Actor root, CallableActorReference name)Tries to find the callable actor referenced by its name.ActorCallableActorHelper. findCallableActor(ActorReferenceHandler handler, CallableActorReference name)Checks a reference handler's children whether they contain the callable actor that we're looking for.ActorCallableActorHelper. findCallableActorRecursive(Actor actor, CallableActorReference name)Tries to find the referenced callable actor.protected static ActorActorUtils. findClosestType(ActorHandler handler, Class type)Checks an actor handler's children whether they contain the actor type we're looking for.static ActorActorUtils. findClosestType(Actor actor, Class type)Tries to find the closest type in the actor tree, starting with the current actor.static ActorActorUtils. findClosestType(Actor actor, Class type, boolean includeSameLevel)Tries to find the closest type in the actor tree, starting with the current actor.ActorEventHelper. findEvent(ActorHandler group, EventReference name)Checks a control actor's children whether they contain the event that we're looking for.ActorEventHelper. findEvent(Actor root, EventReference name)Tries to find the event referenced by its global name.ActorEventHelper. findEventRecursive(Actor actor, EventReference name)Tries to find the referenced event.ActorCallableActorHelper. findMultiView(ActorHandler handler, CallableActorReference name)Checks a control actor's children whether they contain the multi-view actor that we're looking for.ActorCallableActorHelper. findMultiViewRecursive(Actor actor, CallableActorReference name)Tries to find the referenced multi-view actor.ActorActorHandler. firstActive()Returns the first non-skipped actor.static ActorAbstractActor. forCommandLine(String cmdline)Instantiates the item from the given commandline (i.e., classname and optional options).static ActorAbstractActor. forName(String classname, String[] options)Instantiates the item with the given options.static ActorAbstractActor. forName(String classname, String[] options, boolean quiet)Instantiates the item with the given options.ActorActorHandler. get(int index)Returns the actor at the given position.ActorActorStatistic. getActor()Returns the underlying actor.ActorAbstractTemplate. getActualActor()Returns the actual actor that was generated from the template.ActorAbstractCallableActor. getCallableActor()Returns the currently set callable actor.ActorCallableActorUser. getCallableActor()Returns the currently set callable actor.ActorTimedActor. getCallableActor()Returns the currently set callable actor.protected abstract ActorAbstractCopyCallableActor. getDefaultActor()Returns the default actor if the callable actor is optional and not found.ActorAbstractExternalActor. getExternalActor()Returns the external actor.ActorExternalActorHandler. getExternalActor()Returns the external actor.ActorFlowVariables. getFlow()Returns the flow to obtain callable actors from.ActorAbstractModelLoader. getFlowContext()Returns the flow context, if any.ActorAbstractPyroCall. getFlowContext()Returns the flow context, if any.ActorFlowContextHandler. getFlowContext()Returns the flow context, if any.ActorObjectRetriever. getFlowContext()Returns the flow context, if any.ActorAbstractTemplate. getInternalActor()Returns the internal actor.ActorInternalActorHandler. getInternalActor()Returns the internal actor.ActorAbstractActor. getNextSibling()If the actor is part of a group, this method returns the actor following it in that group.ActorActor. getNextSibling()If the actor is part of a group, this method returns the actor following it in that group.ActorAbstractActor. getParent()Returns the parent of this actor, e.g., the group.ActorActor. getParent()Returns the parent of this actor, e.g., the group.ActorAbstractActor. getPreviousSibling()If the actor is part of a group, this method returns the actor preceding it in that group.ActorActor. getPreviousSibling()If the actor is part of a group, this method returns the actor preceding it in that group.ActorAbstractActor. getRoot()Returns the root of this actor, e.g., the group at the highest level.ActorActor. getRoot()Returns the root of this actor, e.g., the group at the highest level.protected static ActorStopHelper. getRoot(Actor context)Returns the root actor.static ActorStopHelper. getStopActor(Actor context, StopMode mode)Determines the actor to call the stopExecution method on.protected static ActorStopHelper. getStopRestrictor(Actor context)Returns the enclosingStopRestrictor.ActorActorHandler. lastActive()Returns the last non-skipped actor.static ActorActorUtils. locate(ActorPath path, Actor parent)Tries to locate the actor specified by the path parts.static ActorActorUtils. locate(ActorPath path, Actor parent, boolean included, boolean quiet)Tries to locate the actor specified by the path parts.static ActorActorUtils. locate(String path, Actor root)Locates the actor in the actor tree based on the specified path.static ActorActorUtils. locate(String path, Actor root, boolean included, boolean quiet)Locates the actor in the actor tree based on the specified path.static ActorActorUtils. read(String filename)Reads an actor from a file.static ActorActorUtils. read(String filename, MessageCollection errors)Reads an actor from a file.static ActorActorUtils. read(String filename, MessageCollection errors, MessageCollection warnings)Reads an actor from a file.ActorMutableActorHandler. remove(int index)Removes the actor at the given position and returns the removed object.static ActorActorUtils. removeDisabledActors(Actor actor)Removes all disabled actors (recursively) from the actor.ActorAbstractActor. shallowCopy()Returns a shallow copy of itself, i.e., based on the commandline options.ActorAbstractActor. shallowCopy(boolean expand)Returns a shallow copy of itself, i.e., based on the commandline options.ActorActor. shallowCopy()Returns a shallow copy of itself, i.e., based on the commandline options.ActorActor. shallowCopy(boolean expand)Returns a shallow copy of itself, i.e., based on the commandline options.static ActorActorUtils. strip(Actor actor)Returns a stripped down version of the actor, i.e., for ActorHandlers, a copy of the actor without any sub-actors gets returned.Methods in adams.flow.core that return types with arguments of type Actor Modifier and Type Method Description static List<Actor>ActorUtils. enumerate(Actor actor)Enumerates all children of the given actor (depth-first search).static List<Actor>ActorUtils. enumerate(Actor actor, ActorFilter filter)Enumerates all children of the given actor (depth-first search).static List<Actor>ActorUtils. enumerate(Actor actor, Class[] filter)Enumerates all children of the given actor (depth-first search).static List<Actor>CallableActorHelper. findAllCallableActors(Actor flow)Returns allCallableActorsinstances that can be located in the flowList<Actor>CallableActorHelper. findCallableActorsRecursive(Actor actor)Locates all callable actors .protected static List<Actor>ActorUtils. findClosestTypes(ActorHandler handler, Class type)Checks an actor handler's children whether they contain the actor type we're looking for.static List<Actor>ActorUtils. findClosestTypes(Actor actor, Class type)Tries to find the closest types in the actor tree, starting with the current actor.static List<Actor>ActorUtils. findClosestTypes(Actor actor, Class type, boolean includeSameLevel)Tries to find the closest types in the actor tree, starting with the current actor.Methods in adams.flow.core with parameters of type Actor Modifier and Type Method Description voidCallableNamesRecorder. add(ActorHandler handler, Actor actor)Adds the name to the recorded ones.StringMutableActorHandler. add(int index, Actor actor)Inserts the actor at the given position.StringMutableActorHandler. add(Actor actor)Inserts the actor at the end.protected abstract StringAbstractCopyCallableActor. checkCallableActor(Actor actor)Performs checks on the callable actor.protected abstract StringAbstractIncludeExternalActor. checkExternalActor(Actor actor)Performs checks on the external actor.static StringActorUtils. checkFlow(Actor actor, boolean variables, boolean storage, File file)Checks the flow.static StringActorUtils. checkFlow(Actor actor, File file)Checks the flow.static booleanActorUtils. checkForCallableActorUser(Actor actor)Checks whether a callable actor user is present in this sub-tree.static booleanActorUtils. checkForExternalActor(Actor actor)Checks whether an external actor is present in this sub-tree.static StringActorUtils. checkForSource(Actor actor)Checks whether the actor has a source as first actor (can be nested).static StringActorUtils. checkForSource(Actor[] actors)Checks whether the actors have a source as first actor (can be nested).static ActorActorUtils. cleanUpFlow(Actor actor)Cleans up the flow, e.g., removing disabled actors, unused callable actors.intActorComparator. compare(Actor o1, Actor o2)For comparing actors.intDefaultActorComparator. compare(Actor o1, Actor o2)For comparing actors.booleanCallableNamesRecorder. contains(ActorHandler handler, Actor actor)Checks whether the name of the actor is already in use.static ActorCallableActorHelper. createCallableActor(Actor actor)Turns the specified actor into a callable actor.static CallableActorsCallableActorHelper. createCallableActors(Actor actor, boolean insert)Returns theCallableActorsinstance.static ActorActorUtils. createExternalActor(Actor[] actors, ActorHandler suggestion)Ensures that the actors are enclosed in an "instantiable" wrapper.static intActorUtils. determineNumActors(Actor flow)Returns how many actors this flow is made of.static StringInteractionDisplayLocationHelper. display(Actor context, GUIHelper.DialogCommunication comm, GUIHelper.InputPanelWithButtons panel)Displays the panel in the notification area.static StringInteractionDisplayLocationHelper. display(Actor context, GUIHelper.DialogCommunication comm, GUIHelper.InputPanelWithComboBox panel, int btnJustification)Displays the panel in the notification area.static StringInteractionDisplayLocationHelper. display(Actor context, GUIHelper.DialogCommunication comm, GUIHelper.InputPanelWithTextArea panel, int btnJustification)Displays the panel in the notification area.static BooleanInteractionDisplayLocationHelper. display(Actor context, GUIHelper.DialogCommunication comm, JPanel panel, int btnJustification)Displays the panel in the notification area.static BooleanInteractionDisplayLocationHelper. display(Actor context, GUIHelper.DialogCommunication comm, JPanel panel, int btnJustification, String icon)Displays the panel in the notification area.static EncapsulatedActorsContainerEncapsulateActors. encapsulate(Actor actor, VariableName[] vars, StorageName[] items)Encapsulates the actor as is.static EncapsulatedActorsContainerEncapsulateActors. encapsulate(Actor actor, VariableName[] vars, StorageName[] items, Object input)Encapsulates the actor as is.static booleanQueueHelper. enqueue(Actor actor, StorageName queue, Object payload)Queues the payload in the specified queue.static StringActorUtils. ensureValidVariables(Actor actor)Ensures that the variables within this actor are valid.static List<Actor>ActorUtils. enumerate(Actor actor)Enumerates all children of the given actor (depth-first search).static List<Actor>ActorUtils. enumerate(Actor actor, ActorFilter filter)Enumerates all children of the given actor (depth-first search).static List<Actor>ActorUtils. enumerate(Actor actor, Class[] filter)Enumerates all children of the given actor (depth-first search).protected static voidActorUtils. enumerate(Actor actor, List<Actor> children, ActorFilter filter)Enumerates all children of the given actor (depth-first search).static List<String>ActorUtils. extractActorNames(Actor current, String text)Extracts all the valid actor names from the given text fragment that exist within the specified flow.static List<ActorHandler>ActorUtils. findActorHandlers(Actor actor)Returns a list of actor handlers, starting from the current note (excluded).static List<ActorHandler>ActorUtils. findActorHandlers(Actor actor, boolean mustAllowStandalones)Returns a list of actor handlers, starting from the current note (excluded).static List<ActorHandler>ActorUtils. findActorHandlers(Actor actor, boolean mustAllowStandalones, boolean includeSameLevel)Returns a list of actor handlers, starting from the current note (excluded).static List<Actor>CallableActorHelper. findAllCallableActors(Actor flow)Returns allCallableActorsinstances that can be located in the flowActorCallableActorHelper. findCallableActor(Actor root, CallableActorReference name)Tries to find the callable actor referenced by its name.ActorCallableActorHelper. findCallableActorRecursive(Actor actor, CallableActorReference name)Tries to find the referenced callable actor.List<Actor>CallableActorHelper. findCallableActorsRecursive(Actor actor)Locates all callable actors .static Hashtable<String,Integer>ActorUtils. findCallableTransformers(Actor actor)Locates callable transformers.static ActorActorUtils. findClosestType(Actor actor, Class type)Tries to find the closest type in the actor tree, starting with the current actor.static ActorActorUtils. findClosestType(Actor actor, Class type, boolean includeSameLevel)Tries to find the closest type in the actor tree, starting with the current actor.static List<Actor>ActorUtils. findClosestTypes(Actor actor, Class type)Tries to find the closest types in the actor tree, starting with the current actor.static List<Actor>ActorUtils. findClosestTypes(Actor actor, Class type, boolean includeSameLevel)Tries to find the closest types in the actor tree, starting with the current actor.ActorEventHelper. findEvent(Actor root, EventReference name)Tries to find the event referenced by its global name.ActorEventHelper. findEventRecursive(Actor actor, EventReference name)Tries to find the referenced event.ActorCallableActorHelper. findMultiViewRecursive(Actor actor, CallableActorReference name)Tries to find the referenced multi-view actor.protected HashSet<String>AbstractActor. findVariables(Actor actor)Recursively finds all the variables used in the specified actor's setup.static StringActorUtils. forceVariables(Actor actor, Variables vars)Forces the update of the variables of this actor.static AbstractDatabaseConnectionActorUtils. getDatabaseConnection(Actor actor, Class cls, AbstractDatabaseConnection defCon)Returns the database connection object to use.static intActorUtils. getFlowID(Actor source)Returns the flow ID (if possible) for the given actor.static FlowWorkerHandlerInteractionDisplayLocationHelper. getFlowWorkerHandler(Actor context)Retrieves the FlowWorkerHandler from the context.static StringActorUtils. getFunctionalAspect(Actor actor)Determines the functional aspect of an actor.static StringActorUtils. getProceduralAspect(Actor actor)Determines the procedural aspect of an actor.static StorageQueueHandlerQueueHelper. getQueue(Actor actor, StorageName queue)Returns the specified queue.protected static ActorStopHelper. getRoot(Actor context)Returns the root actor.static ObjectCallableActorHelper. getSetup(Class cls, CallableActorReference name, Actor start, MessageCollection errors)Returns the setup obtained from the callable actor, source or transformer.protected static ObjectCallableActorHelper. getSetup(Class cls, CallableActorReference name, Actor start, AbstractCallableActor callable, MessageCollection errors)Returns the setup obtained from the callable actor, source or transformer.static ObjectCallableActorHelper. getSetupFromSource(Class cls, CallableActorReference name, Actor start, MessageCollection errors)Returns the setup obtained from the callable source.static ObjectCallableActorHelper. getSetupFromTransformer(Class cls, CallableActorReference name, Actor start, MessageCollection errors)Returns the setup obtained from the callable transformer.static ActorStopHelper. getStopActor(Actor context, StopMode mode)Determines the actor to call the stopExecution method on.protected static ActorStopHelper. getStopRestrictor(Actor context)Returns the enclosingStopRestrictor.static StorageEncapsulateActors. getStorage(Actor context, StorageName[] items)Extracts the specified storage items and returns the subset.static VariablesEncapsulateActors. getVariables(Actor context, VariableName[] vars)Extracts the specified variables and their values and returns the subset.StringAbstractActor. handleError(Actor source, String type, String msg)Handles the given error message with the flow that this actor belongs to, if the flow has error logging turned on.StringActor. handleError(Actor source, String type, String msg)Handles the given error message with the flow that this actor belongs to, if the flow has error logging turned on.StringErrorHandler. handleError(Actor source, String type, String msg)Handles the given error message with the flow that the actor belongs to, if the flow has error logging turned on.static booleanQueueHelper. hasQueue(Actor actor, StorageName queue)Checks whether the specified queue is available.static booleanActorUtils. isActorHandler(Actor actor)Checks whether this actor is an actor handler.static booleanActorUtils. isControlActor(Actor actor)Checks whether this actor is a control actor.static booleanActorUtils. isInteractive(Actor actor)Checks whether the actor or its sub-actors are interactive ones.static booleanActorUtils. isSink(Actor actor)Checks whether this actor is a sink (input).protected booleanActorStatistic. isSkipped(Actor actor)Checks whether the actor itself or one of its parents is skipped.static booleanActorUtils. isSource(Actor actor)Checks whether this actor is a source (output).static booleanActorUtils. isStandalone(Actor actor)Checks whether this actor is a standalone.static booleanActorUtils. isTransformer(Actor actor)Checks whether this actor is a transformer (input/output).static ActorActorUtils. locate(ActorPath path, Actor parent)Tries to locate the actor specified by the path parts.static ActorActorUtils. locate(ActorPath path, Actor parent, boolean included, boolean quiet)Tries to locate the actor specified by the path parts.static ActorActorUtils. locate(String path, Actor root)Locates the actor in the actor tree based on the specified path.static ActorActorUtils. locate(String path, Actor root, boolean included, boolean quiet)Locates the actor in the actor tree based on the specified path.static com.github.fracpete.javautils.struct.Struct3<KeyManagerFactoryProvider,TrustManagerFactoryProvider,SSLContextProvider>TLSHelper. locateActors(Actor context, boolean requireAll)Locates the following actors KeyManager (=0), TrustManager (=1), SSLContext (=2)voidPauseStateManager. pause(Actor source)Pauses the flow.static ActorActorUtils. removeDisabledActors(Actor actor)Removes all disabled actors (recursively) from the actor.voidPauseStateManager. resume(Actor source)Resumes the flow.StringActorHandler. set(int index, Actor actor)Sets the actor at the given position.voidActorStatistic. setActor(Actor value)Sets the actor to generate the statistics for.protected static StringActorUtils. setActors(ActorHandler handler, Actor[] actors)Sets the actors in the handler.voidFlowVariables. setFlow(Actor value)Sets the flow to obtain callable actors from.voidAbstractModelLoader. setFlowContext(Actor value)Sets the flow context.voidAbstractPyroCall. setFlowContext(Actor value)Sets the flow context.voidFlowContextHandler. setFlowContext(Actor value)Sets the flow context.voidObjectRetriever. setFlowContext(Actor value)Sets the flow context.voidAbstractActor. setParent(Actor value)Sets the parent of this actor, e.g., the group it belongs to.voidAbstractExternalActor. setParent(Actor value)Sets the parent of this actor, e.g., the group it belongs to.voidActor. setParent(Actor value)Sets the parent of this actor, e.g., the group it belongs to.static StringStopHelper. stop(Actor context, StopMode mode)Stops the flow using the specified stop mode, with no message.static StringStopHelper. stop(Actor context, StopMode mode, String message)Stops the flow using the specified stop mode, with no message.static ActorActorUtils. strip(Actor actor)Returns a stripped down version of the actor, i.e., for ActorHandlers, a copy of the actor without any sub-actors gets returned.static ListActorUtils. transform(Actor transformer, Object input)Processes the data using the specified transformer.static booleanActorUtils. uniqueName(Actor actor, ActorHandler handler, int index)Updates the name of the actor to make it unique among all the other actors of the given handler.static booleanActorUtils. uniqueName(Actor actor, Set<String> names)Updates the name of the actor to make it unique among all the other specified names.static booleanActorUtils. uniqueName(Actor actor, Set<String> names, boolean tailRemoval)Updates the name of the actor to make it unique among all the other specified names.static booleanActorUtils. uniqueNames(Actor[] actors)Updates the names of the actors to make then unique among all of them.voidActorStatistic. update(Actor actor)Updates the statistics with the specified actor.static voidPropertiesUpdaterHelper. update(Actor context, Object obj, BaseString[] props, VariableName[] vars, PropertyPath.PropertyContainer[] conts, MessageCollection errors)Updates the properties of the object using the current values of the variables.static voidActorUtils. updateErrorHandler(Actor actor, ErrorHandler handler, boolean trace)Updates the error handler.static voidActorUtils. updateFlowAwarePaintlet(Paintlet paintlet, Actor actor)Updates a "flow-aware" paintlet with the specified actor.static voidActorUtils. updateFlowAwarePaintlets(PaintablePanel panel, Actor actor)Updates all the "flow-aware" paintlets of the panel with the specified actor.static voidActorUtils. updateProgrammaticVariables(VariablesHandler handler, Actor context, File flow)Adds some programmatic variables.static EncapsulatedActorsContainerEncapsulateActors. wrap(Actor actor, VariableName[] vars, StorageName[] items)Wraps the actor to obtain a fully self-container flow.static EncapsulatedActorsContainerEncapsulateActors. wrap(Actor actor, VariableName[] vars, StorageName[] items, Object input)Wraps the actor to obtain a fully self-container flow.static booleanActorUtils. write(String filename, Actor actor)Writes the actor to a file.Method parameters in adams.flow.core with type arguments of type Actor Modifier and Type Method Description protected static voidActorUtils. enumerate(Actor actor, List<Actor> children, ActorFilter filter)Enumerates all children of the given actor (depth-first search).protected voidCallableActorHelper. findCallableActors(ActorHandler handler, List<Actor> collected)Locates callable actors.protected voidCallableActorHelper. findCallableActors(ActorReferenceHandler handler, List<Actor> collected)Locates callable actors.Constructors in adams.flow.core with parameters of type Actor Constructor Description ActorStatistic(Actor actor)Initializes the statistics with the specified actor. -
Uses of Actor in adams.flow.core.actorfilter
Methods in adams.flow.core.actorfilter with parameters of type Actor Modifier and Type Method Description booleanAcceptAll. accept(Actor actor)Returns whether the actor should be kept.booleanActorFilter. accept(Actor actor)Returns whether the actor should be kept.booleanExactMatch. accept(Actor actor)Returns whether the actor should be kept.booleanInvert. accept(Actor actor)Returns whether the actor should be kept.booleanMatch. accept(Actor actor)Returns whether the actor should be kept.booleanSuperclassOrInterface. accept(Actor actor)Returns whether the actor should be kept. -
Uses of Actor in adams.flow.execution
Fields in adams.flow.execution declared as Actor Modifier and Type Field Description protected ActorDebug. m_Currentthe current actor.Methods in adams.flow.execution with parameters of type Actor Modifier and Type Method Description protected voidExecutionLog. add(String origin, Actor actor, String msg, Token token)Writes a message to the log file.voidAbstractFlowExecutionListener. postExecute(Actor actor)Gets called after the actor was executed.voidCurrentlyExecuted. postExecute(Actor actor)Gets called after the actor was executed.voidDebug. postExecute(Actor actor)Gets called after the actor was executed.voidExecutionCounter. postExecute(Actor actor)Gets called after the actor was executed.voidExecutionLog. postExecute(Actor actor)Gets called after the actor was executed.voidFlowExecutionListener. postExecute(Actor actor)Gets called after the actor was executed.voidMultiListener. postExecute(Actor actor)Gets called after the actor was executed.voidTime. postExecute(Actor actor)Gets called after the actor was executed.voidAbstractFlowExecutionListener. postInput(Actor actor)Gets called after the actor received the token.voidDebug. postInput(Actor actor)Gets called after the actor received the token.voidExecutionLog. postInput(Actor actor)Gets called after the actor received the token.voidFlowExecutionListener. postInput(Actor actor)Gets called after the actor received the token.voidMultiListener. postInput(Actor actor)Gets called after the actor received the token.voidTime. postInput(Actor actor)Gets called after the actor received the token.voidAbstractFlowExecutionListener. postOutput(Actor actor, Token token)Gets called after a token was acquired from the actor.voidDebug. postOutput(Actor actor, Token token)Gets called after a token was acquired from the actor.voidExecutionLog. postOutput(Actor actor, Token token)Gets called after a token was acquired from the actor.voidFlowExecutionListener. postOutput(Actor actor, Token token)Gets called after a token was acquired from the actor.voidMultiListener. postOutput(Actor actor, Token token)Gets called after a token was acquired from the actor.voidTime. postOutput(Actor actor, Token token)Gets called after a token was acquired from the actor.voidAbstractFlowExecutionListener. preExecute(Actor actor)Gets called before the actor gets executed.voidCurrentlyExecuted. preExecute(Actor actor)Gets called before the actor gets executed.voidDebug. preExecute(Actor actor)Gets called before the actor gets executed.voidExecutionLog. preExecute(Actor actor)Gets called before the actor gets executed.voidFlowExecutionListener. preExecute(Actor actor)Gets called before the actor gets executed.voidMultiListener. preExecute(Actor actor)Gets called before the actor gets executed.voidTime. preExecute(Actor actor)Gets called before the actor gets executed.voidAbstractFlowExecutionListener. preInput(Actor actor, Token token)Gets called before the actor receives the token.voidDebug. preInput(Actor actor, Token token)Gets called before the actor receives the token.voidExecutionLog. preInput(Actor actor, Token token)Gets called before the actor receives the token.voidFlowExecutionListener. preInput(Actor actor, Token token)Gets called before the actor receives the token.voidMultiListener. preInput(Actor actor, Token token)Gets called before the actor receives the token.voidTime. preInput(Actor actor, Token token)Gets called before the actor receives the token.voidAbstractFlowExecutionListener. preOutput(Actor actor)Gets called before a token gets obtained from the actor.voidDebug. preOutput(Actor actor)Gets called before a token gets obtained from the actor.voidExecutionLog. preOutput(Actor actor)Gets called before a token gets obtained from the actor.voidFlowExecutionListener. preOutput(Actor actor)Gets called before a token gets obtained from the actor.voidMultiListener. preOutput(Actor actor)Gets called before a token gets obtained from the actor.voidTime. preOutput(Actor actor)Gets called before a token gets obtained from the actor.protected voidDebug. triggered(AbstractBreakpoint point, Actor actor, ExecutionStage stage)Suspends the flow execution.protected voidDebug. triggered(AbstractBreakpoint point, Actor actor, ExecutionStage stage, Token token)Suspends the flow execution. -
Uses of Actor in adams.flow.execution.debug
Fields in adams.flow.execution.debug declared as Actor Modifier and Type Field Description protected ActorControlPanel. m_CurrentActorthe current actor.Methods in adams.flow.execution.debug that return Actor Modifier and Type Method Description ActorControlPanel. getCurrentActor()Returns the current actor.Methods in adams.flow.execution.debug with parameters of type Actor Modifier and Type Method Description abstract booleanAbstractScopeRestriction. checkScope(Actor actor, ExecutionStage stage)Checks whether the specified actor falls within the scope.booleanMultiScopeRestriction. checkScope(Actor actor, ExecutionStage stage)Checks whether the specified actor falls within the scope.booleanNoScopeRestriction. checkScope(Actor actor, ExecutionStage stage)Checks whether the specified actor falls within the scope.booleanSubFlowRestriction. checkScope(Actor actor, ExecutionStage stage)Checks whether the specified actor falls within the scope.protected abstract booleanAbstractBreakpoint. evaluatePostExecute(Actor actor)Evaluates the breakpoint at post-execute.protected booleanAnyActorBreakpoint. evaluatePostExecute(Actor actor)Evaluates the breakpoint at post-execute.protected booleanClassBreakpoint. evaluatePostExecute(Actor actor)Evaluates the breakpoint at post-execute.protected booleanPathBreakpoint. evaluatePostExecute(Actor actor)Evaluates the breakpoint at post-execute.protected abstract booleanAbstractBreakpoint. evaluatePostInput(Actor actor)Evaluates the breakpoint at post-input.protected booleanAnyActorBreakpoint. evaluatePostInput(Actor actor)Evaluates the breakpoint at post-input.protected booleanClassBreakpoint. evaluatePostInput(Actor actor)Evaluates the breakpoint at post-input.protected booleanPathBreakpoint. evaluatePostInput(Actor actor)Evaluates the breakpoint at post-input.protected abstract booleanAbstractBreakpoint. evaluatePostOutput(Actor actor, Token token)Evaluates the breakpoint at post-output.protected booleanAnyActorBreakpoint. evaluatePostOutput(Actor actor, Token token)Evaluates the breakpoint at post-output.protected booleanClassBreakpoint. evaluatePostOutput(Actor actor, Token token)Evaluates the breakpoint at post-output.protected booleanPathBreakpoint. evaluatePostOutput(Actor actor, Token token)Evaluates the breakpoint at post-output.protected abstract booleanAbstractBreakpoint. evaluatePreExecute(Actor actor)Evaluates the breakpoint at pre-execute.protected booleanAnyActorBreakpoint. evaluatePreExecute(Actor actor)Evaluates the breakpoint at pre-execute.protected booleanClassBreakpoint. evaluatePreExecute(Actor actor)Evaluates the breakpoint at pre-execute.protected booleanPathBreakpoint. evaluatePreExecute(Actor actor)Evaluates the breakpoint at pre-execute.protected abstract booleanAbstractBreakpoint. evaluatePreInput(Actor actor, Token token)Evaluates the breakpoint at pre-input.protected booleanAnyActorBreakpoint. evaluatePreInput(Actor actor, Token token)Evaluates the breakpoint at pre-input.protected booleanClassBreakpoint. evaluatePreInput(Actor actor, Token token)Evaluates the breakpoint at pre-input.protected booleanPathBreakpoint. evaluatePreInput(Actor actor, Token token)Evaluates the breakpoint at pre-input.protected abstract booleanAbstractBreakpoint. evaluatePreOutput(Actor actor)Evaluates the breakpoint at pre-output.protected booleanAnyActorBreakpoint. evaluatePreOutput(Actor actor)Evaluates the breakpoint at pre-output.protected booleanClassBreakpoint. evaluatePreOutput(Actor actor)Evaluates the breakpoint at pre-output.protected booleanPathBreakpoint. evaluatePreOutput(Actor actor)Evaluates the breakpoint at pre-output.static AbstractScopeRestrictionDebugScopeRestrictionHelper. getDebugScopeRestriction(Actor actor)Goes up in the flow locating the firstDebugScopeRestrictionHandlerto determine any different scope restrictions.voidControlPanel. setCurrentActor(Actor value)Sets the current actor.booleanAbstractBreakpoint. triggersPostExecute(Actor actor)Checks whether the breakpoint gets triggered in post-execute.booleanAbstractBreakpoint. triggersPostInput(Actor actor)Checks whether the breakpoint gets triggered in post-input.booleanAbstractBreakpoint. triggersPostOutput(Actor actor, Token token)Checks whether the breakpoint gets triggered in post-output.booleanAbstractBreakpoint. triggersPreExecute(Actor actor)Checks whether the breakpoint gets triggered in pre-execute.booleanAbstractBreakpoint. triggersPreInput(Actor actor, Token token)Checks whether the breakpoint gets triggered in pre-input.booleanAbstractBreakpoint. triggersPreOutput(Actor actor)Checks whether the breakpoint gets triggered in pre-output. -
Uses of Actor in adams.flow.generator
Classes in adams.flow.generator with type parameters of type Actor Modifier and Type Class Description classAbstractFlowGenerator<T extends Actor>Ancestor for generators that use model setups to generate flows.interfaceGenerator<T extends Actor>Generator interface for flow generators.Fields in adams.flow.generator declared as Actor Modifier and Type Field Description protected TAbstractFlowGenerator. m_Ownerthe owner.Methods in adams.flow.generator that return Actor Modifier and Type Method Description protected abstract ActorAbstractFlowGenerator. doGenerate()Generates the flow.protected ActorTemplate. doGenerate()Generates the flow.ActorAbstractFlowGenerator. generate()Generates the flow and returns it.ActorGenerator. generate()Generates the flow and returns it. -
Uses of Actor in adams.flow.processor
Fields in adams.flow.processor declared as Actor Modifier and Type Field Description protected ActorAbstractActorListingProcessor. m_Currentthe current actor being processed.protected ActorAbstractModifyingProcessor. m_ModifiedActorthe modified flow.Fields in adams.flow.processor with type parameters of type Actor Modifier and Type Field Description protected Map<String,Actor>RemoveUnusedReferenceableActors. m_ReferenceableActorsthe referenceable actors.Methods in adams.flow.processor that return Actor Modifier and Type Method Description protected ActorAbstractActorListingProcessor. findEnclosingActor(OptionHandler owner, OptionTraversalPath path)Tries to locate the enclosing actor.protected ActorAbstractActorListingProcessor. findEnclosingActor(OptionHandler owner, OptionTraversalPath path, int index)Tries to locate the enclosing actor.ActorAbstractModifyingProcessor. getModifiedActor()Returns the modified actor.ActorModifyingProcessor. getModifiedActor()Returns the modified actor.protected ActorReactivateActors. transferName(Actor source, Actor target)Transfer the name of "source" to "target" and returns "target".Methods in adams.flow.processor with parameters of type Actor Modifier and Type Method Description protected voidAbstractActorProcessor. checkData(Actor actor)The default implementation only checks whether there is any actor set.protected voidChangePath. checkData(Actor actor)The default implementation only checks whether there is any actor set.voidAbstractActorProcessor. process(Actor actor)Processes the actor.voidAbstractModifyingProcessor. process(Actor actor)Processes the actor.voidActorProcessor. process(Actor actor)Processes the actor.protected voidAbstractActorListingProcessor. processActor(Actor actor)Performs the actual processing.protected abstract voidAbstractActorProcessor. processActor(Actor actor)Performs the actual processing.protected voidAbstractListingProcessor. processActor(Actor actor)Performs the actual processing.protected voidAbstractModifyingInteractiveProcessor. processActor(Actor actor)Performs the actual processing.protected voidAbstractNameUpdater. processActor(Actor actor)Performs the actual processing.protected voidActorStatistics. processActor(Actor actor)Performs the actual processing.protected voidChangeDatabaseConditionLimit. processActor(Actor actor)Performs the actual processing.protected voidChangeDatabaseConnection. processActor(Actor actor)Performs the actual processing.protected voidChangeDisplayType. processActor(Actor actor)Performs the actual processing.protected voidChangeNumThreads. processActor(Actor actor)Performs the actual processing.protected voidChangePath. processActor(Actor actor)Performs the actual processing.protected voidCheckActorReferenceUsage. processActor(Actor actor)Performs the actual processing.protected voidCheckPlaceholders. processActor(Actor actor)Performs the actual processing.protected voidCheckStorageUsage. processActor(Actor actor)Performs the actual processing.protected voidCheckVariableUsage. processActor(Actor actor)Performs the actual processing.protected voidFlattenStructure. processActor(Actor actor)Performs the actual processing.protected voidForwardSlashSwitch. processActor(Actor actor)Performs the actual processing.protected voidListAllStorageNames. processActor(Actor actor)Performs the actual processing.protected voidListAllVariables. processActor(Actor actor)Performs the actual processing.protected voidManageInteractiveActors. processActor(Actor actor)Performs the actual processing.protected voidManageTimedActors. processActor(Actor actor)Performs the actual processing.protected voidMultiProcessor. processActor(Actor actor)Performs the actual processing.protected voidReactivateActors. processActor(Actor actor)Performs the actual processing.protected voidRemoveAutogeneratedActors. processActor(Actor actor)Performs the actual processing.protected voidRemoveBreakpoints. processActor(Actor actor)Performs the actual processing.protected voidRemoveDisabledActors. processActor(Actor actor)Performs the actual processing.protected voidRemoveUnusedReferenceableActors. processActor(Actor actor)Performs the actual processing.protected voidSwapObjects. processActor(Actor actor)Performs the actual processing.protected ActorReactivateActors. transferName(Actor source, Actor target)Transfer the name of "source" to "target" and returns "target". -
Uses of Actor in adams.flow.setup
Fields in adams.flow.setup declared as Actor Modifier and Type Field Description protected ActorFlowSetup. m_LastActorthe last actor that was executed.protected ActorFlowSetupWorker. m_LastActorthe last actor that was run.Methods in adams.flow.setup that return Actor Modifier and Type Method Description ActorFlowSetupWorker. getLastActor()Returns the actor that was executed. -
Uses of Actor in adams.flow.sink
Subinterfaces of Actor in adams.flow.sink Modifier and Type Interface Description interfaceDisplayPanelProviderInterface for graphical sinks that can also generate a panel from scratch for a new token.Classes in adams.flow.sink that implement Actor Modifier and Type Class Description classAbstractAppendableFileWriterAncestor for file writers that allow appending to the file instead of just replacing any existing files.classAbstractDbSinkAncestor for sinks that use the database.classAbstractDisplayAncestor for actors that display stuff.classAbstractFileWriterAncestor for sinks that write to output files.classAbstractGraphicalDisplayAncestor for actors that display stuff.classAbstractGraphicsGeneratorAncestor for actors that generate graphics of some kind.classAbstractScriptAncestor for sink script actors.classAbstractSinkAncestor for all flow items that function as sink.classAbstractTextualDisplayAncestor for actors that display textual stuff.classAbstractWekaModelWriterAncestor for actors that serialize models.classActualVsPredictedPlotPlots actual vs predicted columns obtained from a spreadsheet.classArrayDisplayDisplays the array elements in a single panel.classAutogeneratedSinkEncapsulates a sequence of auto-generated actors.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classBinaryFileWriterWrites a byte array or adams.data.blob.BlobContainer to a binary file.classBoxPlot* Actor for displaying box plots.
*
* For more information, see:
* http://en.wikipedia.org/wiki/Box_plot *
Valid options are:classBrowserDisplays a URL in a webbrowser.
By default, the system's default browser is used.classCallableSinkLets a callable sink consume the input tokens.classCanvasGeneral purpose drawing canvas.classCloseInputStreamCloses the incoming input stream instance.
See also:
adams.flow.source.InputStreamGenerator
Input/output:
- accepts:
java.io.InputStream
classCloseReaderCloses the incoming reader instance.
See also:
adams.flow.source.ReaderGenerator
Input/output:
- accepts:
java.io.Reader
classConsoleNon-graphical actor that outputs any object that arrives at its input port via the 'toString()' method on stdout.classContainerDisplayActor for displaying a spreadsheet.classControlChartPlotActor for generating control chart plots.
The plot needs to be initialized with a class adams.flow.container.ControlChartContainer.classCopyCallableSinkCopies a callable sink to consume the tokens.classDisplayActor that outputs any object that arrives at its input port via the 'toString()' method.classDisplayPanelGridSink that places a panel in the grid for each each arriving token.
Uses the user-defined panel provider for creating the panels.classDisplayPanelManagerActor that displays a 'history' of panels created by the selected panel provider.classDOMDisplayDisplays a DOM node object as tree structure.classDownloadFileDownloads a file from a URL and saves it locally.
Also handles basic authentication when using URLs like this:
http://user:pass@domain.com/url
Input/output:
- accepts:
java.lang.String
java.net.URL
classDumpFileActor that just dumps any input token into a separate line of the specified output file.classEmailFileWriterActor that writes Email objects to files.classEmailViewerActor for displaying an email object.classEnQueueEnqueues the incoming data in the specified queue in internal storage.classExecPipes the incoming data, after converting it using the provided conversion scheme, into the started process.classExternalSinkSink that executes an external sink actor stored on disk.classFileBrowserDisplays the file or directory with the system's file browser.classFilePreviewActor for previewing file contents.classFlowDisplayDisplays an actor or flow.classFlowFileWriterWrites the incoming actor(s) to a file.
A custom flow writer can be specified.classFourInOneDisplayActor for displaying a four-in-one plot.classGroovyA sink that uses a Groovy script for processing the token(s).classHistogramGenerates a histogram based on the incoming data.classHistoryDisplayActor that outputs any object that arrives at its input port via the 'toString()' method in a separate 'history' entry.classHtml4DisplayViewer for HTML 4.classImageFileWriterWrites the image to disk using the specified writer.classImageHistogramDisplays a histogram of a gray image or histograms per channel for color image.classImageSegmentationFileWriterWrite image segmentation containers using the specified writer.classImageSegmentationViewerDisplays image segmentation containers.classImageViewerActor for displaying an image.classInactiveSinkEncapsulates a sequence of inactive actors.
Can be removed with the adams.flow.processor.ReactivateActors processor.classIncludeExternalSinkIncludes an external sink.classIndexedSplitsRunsWriterReads indexed splits runs from disk using the specified writer.classInformationDialogDisplays the incoming message in a message box.classJavaLoggingUses the Java logging framework to output the incoming data.
Simply uses an object's 'toString()' method.classJFreeChartFileWriterGenerates a JFreeChart plot and writes the bitmap to a file.classJFreeChartPlotGenerates and displays a plot using JFreeChart.classJsonDisplayDisplays a JSON object as tree structure.classJsonFileWriterWrites a JSON object/array to a file.classLargeObjectDbWriterAllows storing large objects in a SQL database.classLogDumperActor that stores LogEntry objects in a file (CSV format).classLoggerActor that stores LogEntry objects in the Log table.classLogViewerActor that displays LogEntry objects, but doesn't store them in the database.classMat5FileWriterWrites the Mat5File object to the specified file.classMatrixPlotActor for displaying a matrix of scatter plots
Valid options are:classMenuItemLaunches a menu item from the main menu.classMergeFilesCombines the incoming files in a single one.classNotesWriterSaves the notes attached to a data structure to a text file.classNullActor that gobbles up all tokens, like '/dev/null' in Unix.classObjectPreviewActor for previewing file contents.classObjectViewerAllows to inspect any object using ADAMS' inspection capabilities.classOpenFileOpens the incoming file with the appropriate platform-specific application.
Does nothing in a headless (non-graphical) environment.classPasteFilesGenerates a single file from combined lines from the input files.classPDFCloseDocumentCloses the incoming PDF document, writing out its content.
The PDF document can be generated with adams.flow.source.PDFNewDocument and appended using adams.flow.transformer.PDFAppendDocument.
See also:
adams.flow.source.PDFNewDocument
adams.flow.transformer.PDFAppendDocument
Input/output:
- accepts:
adams.flow.transformer.pdfproclet.PDFGenerator
classPDFViewerActor for displaying PDF files.classPlotContainerSinkActor that outputs the plot containers in various formats.classProbabilityPlotDisplayActor for displaying a probability plot
Valid options are:classProgrammaticSinkFor programmatically hooking into a flow and receive tokens.classProgressBarDisplays a progress bar.classPropertiesDisplayDisplays a Properties object as table.classPropertiesFileWriterWrites a Java properties object to a file.classPublishPublishes the incoming data using the specified publish/subscribe handler in storage.classPyroSinkConsumes data using a Pyro4 call.
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
Input/output:
- accepts:
java.lang.Object
classRemoteCommandWriterSends a command to the remote host defined by the connection settings.
Unsuccessful commands can be store on disk to retry later.classReportDisplayDisplays reports.classScatterDisplayActor for displaying a scatter plot of one attribute vs another.classScreenshotActor that takes screenshots of graphical components.classScriptedA sink that uses an exterrnal script for processing the token(s).classSendEmailActor for sending emails.classSendNotificationSends the incoming message string via the configured notification scheme.classSendRemoteCommandSends a command to the remote host defined by the connection settings.
Unsuccessful commands can be store on disk to retry later.classSequencePlotterActor that plots sequences over time.
See also:
adams.flow.sink.SimplePlot
Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
adams.flow.container.SequencePlotterContainer[]
Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
classSerializeSaves a Java object to a file using the specified object writer.classSideBySideDiffActor for displaying a side-by-side diff.classSimpleLoggingTurns the incoming objects into strings, formats them with the selected formatter and then outputs them with the specified output(s).classSimplePlotActor for generating simple plots.
See also:
adams.flow.sink.SequencePlotter
Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
adams.flow.container.SequencePlotterContainer[]
Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
classSocketJust outputs the data to the specified socket.
Any incoming data that isn't a byte array gets converted to a string and its bytes (using the specified encoding) are then transmitted.
See also:
adams.flow.source.Socket
Input/output:
- accepts:
java.lang.Object
byte[]
java.lang.Byte[]
classSpreadSheetDbWriterTransfers a SpreadSheet object into a database.classSpreadSheetDisplayActor for displaying a spreadsheet.
Custom background for negative/positive values can be specified as well.classSpreadSheetFileWriterActor that writes SpreadSheet objects to files.classSpreadSheetRowViewerActor for displaying spreadsheet rows in a graphical way, like the 'Spreadsheet Explorer' tool.classStringTreeGenerates a tree from the strings arriving at the input, splitting them into parts using the specified separator.classTemplateSinkLets a sink generated from a template consume the input tokens.classTextWriterWrites incoming textual data to a text file.classTimeseriesDisplayActor that displays timeseries.classWebSocketClientSends the incoming data to a websocket server and forwards the received data.classWekaAttributeSummaryDisplays an attribute summary.classWekaClassifierErrorsActor for displaying classifier errors.classWekaCostBenefitAnalysisActor for displaying a cost benefit analysis dialog.classWekaCostCurveActor for displaying a cost curve.classWekaDatabaseWriterActor for saving a weka.core.Instances object in a database.
The relation name of the incoming dataset can be used to replace the current filename (path and extension are kept).classWekaExperimentFileWriterSaves an experiment file.classWekaExperimentGeneratorGenerates an experiment setup that can be used in conjunction with the Experiment transformer actor.classWekaFileWriterActor for saving a weka.core.Instances object as file.
The relation name of the incoming dataset can be used to replace the current filename (path and extension are kept).classWekaGraphVisualizerDisplays BayesNet graphs in XML or BIF notation
Either displays the contents of a file or an object that implements weka.core.Drawable and generates a BayesNet graph.classWekaInstancesDisplayActor for displaying a weka.core.Instances object in table format.classWekaInstancesPlotActor for plotting one attribute vs another.classWekaInstanceViewerActor for displaying adams.data.instance.Instance objects in a graphical way (using the internal format), like the 'Instance Explorer' tool.classWekaMarginCurveActor for displaying margin errors.classWekaModelWriterActor for saving a model (classifier or clusterer) alongside an optional header (i.e., weka.core.Instances object) as file.classWekaThresholdCurveActor for displaying threshold curves, like ROC or precision/recall.classWekaTreeVisualizerDisplays trees in dot notation.classXMLFileWriterWrites a org.w3c.dom.Document to an XML file.
In case of org.w3c.dom.Node objects, the owning document is written to disk.classYamlFileWriterWrites a Map object to a YAML file.
http://yaml.org/
Input/output:
- accepts:
java.util.Map
java.util.List
classZScoreDisplayActor for displaying a z score plot
Valid options are:Methods in adams.flow.sink that return Actor Modifier and Type Method Description protected ActorCallableSink. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorCopyCallableSink. getDefaultActor()Returns the default actor if the callable actor is optional and not found.Methods in adams.flow.sink with parameters of type Actor Modifier and Type Method Description protected StringCopyCallableSink. checkCallableActor(Actor actor)Performs checks on the callable actor.protected StringIncludeExternalSink. checkExternalActor(Actor actor)Performs checks on the external actor.voidTimeseriesDisplay.DisplayPanel. updateFlowAwarePaintlets(Actor actor)Constructors in adams.flow.sink with parameters of type Actor Constructor Description AutogeneratedSink(Actor actor)Encapsulates the specified actor.AutogeneratedSink(Actor[] actors)Encapsulates the specified actors.InactiveSink(Actor actor)Encapsulates the specified actor.InactiveSink(Actor[] actors)Encapsulates the specified actors. -
Uses of Actor in adams.flow.sink.sendnotification
Fields in adams.flow.sink.sendnotification declared as Actor Modifier and Type Field Description protected ActorAbstractNotification. m_FlowContextthe flow context.Methods in adams.flow.sink.sendnotification that return Actor Modifier and Type Method Description ActorAbstractNotification. getFlowContext()Returns the flow context, if any.Methods in adams.flow.sink.sendnotification with parameters of type Actor Modifier and Type Method Description voidAbstractNotification. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.sink.sequenceplotter
Fields in adams.flow.sink.sequenceplotter declared as Actor Modifier and Type Field Description protected ActorByNameErrorPaintlet. m_Actorthe actor the paintlet belongs to.protected ActorByNameMarkerPaintlet. m_Actorthe actor the paintlet belongs to. -
Uses of Actor in adams.flow.sink.simplelogging.format
Fields in adams.flow.sink.simplelogging.format declared as Actor Modifier and Type Field Description protected ActorAbstractSimpleFormat. m_FlowContextthe flow context.Methods in adams.flow.sink.simplelogging.format that return Actor Modifier and Type Method Description ActorAbstractSimpleFormat. getFlowContext()Returns the flow context.Methods in adams.flow.sink.simplelogging.format with parameters of type Actor Modifier and Type Method Description voidAbstractSimpleFormat. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.sink.simplelogging.output
Fields in adams.flow.sink.simplelogging.output declared as Actor Modifier and Type Field Description protected ActorAbstractSimpleOutput. m_FlowContextthe flow context.Methods in adams.flow.sink.simplelogging.output that return Actor Modifier and Type Method Description ActorAbstractSimpleOutput. getFlowContext()Returns the flow context.Methods in adams.flow.sink.simplelogging.output with parameters of type Actor Modifier and Type Method Description voidAbstractSimpleOutput. setFlowContext(Actor value)Sets the flow context.voidMultiOutput. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.source
Subinterfaces of Actor in adams.flow.source Modifier and Type Interface Description interfaceConditionalIdSupplierInterface for ID suppliers that use a conditions object.Classes in adams.flow.source that implement Actor Modifier and Type Class Description classAbstractArrayProviderAncestor for source actors that can output items one by one or as a single array.classAbstractBufferingSourceAncestor for queues that need to buffer output from eg another process.classAbstractConditionalIdSupplierAbstract ancestor for ID suppliers that use a conditions object.classAbstractDatabaseIdSupplierAbstract ancestor for ID suppliers.classAbstractDatabaseMetaDataAncestor for sources that output the database meta-data.classAbstractDbArrayProviderAncestor for array providers that use the database.classAbstractDbSourceAncestor for sources that access the database..classAbstractForLoopAbstract ancestor for for-loops.classAbstractIdSupplierAbstract ancestor for ID suppliers.classAbstractInstrumentSupplierAbstract ancestor for instrument suppliers.classAbstractInteractiveArrayProviderAncestor for interactive sources that can provide the output as an array or one-by-one.classAbstractInteractiveSourceAncestor for source actors that interact with the user.classAbstractListTablesAncestor for sources that list tables from a database.classAbstractPythonExecutionAncestor for sources that execute a Python executable.classAbstractScriptAncestor for source script actors.classAbstractSelectObjectsAncestor for sources that promp the user to select a number of objects to be broadcasted as tokens.classAbstractSimpleDbSourceAncestor for simple sources that use the database.classAbstractSimpleSourceAncestor for sources that just output a single token.classAbstractSimpleSourceWithPropertiesUpdatingAncestor for simple sources that allow changing the object's properties using variables.classAbstractSourceAncestor of all flow items that act as sources of tokens.classAbstractSpreadSheetDbReaderAncestor for spreadsheet database readers.classAbstractWekaSetupGenerator<T>Abstract ancestor for setup generator sources.classAutogeneratedSourceEncapsulates 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.classCallableSourceBroadcasts the generated output tokens from the source.classColorProviderUses the configured color provider to generate a number of colors.classCombineArraysCombines the storage items representing arrays into a single array.
When not supplying an array class the type of the first array is used.classCombineCollectionsclassCombineStorageOutputs the expanded string generated from the specified combination expression (variables and storage placeholders).classCombineVariablesOutputs the expanded string generated from the specified combination expression.classCommandRuns an external system command and broadcasts the generated output (stdout and/or stderr) continuously, opposed to adams.flow.source.Exec which waits for the command to finish.
See also:
adams.flow.source.Exec
Input/output:
- generates:
java.lang.String
classCopyCallableSourceBroadcasts the generated output tokens from the copied callable source.classCounterOutputs the specified counter as spreadsheet, with two columns: 'Key' and 'Count'.classCurrentFlowOutputs the current flow, i.e., itself.classCurrentTimeclassDatabaseMetaDataOutputs the meta-data of the current database connection.classDeQueuePolls the specified queue in internal storage for an item, blocks till an item is available.
NB: The user needs to stop the flow as the DeQueue source will never stop, as it assumes that there will be more data coming through.classDirectoryListerReturns the contents of a directory (files/dirs).classDirectorySupplierSupplies directories.classDumpStorageOutputs the storage names and the string representation of their associated values in the specified format.classDumpVariablesOutputs the variable names and their associated values in the specified format.classEnterManyValuesPops up a dialog, prompting the user to enter one or more values.classEnterValuePops up a dialog, prompting the user to enter a value.classExecRuns an external system command and broadcasts the generated output (stdout or stderr).
See also:
adams.flow.source.Exec
Input/output:
- generates:
java.lang.String
classExternalSourceSource that executes an external source actor stored on disk.classFilenameGeneratorUses the specified filename generator to output a filename.
NB: Generators that require an object to pass through won't work with this source.
See also:
adams.flow.transformer.FilenameGenerator
Input/output:
- generates:
java.lang.String
classFileSupplierSupplies files.classFileSystemSearchUses the specified search algorithm to perform a file system search and returns the located items.classForLoopEmulates the following for-loop for integer IDs:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
The integers can be output as a single array as well.classFTPListerDeprecated.classGetEnvironmentVariableOutputs the value of the specified environment variable.classGetSystemPropertyOutputs the value of the specified Java system property.classGroovyA source that uses a Groovy script for generating the token(s).classHashSetOutputs the specified hashset as spreadsheet, with one column called 'Value' by default.classHttpRequestSubmits the (optional) form parameters to the specified URL and forwards the retrieved HTML as text.
Cookies can be retrieved and stored in internal storage, to be re-used with the next request.classIdleSimulates an endless loop, which only exits if the flow is stopped.
Essentially blocking any following actors, never outputs anything.classInactiveSourceEncapsulates 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.classIncludeExternalSourceIncludes an external source.classInputStreamGeneratorUses the specified generator to instantiate an input stream instance.
See also:
adams.flow.sink.CloseInputStream
Input/output:
- generates:
java.io.InputStream
classIntegerRangeOutputs the integers defined by the range expression.classLargeObjectDbReaderAllows reading of large objects from a SQL database.classListCallableActorsclassListEnvironmentVariablesOutputs the names of the currently set environment variables.classListStorageNamesOutputs the names of the currently available storage items.classListSystemPropertiesOutputs the names of the currently set Java system properties.classListTablesLists tables of the current database connection.classListVariablesOutputs the names of the currently available variables.classLookUpForwards the value associated with the given key, using the specified lookup table from internal storage.classLookUpTableOutputs the specified lookup table as spreadsheet, containing to columns: Key with the keys and Value with the associated values.classMakeContainerAssembles a container with data obtained from either callable actors or storage items.classMathExpressionEvaluates a mathematical expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
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) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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.classMemoryUsageOutputs the memory usage.
The generated map has the following keys:
- init_heap
- max_heap
- used_heap
- committed_heap
- init_non_heap
- max_non_heap
- used_non_heap
- committed_non_heap
Input/output:
- generates:
java.util.Map
classModuleInfoOutputs a spreadsheet with information about modules available.classNewArrayGenerates a new array of the specified class with the given dimensions.
Dimensions are given as follows: [x], with x being the number of elements.classNewCollectionGenerates a new (and empty) collection of the specified type.classNewDOMDocumentCreates a new DOM document, e.g., for assembling XML files.classNewFlowOutputs the flow generated by the specified template.classNewImageGenerates an empty image with the specified dimensions (Type: RGB or ARBG).classNewJsonStructureGenerates an empty JSON data structure of the specified type.classNewListGenerates a list string based on the items produced by the generator and the specified separator.classNewMapGenerates a new java.util.Map object using the specified implementation class.classNewMat5FileCreates an empty Mat5File object.classNewMat5MatrixCreates a new Matlab matrix.classNewMat5StructclassNewPropertiesGenerates a new Properties object.classNewRemoteCommandConfigures and forwards a remote command.classNewReportGenerates a new instance of the specified report class.classNewSpreadSheetGenerates an empty spreadsheet.classNewTempFileclassNullDummy source, generates no output.classOpenCVDeviceFrameGrabberGrabs frames from the specified device and forwards them as image containers.classOptionProducerGenerates string output from the current flow using the specified option producer.classOptionTraverserTraverses the options of the flow at run-time.
Used for debugging purposes.classPasteFromClipboardPops up a dialog, prompting the user to accept content from clipboard.classPDFNewDocumentCreates an empty PDF document.
Needs to be finalized with adams.flow.sink.PDFCloseDocument.
The output of this source can be processed by adams.flow.transformer.PDFAppendDocument.
See also:
adams.flow.transformer.PDFAppendDocument
adams.flow.sink.PDFCloseDocument
Input/output:
- generates:
adams.flow.transformer.pdfproclet.PDFGenerator
classPipExecExecutes pip with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.classPyroSourceGenerates data using a Pyro4 call
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
Input/output:
- generates:
java.lang.Object
classPythonExecExecutes the specified Python script with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.classPythonVenvExecExecutes the specified executable in a Python virtual environment with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.
Fails if the specified environment does not contain any 'activate' scripts typically found in such directories.classRandomNumberGeneratorRandom number generator.classReaderGeneratorUses the specified generator to instantiate a reader instance.
See also:
adams.flow.sink.CloseReader
Input/output:
- generates:
java.io.InputStream
classRSyncSupports synchronization using rsync.
In case of an error, the stderr output is forwarded, otherwise stdout output.classRsync4jRsyncBinaryOutputs the rsync binary used by the rsync4j library.classRsync4jSshBinaryOutputs the ssh binary used by the rsync4j library.classScriptedA source that uses an external script for generating the token(s).classSelectCharsetPrompts the user to select a character set.classSelectDateTimePops up a dialog, prompting the user to select a date/time, date or time value.classSelectDirectoryPops up a directory chooser dialog, prompting the user to select a directory.classSelectFilePops up a file chooser dialog, prompting the user to select one or more files.classSelectObjectsAllows the user to select an arbitrary number of objects from the specified class hierarchy using the GenericObjectArray.
It is possible to use this dialog for other objects as well that don't belong to a class hierarchy, e.g., adams.core.base.BaseString.classSequenceSourceEncapsulates a sequence of flow items, with the last one generating the output for this meta-source.classSimpleRSyncAn rsync wrapper with a reduced set of options.classSocketListens on the specified port for incoming data.
Can either output raw byte arrays or strings (using the specified encoding).
See also:
adams.flow.sink.Socket
Input/output:
- generates:
byte[]
classSpecifiedActorOutputs the actor identified by the actor path.classSpreadSheetDbReaderReturns a spreadsheet object generated from an SQL query.
To optimize memory consumption, you can return the result of the query in chunks of a specified size.classSQLIdSupplierExecutes an SQL statement for generating the IDs.
Variables are automatically expanded.classSSHExecRuns a system command via ssh on a remote machine and broadcasts the generated output (stdout or stderr).
For more information see:
(2011).classStartOutputs merely a NullToken.classStorageForLoopEmulates the following for-loop:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
In each iteration, the specified variable gets updated with the current value of the for-loop variable.classStorageValueOutputs the value associated with the specified name from temporary storage.
Does nothing if the storage value isn't present.
By supplying a cache name, the value can be obtained from a LRU cache instead of the regular storage.classStorageValuesArrayOutputs the values associated with the specified names from temporary storage as an array.classStringConstantsA source for strings.classStringExpressionEvaluates a string expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
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) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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] )
# array functions
| len[gth] ( array )
| get ( array , index )
;
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' for function 'get' starts 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.classSwitchedSourceclassTemplateSourceBroadcasts the generated output tokens from the (template) source.classTimeseriesDbReaderOutputs timeseries containers generated from an SQL SELECT statement.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).classURLSupplierSupplies multiple URLs (uniform resource locators).classVariableOutputs the string value of the specified variable.
Does nothing if the variable hasn't been set.classVariablesArrayOutputs the values associated with the specified variable names as a string array.classWekaAssociatorSetupOutputs an instance of the specified associator.classWekaClassifierGeneratorGenerates multiple classifier setups.classWekaClassifierSetupOutputs an instance of the specified classifier.classWekaClustererGeneratorGenerates multiple clusterer setups.classWekaClustererSetupOutputs an instance of the specified clusterer.classWekaDatabaseReaderExecutes a query and returns the data either in batch or incremental mode.classWekaDataGeneratorGenerates artificial data using a Weka data generator.classWekaFilterGeneratorGenerates multiple filter setups.classWekaForecasterSetupOutputs a configured instance of a Weka Forecaster.classWekaForecastingUses a serialized model to perform predictions on the data being passed through.
The model can also be obtained from a callable actor, if the model file is pointing to a directory.classWekaNewExperimentGenerates a new ADAMS experiment setup.classWekaNewInstancesGenerates an empty dataset, based on the attribute types and names specified.
Nominal attributes are generated with an empty set of labels.classWekaSelectDatasetPops up a file chooser dialog, prompting the user to select one or more datasets.classWekaSelectObjectsAllows the user to select an arbitrary number of Weka objects from the specified class hierarchy using the GenericObjectArray.classZipArraysAligns the corresponding elements of the storage arrays into row-based arrays.Fields in adams.flow.source declared as Actor Modifier and Type Field Description protected ActorSwitchedSource. m_ActiveCasethe active case.protected ActorAbstractInteractiveSource. m_CallableActorthe callable actor.protected ActorSelectFile. m_CallableActorthe callable actor.protected ActorWekaSelectDataset. m_CallableActorthe callable actor.Fields in adams.flow.source with type parameters of type Actor Modifier and Type Field Description protected List<Actor>SwitchedSource. m_Casesthe "cases" to execute if the corresponding expression matches.Methods in adams.flow.source that return Actor Modifier and Type Method Description protected ActorAbstractInteractiveSource. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorCallableSource. findCallableActor()Tries to find the callable actor referenced by its global name.protected ActorSelectFile. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorWekaSelectDataset. findCallableActor()Tries to find the callable actor referenced by its callable name.ActorSwitchedSource. firstActive()Returns the first non-skipped actor.ActorSwitchedSource. get(int index)Returns the actor at the given position.Actor[]SwitchedSource. getCases()Returns the cases.protected ActorCopyCallableSource. getDefaultActor()Returns the default actor if the callable actor is optional and not found.ActorSwitchedSource. lastActive()Returns the last non-skipped actor.ActorSwitchedSource. remove(int index)Removes the actor at the given position and returns the removed object.Methods in adams.flow.source with parameters of type Actor Modifier and Type Method Description StringSwitchedSource. add(int index, Actor actor)Inserts the actor at the given position.StringSwitchedSource. add(Actor actor)Inserts the actor at the end.StringSwitchedSource. check(int index, Actor actor)Performs checks on the "sub-actor".protected StringCopyCallableSource. checkCallableActor(Actor actor)Performs checks on the callable actor.protected StringIncludeExternalSource. checkExternalActor(Actor actor)Performs checks on the external actor.protected StringSequenceSource.SequenceSourceDirector. doExecuteActors(Actor startActor)Peforms the execution of the actors.StringSwitchedSource. set(int index, Actor actor)Sets the actor at the given position.voidSwitchedSource. setCases(Actor[] value)Sets the cases.Constructors in adams.flow.source with parameters of type Actor Constructor Description AutogeneratedSource(Actor actor)Encapsulates the specified actor.AutogeneratedSource(Actor[] actors)Encapsulates the specified actors.InactiveSource(Actor actor)Encapsulates the specified actor.InactiveSource(Actor[] actors)Encapsulates the specified actors. -
Uses of Actor in adams.flow.source.filesystemsearch
Fields in adams.flow.source.filesystemsearch declared as Actor Modifier and Type Field Description protected ActorAbstractFileSystemSearchlet. m_FlowContextthe flow context.Methods in adams.flow.source.filesystemsearch that return Actor Modifier and Type Method Description ActorAbstractFileSystemSearchlet. getFlowContext()Returns the flow context, if any.Methods in adams.flow.source.filesystemsearch with parameters of type Actor Modifier and Type Method Description voidAbstractFileSystemSearchlet. setFlowContext(Actor value)Sets the flow context.voidMultiSearch. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.source.valuedefinition
Fields in adams.flow.source.valuedefinition declared as Actor Modifier and Type Field Description protected ActorAbstractValueDefinition. m_FlowContextthe flow context.Methods in adams.flow.source.valuedefinition that return Actor Modifier and Type Method Description ActorAbstractValueDefinition. getFlowContext()Returns the flow context, if any.Methods in adams.flow.source.valuedefinition with parameters of type Actor Modifier and Type Method Description voidAbstractValueDefinition. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.standalone
Classes in adams.flow.standalone with type parameters of type Actor Modifier and Type Class Description classAbstractMutableStandaloneGroupItem<T extends Actor>Ancestor for group items that can contain other actors.classAbstractStandaloneGroup<T extends Actor>Ancestor for fixed-sized groups.classAbstractStandaloneGroupItemGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneGroupItemGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneGroupItemMutableGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneGroupItemMutableGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneMutableGroup<T extends Actor>Ancestor for mutable groups of standalones.interfaceStandaloneGroup<T extends Actor>Interface for a group of standalones.interfaceStandaloneGroupItem<T extends Actor>The element of a standalone group.interfaceStandaloneMutableGroup<T extends Actor>Interface for a mutable group of standalones.Subinterfaces of Actor in adams.flow.standalone Modifier and Type Interface Description interfaceAbstractDatabaseConnectionProviderInterface for database connection providers.interfaceDatabaseConnectionProviderInterface for database connection providers.interfaceStandaloneGroup<T extends Actor>Interface for a group of standalones.interfaceStandaloneGroupItem<T extends Actor>The element of a standalone group.interfaceStandaloneMutableGroup<T extends Actor>Interface for a mutable group of standalones.Classes in adams.flow.standalone that implement Actor Modifier and Type Class Description classAbstractCallableDatabaseConnectionAncestor for callable database connection standalones.classAbstractDatabaseCheckAncestor for standalone actors that check project-specific database connections.classAbstractDatabaseConnectionAncestor for standalone actors providing a database connection different from the system-wide one.classAbstractDbStandaloneAncestor for standalones that use the database.classAbstractMultiViewAncestor for graphical actors that display multiple views.static classAbstractMultiView.ViewWrapperA wrapper for the actual actors.classAbstractMutableActorDaemonEvent<E,P>Ancestor for daemon events that handle sub-actors.classAbstractMutableStandaloneGroupItem<T extends Actor>Ancestor for group items that can contain other actors.classAbstractScriptAncestor for singleton script actors.classAbstractStandaloneAncestor for all flow items that neither generate nor process tokens.classAbstractStandaloneGroup<T extends Actor>Ancestor for fixed-sized groups.classAbstractStandaloneGroupItem<T extends StandaloneGroup>Ancestor of a standalone group item.classAbstractStandaloneGroupItemGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneGroupItemMutableGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneMutableGroup<T extends Actor>Ancestor for mutable groups of standalones.classAutogeneratedStandaloneContainer for auto-generated standalone actors.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classCallableActorsContainer for actors that need to be accessed via their name.classCallableDatabaseConnectionReferences a database connection provider of type adams.flow.standalone.DatabaseConnectionProvider.classConditionalStandalonesExecutes the sub-actors only when the boolean condition evaluates to 'true'.classConsoleWindowDisplays the messages that are output in the system's 'Console window'.classCopyCallableStandaloneExecutes the copied callable standalone.classCounterInitCreates an empty counter in internal storage under the specified name.classCronExecutes an actor according to a pre-defined schedule.
Note: since the actor merely starts the cron scheduler in the background, the actor finishes the execution pretty much immediately.classDatabaseCheckFirst, the actor checks whether the connection to the database is established.classDatabaseConnectionFor initializing an ADAMS database connection that differs from the system-wide one.classDelayedEventExecutes its sub-flow after a predefined number of milli-seconds.classDeleteDirDeletes the dirs that match the regular expression below the specified directory.classDeleteFileDeletes the files that match the regular expression below the specified directory.classDeleteStorageValueRemoves the specified value (or the ones that match the regular expression) from temporary storage.
By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.classDeleteVariableRemoves a variable by name or the variables that match the regular expression.classDeserializeToStorageDeserializes a model from a file with the specified object reader and stores it directly in storage.
It is also possible to define multiple storage name / file name pairs, to make the deserialization of large amounts of files more efficient.classDirWatchclassEventsContainer for event actors.classExecSQLExecutes a SQL statement, which does not return a result set, like INSERT, UPDATE, DELETE, CREATE.classExternalFlowAllows to execute a complete external Flow rather than just an external actor.classExternalStandaloneStandalone that executes an external standalone actor stored on disk.
For executing whole flows, use the adams.flow.standalone.ExternalFlow standalone actor instead.
See also:
adams.flow.standalone.ExternalFlow
classFTPConnectionProvides access to a FTP host.
If debugging is enabled, the FTP commands issued by other actors will get printed as debug output of this actor.classGridViewDisplays multiple graphical actors in a grid.classGroovyA standalone that executes a Groovy script.classHashSetInitCreates an empty hashset in internal storage under the specified name.
Initial string values can be supplied as well, which can be transformed using the specified conversion.
See also:
adams.flow.transformer.HashSetInit
adams.flow.transformer.HashSetAdd
adams.flow.source.HashSet
adams.flow.condition.bool.HashSet
classInactiveStandaloneContainer for inactive standalone actors.
Can be activated with the adams.flow.processor.ReactivateActors processor.classIncludeExternalStandaloneIncludes an external standalone.classInitPublishSubscribeInitializes a publish/subscribe data structure in internal storage.classInitStorageCacheAdds a LRU cache in the responsible storage handler (usually the Flow actor).classJavaCalls the main method of a Java class.classJavaExecForks off a new JVM with the same classpath by default.classJobRunnerInstanceActs as job execution pool for classes implementing adams.multiprocess.JobRunnerSupporter.
See also:
adams.multiprocess.JobRunnerSupporter
classJobRunnerSetupDefines the job runner setup to use for parallel/distributed computation.classLogEventListens to the global log record handler and processes records that passed the specified filter(s).
This allows, for instance, the output of log messages into a log file.
By default, log records are only processed if the sub-actors are not currently being executed.classLookUpInitInitializes an empty look up table in storage.
See also:
adams.flow.transformer.LookUpAdd
classMakeDirCreates the user-supplied directory if not already existing.classMemoryMonitorMonitors the memory (used/committed heap vs maximum heap).Every number of seconds ('sampleInterval'), the memory consumption, i.e., 'heap used', is sampled, keeping the specified number of latest samples ('numSamples').
Once the specified number of samples have been reached, it is checked whether the specified percentage of samples ('coverage') reaches or exceeds the threshold percentage of the maximum heap has been exceeded ('threshold').classNullDummy standalone, does nothing.classPyroNameServerDefines the Pyro nameserver to use.classPyroStandaloneTransforms data using a Pyro4 call
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
classPythonEnvironmentDefines what Python executables to use within this context.
On Linux, you can enforce using the system-wide Python 3 executables by supplying '3' as suffix, which gets appended to the executables.classQueueEventExecutes its sub-flow after a predefined number of milli-seconds.classQueueInitCreates an empty queue in internal storage under the specified name.classRegisterFlowSimply registers the flow with the running flows registry.classRemoteScriptingEngineStarts/stops a scripting engine for remote commands.classScriptedA standalone that executes an external script.classSetManyVariablesSets the values of the variables.
Optionally, the specified values can be expanded, in case it is made up of variables itself.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
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) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (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.classSetPropertyDeprecated.classSetVariableSets the value of a variable.
Optionally, the specified value can be expanded, in case it is made up of variables itself.
It is also possible to override the variable value with the value obtained from an environment variable.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
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) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (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.classSMBConnectionProvides access to a remote host via SMB.classSMTPConnectionSMTP server setup for overriding default parameters.classSSHConnectionProvides access to a remote host via SSH.
For more information see:
(2011).classStandalonesContainer for standalone actors.classStopwatchStops the execution time of the flow, till either the user stops the flow or the flow finishes by itself
Valid options are:classTableCleanUpRuns a table cleaner.classTabViewDisplays multiple graphical actors in a tabbed pane.classTemplateStandaloneGenerates a standalone actor/sub-flow from a template.classTesseractConfigurationSetup parameters for tesseract.
For more information see:
https://github.com/tesseract-ocr/tesseract
Valid options are:classToolRuns a tool.classVariableChangedEventListens to a any changes to the specified variable.
This allows, for instance, the monitoring of a variable.
Enable the 'noDiscard' property to process all change events - NB: this can slow down the system significantly.classWeakExternalStandaloneclassWebSocketServerStarts and runs a websocket server.Fields in adams.flow.standalone declared as Actor Modifier and Type Field Description protected ActorExternalFlow. m_ExternalFlowthe external flow itself.protected ActorQueueInit. m_LogActorthe log actor.protected ActorQueueInit. m_MonitorActorthe monitor actor.protected ActorJavaExec. m_StdErrthe stderr actor.protected ActorJavaExec. m_StdOutthe stdout actor.Fields in adams.flow.standalone with type parameters of type Actor Modifier and Type Field Description protected List<Actor>AbstractMultiView. m_Actorsthe underlying display actors.protected List<Actor>Events. m_Actorsthe events.Methods in adams.flow.standalone with type parameters of type Actor Modifier and Type Method Description <A extends Actor>
List<A>AbstractStandaloneGroup. getActors(Class<A> actor)Returns a list of actors comprising of the requested actor type (exact match).<A extends Actor>
List<A>AbstractStandaloneGroup. getActorsBelow(Class parent, Class<A> actor)Returns a list of actors comprising of the requested actor type (exact match).Methods in adams.flow.standalone that return Actor Modifier and Type Method Description protected ActorEvents. checkActor(Actor actor)Checks whether the actor is valid, throws an execption if not.ActorAbstractStandaloneGroup. find(String name)Finds the actor with the specified name recursively.protected ActorAbstractCallableDatabaseConnection. findCallableActor()Tries to find the callable actor referenced by its name.protected ActorQueueInit. findCallableActor(CallableActorReference name)Tries to find the callable actor referenced by its callable name.ActorAbstractMultiView. firstActive()Returns the first non-skipped actor.ActorAbstractMutableActorDaemonEvent. firstActive()Returns the first non-skipped actor.ActorAbstractStandaloneGroup. firstActive()Returns the first non-skipped actor.ActorCron. firstActive()Returns the first non-skipped actor.ActorDelayedEvent. firstActive()Returns the first non-skipped actor.ActorQueueEvent. firstActive()Returns the first non-skipped actor.ActorAbstractMultiView. get(int index)Returns the actor at the given position.ActorAbstractMutableActorDaemonEvent. get(int index)Returns the actor at the given position.ActorAbstractMutableStandaloneGroupItem. get(int index)Returns the actor at the given position.ActorAbstractStandaloneGroup. get(int index)Returns the actor at the given position.ActorCron. get(int index)Returns the actor at the given position.ActorDelayedEvent. get(int index)Returns the actor at the given position.ActorEvents. get(int index)Returns the actor at the given position.ActorJavaExec. get(int index)Returns the actor at the given position.ActorQueueEvent. get(int index)Returns the actor at the given position.Actor[]AbstractMultiView. getActors()Returns the panel providers.Actor[]AbstractMutableActorDaemonEvent. getActors()Returns the actors to execute on schedule.Actor[]AbstractMutableStandaloneGroupItem. getActors()Returns the sub actors.protected Actor[]AbstractStandaloneGroup. getActors()Returns the actors to use.Actor[]DelayedEvent. getActors()Returns the actors to execute on schedule.Actor[]Events. getActors()Returns the flow items of this sequence.Actor[]QueueEvent. getActors()Returns the actors to execute on schedule.ActorQueueInit. getCallableActor()Returns the currently set callable actor.Actor[]Cron. getCronActors()Returns the actors to execute on schedule.protected ActorCopyCallableStandalone. getDefaultActor()Returns the default actor if the callable actor is optional and not found.ActorJavaExec. getStdErr()Returns the actor for further processing the stderr output (string).ActorJavaExec. getStdOut()Returns the actor for further processing the stdout output (string).ActorAbstractMultiView.ViewWrapper. getWrapped()Returns the wrapped actor.ActorAbstractMultiView. lastActive()Returns the last non-skipped actor.ActorAbstractMutableActorDaemonEvent. lastActive()Returns the last non-skipped actor.ActorAbstractStandaloneGroup. lastActive()Returns the last non-skipped actor.ActorCron. lastActive()Returns the last non-skipped actor.ActorDelayedEvent. lastActive()Returns the last non-skipped actor.ActorQueueEvent. lastActive()Returns the last non-skipped actor.ActorAbstractMultiView. remove(int index)Removes the actor at the given position and returns the removed object.ActorAbstractMutableActorDaemonEvent. remove(int index)Removes the actor at the given position and returns the removed object.ActorAbstractMutableStandaloneGroupItem. remove(int index)Removes the actor at the given position and returns the removed object.ActorAbstractStandaloneMutableGroup. remove(int index)Removes the actor at the given position and returns the removed object.ActorCron. remove(int index)Removes the actor at the given position and returns the removed object.ActorDelayedEvent. remove(int index)Removes the actor at the given position and returns the removed object.ActorEvents. remove(int index)Removes the actor at the given position and returns the removed object.ActorQueueEvent. remove(int index)Removes the actor at the given position and returns the removed object.Methods in adams.flow.standalone with parameters of type Actor Modifier and Type Method Description StringAbstractMultiView. add(int index, Actor actor)Inserts the actor at the given position.StringAbstractMultiView. add(Actor actor)Inserts the actor at the end.StringAbstractMutableActorDaemonEvent. add(int index, Actor actor)Inserts the actor at the given position.StringAbstractMutableActorDaemonEvent. add(Actor actor)Inserts the actor at the end.StringAbstractMutableStandaloneGroupItem. add(int index, Actor actor)Inserts the actor at the given position.StringAbstractMutableStandaloneGroupItem. add(Actor actor)Inserts the actor at the end.StringAbstractStandaloneMutableGroup. add(int index, Actor actor)Inserts the actor at the given position.StringAbstractStandaloneMutableGroup. add(Actor actor)Inserts the actor at the end.StringCron. add(int index, Actor actor)Inserts the actor at the given position.StringCron. add(Actor actor)Inserts the actor at the end.StringDelayedEvent. add(int index, Actor actor)Inserts the actor at the given position.StringDelayedEvent. add(Actor actor)Inserts the actor at the end.StringEvents. add(int index, Actor actor)Inserts the actor at the given position.StringEvents. add(Actor actor)Inserts the actor at the end.StringQueueEvent. add(int index, Actor actor)Inserts the actor at the given position.StringQueueEvent. add(Actor actor)Inserts the actor at the end.abstract voidAbstractMultiView. addPanel(Actor actor, BasePanel panel)Replaces the current dummy panel with the actual panel.voidGridView. addPanel(Actor actor, BasePanel panel)Replaces the current dummy panel with the actual panel.voidTabView. addPanel(Actor actor, BasePanel panel)Replaces the current dummy panel with the actual panel.protected StringAbstractMultiView. check(Actor actor)Checks whether the actor is valid.protected StringAbstractStandaloneGroup. checkActor(Actor actor)Checks the actor whether it is of the correct type.protected StringAbstractStandaloneGroup. checkActor(Actor actor, int index)Checks the actor whether it is of the correct type.protected ActorEvents. checkActor(Actor actor)Checks whether the actor is valid, throws an execption if not.protected abstract StringAbstractMutableActorDaemonEvent. checkActors(Actor[] actors)Checks the actors before they are set via the setActors method.protected StringAbstractStandaloneGroup. checkActors(Actor[] actors)Checks the actors whether they are of the correct type.protected StringDelayedEvent. checkActors(Actor[] actors)Checks the cron actors before they are set via the setActors method.protected StringDirWatch. checkActors(Actor[] actors)Checks the actors before they are set via the setActors method.protected StringLogEvent. checkActors(Actor[] actors)Checks the actors before they are set via the setActors method.protected StringQueueEvent. checkActors(Actor[] actors)Checks the cron actors before they are set via the setActors method.protected StringVariableChangedEvent. checkActors(Actor[] actors)Checks the actors before they are set via the setActors method.protected StringCopyCallableStandalone. checkCallableActor(Actor actor)Performs checks on the callable actor.protected StringCron. checkCronActors(Actor[] actors)Checks the cron actors before they are set via the setCronActors method.protected StringIncludeExternalStandalone. checkExternalActor(Actor actor)Performs checks on the external actor.protected StringAbstractMutableStandaloneGroupItem. checkSubActor(int index, Actor actor)Checks the sub actor before it is set.protected StringAbstractMutableStandaloneGroupItem. checkSubActors(Actor[] actors)Checks the sub actors before they are set via the setSubActors method.static JobRunnerInstanceJobRunnerInstance. locate(Actor source)Tries to locate a JobRunnerInstance actor.static JobRunnerInstanceJobRunnerInstance. locate(Actor source, boolean warn)Tries to locate a JobRunnerInstance actor.StringAbstractMultiView. set(int index, Actor actor)Sets the actor at the given position.StringAbstractMutableActorDaemonEvent. set(int index, Actor actor)Sets the actor at the given position.StringAbstractMutableStandaloneGroupItem. set(int index, Actor actor)Sets the actor at the given position.StringAbstractStandaloneGroup. set(int index, Actor actor)Sets the actor at the given position.StringCron. set(int index, Actor actor)Sets the actor at the given position.StringDelayedEvent. set(int index, Actor actor)Sets the actor at the given position.StringEvents. set(int index, Actor actor)Sets the actor at the given position.StringJavaExec. set(int index, Actor actor)Sets the actor at the given position.StringQueueEvent. set(int index, Actor actor)Sets the actor at the given position.voidAbstractMultiView. setActors(Actor[] value)Sets the panel providers.voidAbstractMutableActorDaemonEvent. setActors(Actor[] value)Sets the actors to execute on schedule.voidAbstractMutableStandaloneGroupItem. setActors(Actor[] value)Sets the sub-actor.protected voidAbstractStandaloneGroup. setActors(Actor[] value)Sets the actors to use.voidDelayedEvent. setActors(Actor[] value)Sets the actors to execute on schedule.voidEvents. setActors(Actor[] value)Sets the flow items for this sequence.voidQueueEvent. setActors(Actor[] value)Sets the actors to execute on schedule.voidCron. setCronActors(Actor[] value)Sets the actors to execute on schedule.voidAbstractStandaloneGroup. setParent(Actor value)Sets the parent of this actor, e.g., the group it belongs to.voidJavaExec. setStdErr(Actor value)Sets the actor for further processing the stderr output (string).voidJavaExec. setStdOut(Actor value)Sets the actor for further processing the stdout output (string).voidAbstractMultiView.ViewWrapper. setWrapped(Actor value)Sets the actor to wrap.Constructors in adams.flow.standalone with parameters of type Actor Constructor Description AutogeneratedStandalone(Actor actor)Encapsulates the specified actor.AutogeneratedStandalone(Actor[] actors)Encapsulates the specified actors.InactiveStandalone(Actor actor)Encapsulates the specified actor.InactiveStandalone(Actor[] actors)Encapsulates the specified actors. -
Uses of Actor in adams.flow.template
Subinterfaces of Actor in adams.flow.template Modifier and Type Interface Description interfaceActorTemplateUserInterface for actors that make use for actor templates.Methods in adams.flow.template that return Actor Modifier and Type Method Description protected abstract ActorAbstractActorTemplate. doGenerate()Generates the actor.protected ActorAbstractScriptedTemplate. doGenerate()Generates the actor.protected ActorDummySink. doGenerate()Generates the actor.protected ActorDummySource. doGenerate()Generates the actor.protected ActorDummyStandalone. doGenerate()Generates the actor.protected ActorDummyTransformer. doGenerate()Generates the actor.protected ActorEndlessLoop. doGenerate()Generates the actor.protected ActorFileProcessingWithProgressBar. doGenerate()Generates the actor.protected ActorFromFile. doGenerate()Generates the actor.protected ActorInstanceDumperVariable. doGenerate()Generates the actor.protected ActorIterateFilesWithProgressBar. doGenerate()Generates the actor.protected ActorOptionTraverser. doGenerate()Generates the actor.protected ActorProgressInConsole. doGenerate()Generates the actor.protected ActorPromptUser. doGenerate()Generates the actor.protected ActorSimpleMenu. doGenerate()Generates the actor.protected ActorStoreFilenameInVariable. doGenerate()Generates the actor.protected ActorStoreReportValueInVariable. doGenerate()Generates the actor.protected ActorStringReplace. doGenerate()Generates the actor.protected ActorUpdateVariable. doGenerate()Generates the actor.protected abstract ActorAbstractScriptedTemplate. executeScript()Executes the script to generate the actor.protected ActorGroovy. executeScript()Executes the script to generate the actor.protected ActorScripted. executeScript()Executes the script to generate the actor.ActorAbstractActorTemplate. generate()Returns the generated actor.protected ActorAbstractActorTemplate. postGenerate(Actor actor)Hook before generating the actor.Methods in adams.flow.template with parameters of type Actor Modifier and Type Method Description protected ActorAbstractActorTemplate. postGenerate(Actor actor)Hook before generating the actor. -
Uses of Actor in adams.flow.transformer
Subinterfaces of Actor in adams.flow.transformer Modifier and Type Interface Description interfaceDataContainerDbReader<T extends DataContainer>Interface for actors that read containers from the database.interfaceDataContainerDbWriter<T extends DataContainer & DatabaseIDHandler>Interface for actors that import data containers into the database.interfaceFeatureGenerator<T>General interface for feature generating actors.interfaceSpreadSheetMergeActorIndicator interface for actors that merge spreadsheets.interfaceWekaMergeInstancesActorInterface for transformers that merge Weka Instances.Classes in adams.flow.transformer that implement Actor Modifier and Type Class Description classAbstractArrayProviderAncestor for transformer actors that can output items one by one or as a single array.classAbstractCallableWekaClassifierEvaluatorAncestor for classifier evaluators that make use of a callable classifier.classAbstractCallableWekaClustererEvaluatorAncestor for clusterer evaluators that make use of a callable clusterer.classAbstractContainerValueExtractorAncestor for transformers that extract values from a container.classAbstractDataContainerAdd<T extends DataContainer>Ancestor for transformers that superimpose the incoming data container on one available from storage (or if not available, put the current one in storage) and forward the combined data container.classAbstractDataContainerAppend<T extends DataContainer>Ancestor for transformers that append the incoming data container to one available from storage (or if not available, put the current one in storage) and forward the combined data container.classAbstractDataContainerDbReader<T extends DataContainer>Ancestor for transformers that read containers from the database.classAbstractDataContainerDbWriter<T extends DataContainer & DatabaseIDHandler>Abstract ancestor for actors that import data containers into the database.classAbstractDataContainerFileImport<T extends DataContainer>Abstract ancestor for actors that import data containers.classAbstractDataContainerFileReader<T extends DataContainer>Abstract ancestor for actors that read data containers from disk.classAbstractDataContainerFileWriter<T extends DataContainer>Abstract ancestor for transformer actors that write data containers to disk.classAbstractDataContainerTransformerAncestor for actors that transform data containers.classAbstractDataProcessorAbstract ancestor for classes that process data on disk.classAbstractDbArrayProviderAncestor for array providers that use the database.classAbstractDbDataProcessorAbstract ancestor for data processors that use a database.classAbstractDbTransformerAbstract ancestor for transformers that query a database.classAbstractDeleteDataContainer<T extends DataContainer>Ancestor for transformers that delete containers from the database.classAbstractDeleteDbReportValue<T extends Report>Ancestor for transformers that delete values from a report in the database whenever a token passes through.classAbstractDeleteReportValueAncestor for transformers that delete values from a report.classAbstractDeleteReportValueByExpressionAncestor for transformers that delete field/value from a report if the boolean expression evaluates to true.classAbstractFilterAncestor for domain-specific filter transformers.classAbstractGetReportValueAncestor for transformers that retrieve a value from a report.classAbstractInPlaceSpreadSheetTransformerAncestor for spreadsheet transformers that allow the processing to happen in-place, rather than on a copy of the data.classAbstractInstanceGenerator<T extends DataContainer>Ancestor for transformers that turn data containers into WEKA Instance objects.classAbstractInteractiveTransformerAncestor for transformers that interact with the user.classAbstractInteractiveTransformerDialogAncestor for graphical actors that are interactive.classAbstractMultiCompressAbstract ancestor for compression algorithms that allow the compression of multiple files (incl directory structure).classAbstractMultiDecompressAncestor for compression schemes that manage archives with multiple files (incl directory structure) like zip archives.classAbstractProcessWekaInstanceWithModel<T>Ancestor for transformers that user models for processing Instance objects, e.g., classifiers making predictions.classAbstractReportDbReader<T extends Report,I>Abstract ancestor for actors that load reports from the database.classAbstractReportDbUpdaterAncestor for transformers that updateReportobjects or reports that are part of aMutableReportHandlerobject.classAbstractReportDbWriter<T extends Report,I>Abstract ancestor for actors that write reports to the database.classAbstractReportDbWriterByDBID<T extends Report>Abstract ancestor for actors that write reports to the database.classAbstractReportDbWriterByID<T extends Report>Abstract ancestor for actors that write reports to the database.classAbstractReportFileImport<T extends Report>Abstract ancestor for report import actors.classAbstractReportFileReader<T extends Report>Abstract ancestor for report file reader transformers.classAbstractReportFileWriter<T extends Report>Abstract ancestor for actors that write reports to disk.classAbstractReportValueDbWriter<T extends Report>Abstract ancestor for actors that write report values to the database.classAbstractScriptAncestor for transformer script actors.classAbstractSetReportValueAncestor for transformers that update the value of field in a report.classAbstractSingleCompressAncestor for compression algorithms that only take a single file, like gzip.classAbstractSingleDecompressAncestor for decompression algorithms that only work with archives that consists of a single file, like gunzip.classAbstractSpreadSheetTransformerAncestor for transformers that work on spreadsheets and also output spreadsheets again.classAbstractStringOperationAncestor for transformers that perform operations on strings.classAbstractTransformerAncestor for all flow items that process an input token and generate an output token.classAbstractTransformerWithPropertiesUpdatingAncestor for transformers that allow changing the object's properties using variables.classAbstractWekaClassifierEvaluatorAncestor for transformers that evaluate classifiers.classAbstractWekaModelReaderAncestor for actors that deserialize models.classAbstractWekaPredictionsTransformerAncestor for transformers that convert the predictions stored in an Evaluation object into a different format.classAccessDatabaseInfoOutputs information on a MS Access database.classAddDOMAttributeAdds a new attribute to the incoming org.w3c.dom.Node and forwards the new updated node.classAddDOMNodeAdds a new node below the incoming org.w3c.dom.Node and forwards the new node.
In case of an incoming org.w3c.dom.Document, the node gets added below the root node.classAddNoteAdds a note to the notes handler passing through.
Pre-defined note types:
- ERROR:
- WARNING:
- PROCESS INFORMATION
Input/output:
- accepts:
adams.data.NotesHandler
- generates:
adams.data.NotesHandler
classAppendNameAppends the suffix to the file/directory being passed through.
By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and suffix.classArrayCombinationsTurns an array of any type into a sequence of array combinations of given size.classArrayHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming double array or matrix.
In case of an array, the data-type and location are ignored.classArrayLengthDetermines the length of an array.classArrayReverseReverses the order of the elements in the array.classArrayStatisticGenerates statistics from a double array or matrix.classArraySubsetGenerates a subset of the array, using the specified array elements.classArraySubsetGenerationclassArrayToChunksSplits an array into chunks of a specified size.classArrayToCollectionTurns an array into a collection.classArrayToSequenceTurns an array of any type into a sequence of tokens.classArrayToVariablesclassAutogeneratedTransformerEncapsulates a sequence of auto-generated actors.classBaseNameExtracts the name of the file/directory passing through, i.e., any preceding directory gets stripped.classBinaryFileReaderReads a binary file and forwards the content byte by byte or as byte array.classBoofCVDetectLinesDetects lines in images (Hough line detector based on polar parametrization).classBoofCVDetectLineSegmentsDetects line segments in images (line RANSAC).classBoofCVFeatureGeneratorApplies a BoofCV feature generator to the incoming image and outputs the generated features.classBoofCVMultiImageOperationApplies a BoofCV multi-image operation to the incoming image(s) and outputs the generated image(s).classBoofCVTransformerApplies a BoofCV transformation to the incoming image and outputs the generated image(s).classBufferedImageFeatureGeneratorApplies an JAI flattener to the incoming image and outputs the generated features.classBufferedImageMultiImageOperationApplies a BufferedImage multi-image operation to the incoming image(s) and outputs the generated image(s).classBufferedImageTransformerApplies a BufferedImage transformation to the incoming image and outputs the generated image(s).classBzip2Creates a bzip2 archive from a single file.classCallableTransformerFeeds tokens into a callable transformer and broadcasts the generated output tokens.classChangeImageObjectPrefixUses the specified object finder to locate objects and then applies the object filter to the located objects.classChangeReportFieldPrefixesReplaces the specified old prefixes with the new one.classClassSelectorSets (or unsets) the class index/indices.classCollectionAppendAppends the elements of the incoming collection to the one in storage.
If there is none in storage yet, a copy of the incoming collection will simply get stored in storage.
The combined collection is then forwarded.classCollectionInsertInserts an object in the collection using the specified position.
The object can be retrieved from a callable actor or from storage.
If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.
See also:
adams.flow.transformer.StorageCollectionInsert
Input/output:
- accepts:
java.util.Collection
- generates:
java.util.Collection
classCollectionSizeclassCollectionSubsetGenerates a subset of the collection, using the specified elements.classCollectionToArrayTurns a collection of any type into an array.classCollectionToSequenceTurns a collection of any type into a sequence of tokens.classColorProviderOutputs a color for each token passing through.
If the color provider implements adams.gui.visualization.core.ColorProviderWithNameSupport then the color associated with the incoming string token is forwarded.
The color provider can be reset using the specified variable.classCompareObjectLocationsVisualizes object locations (annotations and predicted) for the incoming image side-by-side.
Only forwards the image container when accepted.classCompareObjectsCompares two objects using the specified compare algorithm and forwards the output of the comparison.classCompareObjectTypesCompares the object types between objects from the two reports.
The first report is considered 'ground truth'.classConfirmationDialogPops up a confirmation dialog, prompting the user to select 'yes', 'no' or 'cancel'.
If no custom tokens are used, the current token is only forwarded when the user selects 'yes'.classConfusionMatrixGenerates a confusion matrix from the specified actual and predicted columns containing class labels.
Can take a probability column (of prediction) into account for generating weighted counts.classContainerToStorageExtracts the specified values from the container passing through and makes them available as storage items.classContainerToVariablesExtracts the specified values from the container passing through and makes them available as variables.classControlChartApplies a control chart algorithm to the data.classConvertConverts data from one format into another.classConvertFeaturesTurns the raw features generated by a feature converter (stored in a adams.flow.container.FeatureConverterContainer) into a specific format using the user-defined feature converter.
If an array of containers is received, the get merged first, i.e., placed side-by-side.classCopyCreates copies of the tokens being passed through.classCopyCallableTransformerFeeds tokens into the copy of a callable transformer and broadcasts the generated output tokens.classCopyFileCopies the file received on its input port to the target directory if it matches the provided regular expression.
In case of a directory, the directory gets copied recursively.
If required, you can also provide a new filename (just the name, no path).
The generated target file/directory gets forwarded in the flow.classCopyToClipboardCopies the data in this token to the system's clipboard using the specified clipboard manager.classCounterAddPasses a value through the specified counter.classCounterInitCreates a counter from a column in a spreadsheet or an array.classCountObjectsInRegionCounts the objects in the report passing through that fall into the defined region.
Partial hits can be counted as well, using their percentage in overlap as count.classCreateEmailActor for creating emails to be sent.classDatasetFilterApplies the batch filter to the dataset.classDatasetRowFilterApplies the stream filter to the rows.classDateTimeTypeDifferenceComputes the difference between the two date/time types of the incoming array (of length 2) by subtracting the second element from the first one.classDecodeBarcodeDecodes the data in a barcode using the specified decoder.classDeleteFileDeletes the file/directory received on its input port if it matches the provided regular expression.
In case of directories, deletion is performed recursively (if a directory matches, then the content gets deleted regardless whether it matches the regular expression or not).classDeleteJsonValueclassDeleteMapValueDeletes the specified key/value pair from the map passing through.classDeleteOverlappingImageObjectsCleans up overlapping objects, e.g., multiple predicted bounding boxes per object.classDeletePropertyValueDeletes the specified property from the Properties object passing through.classDeleteReportValueDeletes values from a report.classDeleteReportValueByExpressionclassDeleteStorageValueRemoves the specified value (or the ones that match the regular expression) from temporary storage whenever a token passes through.
By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.classDeleteVariableRemoves a variable by name or the variables that match the regular expression.classDeserializeDeserializes a previously serialized Java object from a file.classDetermineOverlappingAreasclassDetermineOverlappingObjectsComputes the overlap of objects with the specified report from storage (or itself) using the specified algorithm.classDiffCompares two files or two string arrays and generates a diff representation.
In case of BRIEF, the output is whether the two files/arrays are different.classDirNameExtracts the directory part of the file/directory passing through, i.e., any trailing name part gets stripped.
See also:
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.RelativeDir
adams.flow.transformer.BaseName
adams.flow.transformer.FileExtension
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
classDownloadContentDownloads the raw, textual content from a URL and forwards it.Also handles basic authentication when using URLs like this:
http://user:pass@domain.com/url
Input/output:
- accepts:
java.lang.String
adams.core.base.BaseURL
java.net.URL
- generates:
java.lang.String
classDrawPerforms a draw operation on an image.classEmailFileReaderReads email(s) from a file.classExecuteActorExecutes the actor passing through and forwards it once finished.
If the actor is an instance of adams.flow.execution.FlowExecutionListeningSupporter and flow execution listening enabled, then the specified flow execution listener gets attached.classExecuteJobsExecutes the incoming jobs.classExecuteRemoteCommandExecutes the incoming commands.classExifTagOperationPerforms the specified EXIF operation on the incoming data.classExpandStorageExpands all the storage items (using their string representation) and variables in the string(s) passing through.
A string can consist of arbitrary strings and the following special placeholders:
- variables: @{...}
- storage placeholders: %{...}
Input/output:
- accepts:
java.lang.String
java.lang.String[]
- generates:
java.lang.String
java.lang.String[]
classExpandVariablesExpands all the variables in the string(s) passing through.A string can consist of arbitrary strings and the following special placeholder for variables:
@{...}
Input/output:
- accepts:
java.lang.String
java.lang.String[]
- generates:
java.lang.String
java.lang.String[]
classExternalTransformerTransformer that executes an external transformer actor stored on disk.classFileChangedChecks whether the input file has changed using the specified monitor.
Must be initialized once with the same file.classFileExtensionExtracts the file extension from the file (the part after the '.').
If no dot is in the file name, then an empty string gets forwarded.
See also:
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.RelativeDir
adams.flow.transformer.DirName
adams.flow.transformer.BaseName
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
classFileInfoOutputs information for a path (file/directory).classFilenameGeneratorPasses the incoming token through the generator to generate and forward a filename.
See also:
adams.flow.source.FilenameGenerator
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
java.lang.String
classFileTailerMonitors a text file for data being appended, e.g., log files.classFilterMapApplies the specified filter to the map object passing through.classFindInFileSearches the incoming (text) file for the specified search string, output the boolean search result.classFlowFileReaderReads the flow file and outputs the actor(s).
A custom reader can be specified in case of reading from files, but must be specified when reading from java.io.Reader or java.io.InputStream objects.classFTPDeleteDeletes a remote file and forwards the file name.classFTPDisconnectCloses the currently open FTP session.
Simply passes through any tokens.classFTPGetDownloads a remote file and forwards the local file name.classFTPNoOpSends a NOOP command to the FTP server whenever a token passes through.classFTPSendUploads a file to a remote directory.
The file name of a successful upload gets forwarded.classGenerateFileBasedDatasetApplies the specified generator to the incoming dataset container.
See also:
adams.flow.control.SetContainerValue
adams.flow.transformer.PrepareFileBasedDataset
Input/output:
- accepts:
adams.flow.container.FileBasedDatasetContainer
- generates:
java.lang.String
Container information:
- adams.flow.container.FileBasedDatasetContainer: Train, Test, Validation, Negative
classGetArrayElementPicks an element from an array and forwards only this element.classGetDatabaseIDReturns the database ID of the database ID handler passing through.classGetIDReturns the ID of the ID handler passing through.classGetImageObjectIndicesUses the specified object finder to locate objects and forwards the indices.classGetImageObjectMetaDataRetrieves the meta-data of the incoming adams.flow.transformer.locateobjects.LocatedObject object.classGetImageObjectsUses the specified object finder to locate objects and forwards the objects.classGetJsonKeysOutputs all the keys of the JSON Object passing through.classGetJsonValueObtains the value associated with the specified key from the JSON object passing through.
Null values are only forwarded if requested.classGetListElementPicks an element from a list and forwards only this element.classGetMapKeysForwards all the sorted (string) keys of the map.classGetMapValueObtains the value associated with the specified key from Map object received as input and forwards it.classGetNotesReturns the notes of the notes handler passing through.classGetObjectPropertyRetrieves a value from an object's property using a bean property path.
A bean property consists usually of a get and set method, e.g.:
- setDebug(boolean)
- boolean getDebug()
The property name for this pair is:
debug
Input/output:
- accepts:
java.lang.Object
- generates:
adams.flow.core.Unknown
classGetPropertiesOutputs the names of all Java Bean properties of the incoming object.classGetPropertyObtains the current property value of the object passing through.classGetPropertyNamesOutputs all the keys of the properties object passing through.classGetPropertyValueObtains the value(s) associated with the keys that match the specified regular expression from the Properties object passing through.
Null values are only forwarded if requested.classGetRemoteCommandPayloadReturns the underlying payload objects (if any) from the incoming remote command.
Depending on request/response flag, it outputs the corresponding payload objects.
Does not forward anything if the array is empty.classGetReportReturns the report of the report handler passing through.classGetReportValueRetrieves a value from a report.classGetStorageValueRetrieves a value from internal storage using the incoming string token as name.classGroovyA transformer that uses a Groovy script for processing the token(s).classGroupByRegExpGroups the incoming strings into sub-groups.classGUNZIPDecompresses an archive that was compressed with gzip.classGZIPCreates a GZIP archive from a single file.classHashSetAddAdds a value to the specified hashset.classHashSetInitCreates a hashset from a column in a spreadsheet or an array.classHashSetRemoveRemoves a value from the specified hashset.classHexReplaceAllows to find and replace characters in hex notation.classHttpPostFileUploads the incoming file via HTTP POST to the specified URL as 'multipart/form-data'.
Additional form fields can be supplied as well.classHttpRequestSends the incoming text/bytes payload to the specified URL (with optional HTTP headers) and forwards the retrieved HTML as text.classIDGeneratorGenerates IDs from the objects it receives on its input and forwards the generated IDs.classImageAnnotatorAllows the user to label objects located on the image and pass on this enriched meta-data.classImageFileReaderReads any file format that the specified image reader supports.
If meta-data is associated with the image, then this can be loaded as well.classImageInfoObtains information from the picture passing through.classImageLabelerAllows the user to label images, setting a report field in the meta-data.
Any logged interaction will get added as JSON under interaction-log in the report.classImageMetaDataReturns any EXIF or IPTC and basic image information as a spreadsheet.classImageObjectAnnotatorUser interface for annotating objects in images.classImageObjectFilterUses the specified object finder to locate objects and then applies the object filter to the located objects (modifies the report).classImageObjectIndexOffsetOffsets the object index.classImageObjectInfoOutputs the requested type of information for either the incoming adams.flow.transformer.locateobjects.LocatedObject or the specified image object in the report.classImageObjectOverlapComputes the overlap of objects with the specified report from storage.
It stores the overlap percentage of the highest overlap found (overlap_highest) and the total number of overlaps greater than the specified minimum (overlap_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest overlap gets stored as well (overlap_label_highest) and whether the labels match (overlap_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
classImageObjectOverlapMatrixGenerates a matrix of overlapping image objects (annotations vs predictions) and their labels.
When outputting not just overlaps, a separate column 'Overlap' is output as well, indicating whether this row represents an overlap ('yes') or not ('no')
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.spreadsheet.SpreadSheet
classImageObjectToVariablesConverts the parameters of an image object into variables.
Meta-data can be turned into variables as well.classImagePreparationPreprocesses an image.classImageSegmentationAnnotatorUser interface for annotating images for image segmentation.classImageSegmentationContainerFilterApplies a Image Segmentation container filter to the incoming container(s) and outputs the generated data.classImageSegmentationContainerOperationApplies a Image Segmentation container operation to the incoming container(s) and outputs the generated data.classImageSegmentationFileReaderReads image segmentation file formats using the specified reader and forwards a container with the data.classImageSharpnessDetermines whether images are in focus ('sharp') using the specified algorithm.classInactiveTransformerEncapsulates a sequence of inactive actors.classIncludeExternalTransformerIncludes an external transformer.classIncStorageValueIncrements the value of a storage value by either an integer or double increment.
If the storage value has not been set yet, it will get set to 0.
If the storage value contains a non-numerical value, no increment will be performed.
It is also possible to directly output the updated storage value (while discarding the input token).classIncVariableIncrements the value of a variable by either an integer or double increment.
If the variable has not been set yet, it will get set to 0.
If the variable contains a non-numerical value, no increment will be performed.
It is also possible to directly output the updated variable (while discarding the input token).classIndexedSplitsRunsEvaluationUses the specified evaluation for evaluating the incoming data.classIndexedSplitsRunsGeneratorUses the specified generator for generating indexed splits from the incoming data.classIndexedSplitsRunsPredictionsUses the specified generator for generating predictions from indexed splits for the incoming data.classIndexedSplitsRunsReaderReads indexed splits runs from disk using the specified reader.classIntersectOverUnionComputes the Intersect Over Union (IOU) of objects with the specified report from storage.
It stores the highest IOU found (iou_highest) and the total number of iou greater than the specified minimum (iou_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest iou gets stored as well (iou_label_highest) and whether the labels match (iou_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
classJsonFileReaderReads a JSON file and forwards the parsed JSON object.
If it is know beforehand, whether the JSON file contains an object or an array, the output type can be specified.classLocateObjectsLocates objects in an image and forwards an image per located object, cropped around the object.classLookUpForwards the value associated with the key that the actor gets as input, using the specified lookup table from internal storage.classLookUpAddAdds key-value pairs to the specified lookup table.
The input can either an array or a spreadsheet.
If the input is an array, it must have length 2, with the first element the key and the second one the value.classLookUpInitCreates a lookup table from a spreadsheet, using one column as key and another one as value.classLookUpRemoveRemoves a key/value pair from the specified lookup table.classLookUpUpdateUpdates the lookup table (in form of a spreadsheet) that passes through using the specified rules.
The rules can contain variables.
The rules use the following grammar:
expr_list ::= expr_list expr_part | expr_part
expr_part ::= conditional | assignment
conditional ::= if expr then assignments end
| if expr then assignments else assignments end
assignments ::= assignments assignment | assignment
assignment ::=
VARIABLE := expr;
| all ( "regexp" ) := expr;
expr ::= ( expr )
| NUMBER
| STRING
| BOOLEAN
| VARIABLE
| true
| false
| -expr
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr != expr
| not expr
| expr and expr
| expr or expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
Notes:
- Variables are either all alphanumeric and -/_ (e.g., "ABc_1-2") or any character
apart from "'" enclosed by "'" and "'" (e.g., "'Hello World'").
- The 'all' method applies the value to all the values in the lookup table
that match the regular expression.
- Variables starting with '_' are considered local and don't get transferred back out.
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.SpreadSheet
classLzfCreates a LZF archive from a single file.classLzmaCreates a LZMA (7zip) archive from a single file.classMakeDirCreates the directory accepted on the input port if not already existing.classMakeForecastPlotContainerCreates a named containers for the SequencePlotter actor using the incoming forecasts.classMakeJFreeChartDatasetGenerates a JFreeChart dataset from the incoming spreadsheet.classMakeLogEntryCreates a log entry from the incoming token.classMakePlotContainerCreates a named container for the SequencePlotter actor.
In case of Double arrays arriving at the input, they must have length 2 for X and Y, 4 for X/Y/Y-Error (low/high) or 6 X/Y/X-Error (low-high)/Y-Error (low-high).
Integer arrays can only have the length 2.
It is also possible, depending on the plotter sink setup, to use strings for x and/or y.
In order to force an update of the plot, overriding the current plot-updater setup, you can create a special plot container of type UPDATE and send that to the plot (can be triggered with a null-token, e.g., from a adams.flow.source.Start source).classMapToStorageValuesStores the map content in internal storage.
Only the map keys that match the regular expression are turned into storage values.classMapToVariablesTurns the map content into variables.
Only the map keys that match the regular expression are turned into variables.classMapVariableIteratorIterates over the keys of the incoming map and sets variables for current key and variable.classMat5ArrayInfoProvides information on a Matlab5 array.classMat5ArraySubsetOutputs either a single value (all dimensions in index specified) from an array or a subset (if one or more dimensions left empty).
Only arrays of type us.hebi.matlab.mat.types.Matrix are currently supported.classMat5FileAddArrayAdds an array to the matlab file object using the specified name.
The array can be retrieved from a callable actor or from storage.classMat5FileAddMapAdds the elements of a map to the matlab file object using the names from the map.
The map can be retrieved from a callable actor or from storage.classMat5FileGetArrayRetrieves the specified array from the mat file object.classMat5FileInfoProvides information from a .mat file.classMat5FileReaderLoads a Matlab file in mat5 format.classMat5GetMatrixElementRetrieves the specified matrix element.classMat5GetStructFieldRetrieves the specified struct field.classMat5SetMatrixElementSets the specified element in the matrix passing through.
The value gets parsed automatically according to the element type.classMat5SetStructFieldSets obtained array under the specified field name.classMat5StructInfoProvides information from a Matlab struct object.classMatchReportFieldsOutputs all fields that match the regular expression.classMathExpressionEvaluates a mathematical expression.
The input value (double or integer) can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
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) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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.classMaxReturns the maximum value from a double/int array or the index of the maximum value.classMergeObjectLocationsMerges the object locations in the report of the container passing through with the one obtained from storage.
The 'overlap action' determines what to do if objects overlap.
With the 'check type' you can still trigger a 'skip' if the type values of the two overlapping objects differ.
For simply merging all objects, choose a minOverlapRatio of 0.0 and the OverlapAction of KEEP.classMergeReportAllows the report (or the report of a report handler) passing through to to be merged with another one.classMergeReportFromMapMerges the passing through report handler/report objects with the referenced map of report objects in storage.classMessageDigestGenerates a message digest and forwards that.classMimeTypeDetermines the mime type of a file.classMinReturns the minimum value from a double/int array or the index of the minimum value.classMoveFileMoves a file to a different location (or just renames it).
Source and target can be swapped as well.
Simply forwards the input token if moving was successful.classMultiMapOperationApplies the specified operation the incoming map array.classMultiMat5MatrixOperationApplies a multi-matrix operation to the incoming matrix(s) and outputs the generated matrix(s).classMultiSpreadSheetOperationApplies the specified operation the incoming spreadsheet array.classNegativeRegionsUses the specified generator for generating negative regions for the image passing through.classObjectArrayToPrimitiveArrayTurns an object array into an primitive one.classOpenCVFeatureGeneratorApplies a OpenCV feature generator to the incoming image and outputs the generated features.classOpenCVMultiImageOperationApplies a BoofCV multi-image operation to the incoming image(s) and outputs the generated image(s).classOpenCVTransformerApplies a OpenCV transformation to the incoming image and outputs the generated image(s).classOptionProducerGenerates string output from the object passing through using the specified option producer.classOutlierDetectorApplies the outlier detector and either outputs the updated data container or a flow container with the data and the detection results.classPassThroughDummy transformer that passes tokens through.classPDFAppendDocumentModifies the incoming PDF document generated by adams.flow.source.PDFNewDocument using the PDF processors on either the specified input file or storage item.
Needs to be finalized with adams.flow.sink.PDFCloseDocument.
If a file name is received as input, it is assumed that this is an existing PDF file and gets appended.
See also:
adams.flow.source.PDFNewDocument
adams.flow.sink.PDFCloseDocument
Input/output:
- accepts:
adams.flow.transformer.pdfproclet.PDFGenerator
java.lang.String
java.io.File
- generates:
adams.flow.transformer.pdfproclet.PDFGenerator
classPDFCreateActor for generating PDF files.classPDFExtractActor for extracting a range of pages from a PDF file.classPDFExtractImagesActor for extracting the images from a PDF file.classPDFExtractTextActor for extracting the text of a range of pages from a PDF file.classPDFGenerateclassPDFInfoOutputs information on a PDF file.classPDFMergeActor for merging multiple PDF files.
Forwards the name of the generated file.classPDFMetaDataActor for extracting the meta-data from a PDF.classPDFPageCountActor for extracting the page count from a PDF file.classPDFRenderPagesActor for rendering pages of a PDF file as images.classPDFStampActor for stamping pages in a PDF with a custom overlay.classPixelSelectorAllows the user to select pixels.classPredictionEccentricityTreats the predictions from a regressor as an image and computes the 'eccentricity' of the actual vs predicted plot.classPrepareFileBasedDatasetProcesses the incoming files and generates a dataset container.
See also:
adams.flow.control.SetContainerValue
adams.flow.transformer.GenerateFileBasedDataset
Input/output:
- accepts:
java.lang.String[]
- generates:
adams.flow.container.FileBasedDatasetContainer
Container information:
- adams.flow.container.FileBasedDatasetContainer: Train, Test, Validation, Negative
classPrependDirPrepends the prefix to the file/directory being passed through.
By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and prefix.classPrimitiveArrayToObjectArrayTurns a primitive array into an object one.classProcessActorApplies the specified processor to the incoming actor and forwards the result.
For processors implementing adams.flow.processor.ModifyingProcessor the modified actor is forwarded (or, if not modified, the original one), all others just forward the incoming actor.
If the processor should implement adams.flow.processor.ListingProcessor then any generated list gets stored as string array in the outgoing container as well.
Processors implementing adams.flow.processor.GraphicalOutputProducingProcessor can optionall display the graphical output as well (off by default).classProgrammaticTokenListenerTransformer that allows other, non-flow code to 'listen on the wire' of the data being processed.
Typically used for flows that are executed as background jobs in the user interface.
Listeners get removed once the flow finishes (wrapUp method).classPropertiesFileReaderReads a Java Properties file.classPropertiesToVariablesTurns the properties into variables.
Only the property keys that match the regular expression are turned into variables.classPyroTransformerTransforms data using a Pyro4 call
For more information see:
https://pythonhosted.org/Pyro4/
https://github.com/irmen/Pyrolite
Input/output:
- accepts:
java.lang.Object
- generates:
java.lang.Object
classPythonExpandScriptLoads the Python script received as input, expands any variables and placeholders, saves it to the specified output file and forwards the output file name.classRelativeDirRemoves the prefix from the file/directory being passed through to turn them into relative ones.
See also:
adams.flow.transformer.BaseName
adams.flow.transformer.DirName
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.FileExtension
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
classRemoteCommandReaderLoads the remote command from the incoming file.classRemoveImageObjectRemoves the specified image object.classRemoveOverlappingImageObjectsCleans up overlapping objects, e.g., multiple predicted bounding boxes per object.classReportDbUpdaterAdds all the data to the report (or reporthandler's report) passing through that the SQL statement returns.
The {ID} placeholder can be used in the SQL statement to represent the current handler's ID.
The following types of SQL statements are supported:
- multiple rows of key-value pairs.
- single row, with the key being the column name.
Input/output:
- accepts:
adams.data.report.Report
adams.data.report.MutableReportHandler
- generates:
adams.data.report.Report
adams.data.report.MutableReportHandler
classReportFieldReturns all the fields in a report or the report from a report handling object that match the provided regular expression.classReportFileReaderLoads a file containing a report from disk with a specified reader and passes it on.classReportFileWriterSaves a report to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the report is used (below the specified output directory).classReportMathExpressionEvaluates a mathematical expression based on report values.
Either outputs the updated report or the report handler if that allows updating the report.classReportToStorageStores all report fields that match the provided regular expression in internal storage.classReportToVariablesTurns all report fields that match the provided regular expression into variables.classRoundPerforms 'round', 'ceiling' or 'floor' on double tokens and generates integers.classScaleReportObjectsScales the objects in the report using the provided scale factors.
Processes the following suffixes of all the report fields that match the provided prefix:
- .x
- .y
- .width
- .height
Input/output:
- accepts:
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.report.Report
adams.data.report.ReportHandler
classScpFromDownloads a remote file and forwards the local file name using secure copy (SCP).
For more information see:
(2011).classScpToUploads a file to a remote directory using secure copy (SCP).
The file name of a successful upload gets forwarded.
For more information see:
(2011).classScriptedA transformer that uses an external script for processing the token(s).classSelectArraySubsetAllows the user to select a subset of the incoming array to be forwarded in the flow.classSequenceToArrayTurns a sequence of tokens into arrays with a specified length.
In case of unspecified length (ie -1), an array containing all elements collected so far is output each time a token arrives, i.e., the internal buffer never gets reset.classSequenceToCollectionTurns a sequence of tokens into a collection.
In case of unspecified length (ie -1), a collection containing all elements collected so far is output each time a token arrives, i.e., the internal buffer never gets reset.classSetArrayElementSets an element of an array and forwards the updated array.classSetDatabaseIDUpdates the database ID of the database ID handler passing through with the provided 'ID' value.classSetIDUpdates the ID of the ID handler passing through with the provided 'ID' value.classSetImageObjectMetaDataSets meta-data in the incoming adams.flow.transformer.locateobjects.LocatedObject object.classSetJsonValueSets a value in a JSON object, using the specified path.
The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').classSetManyVariablesSets the values of the variables whenever a token passes through, but does not use the token's value.
Optionally, the specified values can be expanded, in case it is made up of variables itself.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
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) )
| has ( variable )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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] ) (find 'search' in 'expr', return 1-based position)
| replace ( str , pos , len , newstr )
| substitute ( str , find , replace [, occurrences] )
| str ( expr )
| str ( expr , numdecimals )
| str ( expr , decimalformat )
| ext ( file_str ) (extracts extension from file)
| replaceext ( file_str, ext_str ) (replaces the extension of the file with the new one)
;
Notes:
- Variables are either all alphanumeric and _, starting with uppercase letter (e.g., "ABc_12"),
any character apart from "]" enclosed by "[" and "]" (e.g., "[Hello World]") or
enclosed by single quotes (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.classSetMapValueSets a value in a java.util.Map object.
The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').classSetPlotContainerValueUpdates a value of a plot container before it is being displayed in the SequencePlotter sink.classSetPropertySets the property of a callable actor whenever a token passes through.
Note: this actor just sets the value, but performs no re-initialization or similar of the modified object.
The transformer just forwards tokens that it receives after the property has been set.classSetPropertyValueSets a property in a properties object.classSetReportFromFileLoads a report from disk and replaces the current one in the token passing through.classSetReportFromSourceObtains a report from a callable source and replaces the current one in the token passing through.classSetReportValueSets a value in a report.classSetStorageFlagStores the flag value in storage using the specified name whenever a token passes through.classSetStorageValueStores the payload of the token passing through under the specified name in temporary storage.classSetSystemPropertySets a Java system property when it is executed.classSetVariableSets the value of a variable.classSFTPDeleteDeletes a remote file via secure FTP (SFTP) and forwards the deleted file name.
For more information see:
(2011).classSFTPGetDownloads a remote file and forwards the local file name via secure FTP (SFTP).
For more information see:
(2011).classSFTPSendUploads a file to a remote directory using secure FTP (SFTP).
The file name of a successful upload gets forwarded.
For more information see:
(2011).classSimpleStringReplacePerforms a string replacement, using String.replace(.., ...).
If the 'replace' string contains both, variables and placeholders, then first all variables are expanded and then the placeholders.classSMBGetDownloads a remote file and forwards the local file name (SMB, Windows share).
Host and remote directory can be left empty if the incoming filename consists of a fully qualified URL, e.g.: smb://host/share/dir/file.txt
Input/output:
- accepts:
java.lang.String
- generates:
java.lang.String
classSMBSendUploads a file to a remote directory (SMB, Windows share).
The file name of a successful upload gets forwarded.
Input/output:
- accepts:
java.lang.String
- generates:
java.lang.String
classSortActor for sorting arrays.classSplitFileSplits the file into several smaller files using the specified splitter algorithm.classSpreadSheetAggregateAggregates rows (min, max, avg, etc) in a spreadsheet using key columns.
All numeric columns in the specified aggregrate range (excluding the key columns) get aggregated.classSpreadSheetAnonymizeAnonymizes a range of columns in a spreadsheet.classSpreadSheetAppendAppends the incoming spreadsheet to one in storage.
If there is none in storage yet, the incoming spreadsheet will simply get stored in storage.
The spreadsheets need not have the same structure, but it is assumed that column names are unique within a spreadsheet.
The combined spreadsheet is then forwarded.classSpreadSheetAppendCommentsAppends the comments of the spreadsheet.classSpreadSheetCellFinderOutputs the cell locations that the cell finder located.classSpreadSheetCellSelectorLets the user highlight cells in a spreadsheet which get output:
- spreadsheet with coordinates (1-based row and column) and the associated value of the selected cell
- spreadsheet with all un-selected cells set to missing
Usage:
You select cells by left-clicking on them and/or holding the left mouse button and moving the mouse over the cells that you want to select.
You can unselect cells in the same fashion, by holding the shift key in addition.classSpreadSheetCollapseUses the specified key columns to identify groups of rows.classSpreadSheetColumnFilterFilters spreadsheets using the specified column finder.
The output contains all the columns that the specified finder selected.classSpreadSheetColumnIteratorIterates through all columns of a spreadsheet and outputs the names.
The columns can be limited with the range parameter and furthermore with the regular expression applied to the names.
Instead of outputting the names, it is also possible to output the 1-based indices.classSpreadSheetColumnsByNameCreates a new spreadsheet with the columns that matched the regular expression.classSpreadSheetColumnStatisticGenerates statistics for a chosen colunm.classSpreadSheetCommonIDsExtracts the common IDs from two or more spreadsheets.
Matching sense can be inverted, i.e., the IDs not in common are output.classSpreadSheetConvertCellsFinds cells in a spreadsheet and converts them with a conversion scheme.
If the conversion scheme generates a adams.data.spreadsheet.SpreadSheet object itself, this will get merged with the enclosing one: any additional columns get added and the content of the first row gets added to the row the converted cell belongs to.classSpreadSheetConvertHeaderCellsConverts the header cells of a spreadsheet with a conversion scheme.classSpreadSheetCopyColumnsCopies a range of columns to a specific position in the spreadsheets coming through.classSpreadSheetCopyRowsCopies a range of columnrows to a specific position in the spreadsheets coming through.classSpreadSheetDifferenceComputes the difference of the numeric cells between two spreadsheets.
The values of the second spreadsheet are subtracted from the first one.
If no 'key' columns are defined, the current order of rows is used for comparison.classSpreadSheetExtractArrayExtracts a column or row of data from a SpreadSheet object.classSpreadSheetFileReaderReads a spreadsheet file and forwards the content.classSpreadSheetFilterApplies the specified spreadsheet filter to the data.classSpreadSheetGetCellExtracts one or more values from a spreadsheet.classSpreadSheetGetColumnIndexObtain the 1-based indices of columns that match a user-specified regular expression.classSpreadSheetGetHeaderCellExtracts a single value from a spreadsheet's header.classSpreadSheetHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming adams.data.spreadsheet.SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.classSpreadSheetInfoOutputs statistics of a SpreadSheet object.classSpreadSheetInsertColumnInserts a column at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.classSpreadSheetInsertRowInserts a row at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.classSpreadSheetInsertRowScoreInserts a score column at a specific position into spreadsheets coming through.classSpreadSheetMatrixStatisticGenerates statistics for the spreadsheet.classSpreadSheetMergeMerges two or more spreadsheets.classSpreadSheetMethodMergeMerges 2 or more spreadsheets into a single spreadsheet, using a selectable merge method.classSpreadSheetPlotGeneratorOutputs plot containers generated from a spreadsheet.classSpreadSheetQueryApplies a query (SELECT, UPDATE, DELETE) on a spreadsheet.
Variables are supported as well, e.g., : SELECT * WHERE Blah = @{val} with 'val' being a variable available at execution time.
The following grammar is used for the query:
expr_list ::= expr_list expr_part | expr_part;
expr_part ::= select | update | delete;
select ::= SELECT col_list [limit]
| SELECT col_list WHERE cond_list [limit]
| SELECT col_list ORDER BY order_list [limit]
| SELECT col_list WHERE cond_list ORDER BY order_list [limit]
| SELECT agg_list
| SELECT agg_list GROUP BY col_list
| SELECT agg_list HAVING cond_list
| SELECT agg_list GROUP BY col_list HAVING cond_list
;
update ::= UPDATE SET upd_list
| UPDATE SET upd_list WHERE cond_list
;
delete ::= DELETE WHERE cond_list
;
col_list ::= col_list COMMA col
| col
| SELECT NUMBER [subsample: <1 = percent; >= 1 number of rows]
;
col ::= *
| COLUMN
| COLUMN AS COLUMN
;
upd_list ::= upd_list COMMA upd | upd;
upd ::= COLUMN = value
;
order_list::= order_list COMMA order | order;
order ::= COLUMN
| COLUMN ASC
| COLUMN DESC
;
cond_list ::= cond_list cond
| cond
;
cond ::= COLUMN < value
| COLUMN <= value
| COLUMN = value
| COLUMN <> value
| COLUMN >= value
| COLUMN > value
| COLUMN REGEXP STRING
| COLUMN IS NULL
| CELLTYPE ( COLUMN ) = "numeric|long|double|boolean|string|time|date|datetime|timestamp|object|missing"
| ( cond )
| cond:c1 AND cond:c2
| cond:c1 OR cond:c2
| NOT cond
;
value ::= NUMBER
| STRING
| PARSE ( "number" , STRING )
| PARSE ( "date" , STRING )
| PARSE ( "time" , STRING )
| PARSE ( "timestamp" , STRING )
;
limit ::= LIMIT NUMBER:max
| LIMIT NUMBER:offset , NUMBER:max
;
agg_list ::= agg_list COMMA agg
| agg
;
agg ::= COUNT [(*)] [AS COLUMN]
| MIN ( COLUMN ) [AS COLUMN]
| MAX ( COLUMN ) [AS COLUMN]
| RANGE ( COLUMN ) [AS COLUMN] (= MIN - MAX)
| MEAN ( COLUMN ) [AS COLUMN]
| AVERAGE ( COLUMN ) [AS COLUMN]
| STDEV ( COLUMN ) [AS COLUMN]
| STDEVP ( COLUMN ) [AS COLUMN]
| SUM ( COLUMN ) [AS COLUMN]
| IQR ( COLUMN ) [AS COLUMN]
| INTERQUARTILE ( COLUMN ) [AS COLUMN]
Notes:
- time format: 'HH:mm'
- date format: 'yyyy-MM-dd'
- timestamp format: 'yyyy-MM-dd HH:mm'
- STRING is referring to characters enclosed by double quotes
- COLUMN is either a string with no blanks (consisting of letters, numbers, hyphen or underscore; eg 'MyCol-1') or a bracket enclosed string when containing blanks (eg '[Some other col]')
- columns used in the ORDER BY clause must be present in the SELECT part; also, any alias given to them in SELECT must be used instead of original column name
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.SpreadSheet
classSpreadSheetRandomSystematicSamplePerforms random systematic sampling on the rows of the incoming spreadsheet.
Divides the rows into N blocks with N being the sample size.classSpreadSheetRemoveColumnRemoves the column(s) at the specific position from spreadsheets coming through.classSpreadSheetRemoveRowRemoves one or more rows at the specific position from spreadsheets coming through.classSpreadSheetReorderColumnsReorders the columns in a spreadsheet according to a user-supplied order.classSpreadSheetReorderRowsReorders the rows in a spreadsheet according to a user-supplied order.classSpreadSheetReplaceCellValueReplaces cell values that match a regular expression with a predefined value.classSpreadSheetRowBinningApplies a binning algorithm to the values from the specified binning column to filter the rows into specific bins.
A new column is then added containing the corresponding bin index.classSpreadSheetRowBufferCan act in two different ways:
1.classSpreadSheetRowFilterFilters spreadsheets using the specified row finder.
The output contains all the rows that the specified finder selected.classSpreadSheetRowStatisticGenerates statistics for a chosen row.classSpreadSheetRowToTimeseriesTurns a spreadsheet row into a timeseries.
Columns for timestamps and values are extracted using the regular expressions, the timestamp columns are optional.classSpreadSheetSelectSubsetAllows the user to select a subset of the incoming spreadsheet to be forwarded in the flow.classSpreadSheetSetCellSets the value of the specified cells in a spreadsheet.classSpreadSheetSetHeaderCellSets a single header cell value in a spreadsheet.classSpreadSheetSortSorts the rows of the spreadsheet according to the selected column indices and sort order (ascending/descending).classSpreadSheetSortColumnsReorders a user-defined subset of columns by name using the specified comparator.classSpreadSheetStatisticGenerates statistics from a SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.classSpreadSheetStorageRowIteratorIterates through a defined range of rows.classSpreadSheetSubsetExtracts a subset of rows/columns from a spreadsheet.classSpreadSheetSubsetByValueGenerates subsets from a spreadsheet, grouped by the same string value in the specified column.
For instance, if a spreadsheet has 3 unique values (A, B, C) in column 2, then 3 subsheets will generated, each containing the rows that have the value A, B or C.classSpreadSheetSubsetFromGroupSplits the spreadsheet into subsets using the supplied column and then returns the specified range of rows from each generated subset.
The spreadsheet is expected to be sorted on the grouping column.classSpreadSheetToTimeseriesExtracts one or more timeseries from a spreadsheet.
It uses one column ('ID') to identify all the rows that belong to a single timeseries.classSpreadSheetTransformCellsFinds cells in a spreadsheet and transforms them with a callable transformer.
In case of transformers having Object or Unknown in their types of classes that they accept, no proper type can be inferred automatically.classSpreadSheetTransformHeaderCellsTransforms header cells with a callable transformer.
In case of transformers having Object or Unknown in their types of classes that they accept, no proper type can be inferred automatically.classSpreadSheetVariableRowIteratorIterates through a defined range of rows.classStorageCollectionInsertInserts the object passing through to the collection in storage at the specified position.
After inserting the object successfully, just forwards the object.
If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.
See also:
adams.flow.transformer.CollectionInsert
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classStorageJFreeChartAddSeriesGenerates a series from the incoming spreadsheet and adds it to the specified JFreeChart dataset in storage.
After inserting the object successfully, just forwards the object.classStringArraySplitUses a regular expression to identify the string that triggers one or more splits in a string array, resulting in smaller arrays being output.
What is done with the string triggering the split, is defined in the split handling option, e.g., discard it.
Useful actor for splitting a log file into individual entry chunks.classStringCutCuts out a part of a string.classStringExpressionEvaluates a string expression.
The input string can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
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) )
| isNaN ( expr )
# arithmetics
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr ^ expr (power of)
| expr % expr (modulo)
;
# numeric functions
| abs ( expr )
| sqrt ( expr )
| cbrt ( expr )
| log ( expr )
| log10 ( expr )
| exp ( expr )
| sin ( expr )
| sinh ( expr )
| cos ( expr )
| cosh ( expr )
| tan ( expr )
| tanh ( expr )
| atan ( expr )
| atan2 ( exprY , exprX )
| hypot ( exprX , exprY )
| signum ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| min ( expr1 , expr2 )
| max ( expr1 , expr2 )
| 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] )
# array functions
| len[gth] ( array )
| get ( array , index )
;
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' for function 'get' starts 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.classStringIndentIndents the string with the specified character.
Splits multi-line strings first and processes each line separately.classStringIndexOfDetermines the position of a substring in the string passing through.
The generated index is 1-based, with 0 indicating that the substring could not be located.classStringInsertInserts a user-specified string at a specific position into tokens coming through.
The actor is most useful when attaching a variable to the 'value' option, which allows the value to change dynamically then.classStringJoinCreates a single string out of an array of strings.classStringLengthDetermines the length of a string.classStringMatcherLets string tokens only pass if they match the regular expression.classStringRangeCutCuts out a parts of a string.classStringReplacePerforms a string replacement, using either String.replaceFirst(...) or String.replaceAll(...).classStringSanitizerRemoves all characters that haven't been specified as 'acceptable' characters.classStringSplitSplits a string using a regular expression.classStringTrimTrims strings, i.e., removes leading/trailing whitespaces.classSubStringCountDetermines the position of a substring in the string passing through.
The generated index is 1-based, with 0 indicating that the substring could not be located.classSummaryStatisticsCalculates the selected summary statistics and outputs a spreadsheet.classSwapVariablesSwaps the values of the two variables around, whenever a token passes through.classTarCreates a Tar file containing one or more files.classTemplateTransformerFeeds tokens into an actor generated from a template and broadcasts the generated output tokens.classTesseractOCRApplies OCR to the incoming image file using Tesseract.
In case of successful OCR, either the file names of the generated files are broadcast or the combined text of the files.
NB: The actor deletes all files that have the same prefix as the specified output base.classTextFileReaderReads a text file and forwards the content.
This actor takes the file to read as input.classTextRendererTurns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.classTimeseriesAddAppends the incoming timeseries to the one available from storage.
If none yet available from storage, then the current one simply put into storage.
If the timeseries already contains elements with the same timestamp, then these will get replaced by the current ones.classTimeseriesAppendAppends the incoming timeseries to the one available from storage.
If none yet available from storage, then the current one simply put into storage.
If the timeseries already contains elements with the same timestamp, then these will get replaced by the current ones.classTimeseriesDbReaderOutputs timeseries containers generated from an SQL SELECT statement.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).classTimeseriesFeatureGeneratorApplies a timeseries feature generator to the incoming timeseries and outputs the generated features.classTimeseriesFileReaderLoads a file/directory containing spectrums from disk with a specified reader and passes them on.classTimeseriesFileWriterSaves a spectrum to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the spectrum is used (below the specified output directory).classTimeseriesFilterFilters data using the specified filter.classTimeseriesInfoOutputs information for a timeseries.classTimeseriesReportDbUpdaterAdds all the data to the report of the timeseries passing through that the SQL statement returns.
The {ID} placeholder can be used in the SQL statement to represent the current timeseries' ID.
The following types of SQL statements are supported:
- multiple rows of key-value pairs.
- single row, with the key being the column name.
Input/output:
- accepts:
adams.data.timeseries.Timeseries
- generates:
adams.data.timeseries.Timeseries
classTimeseriesSplitSplits the incoming timeseries into sub-series using the specified splitter algorithm.classTimestampCreates a timestamp string whenever it receives an input token.classToolRuns a tool.classTouchLike the Unix 'touch' command, updates the 'last modified' timestamp of the file coming through.
By default, it creates the file if it doesn't exist.classUnBzip2Decompresses an archive that was compressed with bzip2.classUniqueIDEnsures that all passing through tokens that implement adams.data.id.MutableIDHandler have a unique ID.
All other tokens are just forwarded as is.classUnLzfDecompresses an archive that was compressed with LZF.classUnLzmaDecompresses an archive that was compressed with LZMA (7zip).classUnRARUnrars a RAR archive and broadcasts the full file names of the extracted files.classUnTarDecompresses a Tar archive and broadcasts the full file names of the extracted files.classUnXzDecompresses an archive that was compressed with XZ.classUnZIPUnzips a ZIP archive and broadcasts the full file names of the extracted files.classUnZstdDecompresses an archive that was compressed with Zstd.classUpdatePropertyUpdates the property of the object passing through with the specified value.classViaAnnotationsToReportsConverts the JSON object passing through to Reports.classWaitForFileWaits for the file passing through to become available, i.e., not in use by another process.classWekaAccumulatedErrorGenerates plot containers from an evaluation object's predictions.classWekaAggregateEvaluationsAggregates incoming weka.classifiers.Evaluation objects and forwards the current aggregated state.classWekaAttributeIteratorIterates through all attributes of a dataset and outputs the names.
The attributes can be limited with the range parameter and furthermore with the regular expression applied to the names.
Instead of outputting the names, it is also possible to output the 1-based indices.classWekaAttributeSelectionPerforms attribute selection on the incoming data.
In case of input in form of a class adams.flow.container.WekaTrainTestSetContainer object, the train and test sets stored in the container are being used.
NB: In case of cross-validation no reduced or transformed data can get generated!
Input/output:
- accepts:
weka.core.Instances
adams.flow.container.WekaTrainTestSetContainer
- generates:
adams.flow.container.WekaAttributeSelectionContainer
Container information:
- adams.flow.container.WekaTrainTestSetContainer: Train, Test, Seed, FoldNumber, FoldCount, Train original indices, Test original indices
- adams.flow.container.WekaAttributeSelectionContainer: Train, Reduced, Transformed, Test, Test reduced, Test transformed, Evaluation, Statistics, Selected attributes, Seed, FoldCount
classWekaAttributeSelectionSummaryOutputs a summary string of the attribute selection.classWekaBootstrappingPerforms bootstrapping on the incoming evaluation and outputs a spreadsheet where each row represents the results from bootstrapping sub-sample.classWekaChooseAttributesLets the user select attributes interactively to use down the track.
Internally, a weka.filters.unsupervised.attribute.Remove WEKA filter is constructed from the selection, to remove the attributes that the user didn't select.classWekaClassifierInfoOutputs information of a trained weka.classifiers.Classifier object.classWekaClassifierOptimizerEvaluates a classifier optimizer on an incoming dataset.classWekaClassifierRankerPerforms a quick evaluation using cross-validation on a single dataset (or evaluation on a separate test set if the number of folds is less than 2) to rank the classifiers received on the input and forwarding the x best ones.classWekaClassifierSetupProcessorApplies the specified processor to the incoming array of classifiers, e.g., for generating new or filtered setups.classWekaClassifyingUses a serialized model to perform predictions on the data being passed through.
The following order is used to obtain the model (when using AUTO):
1.classWekaClassSelectorSets the class index.classWekaClusterAssignmentsOutputs the cluster assignments from the evaluation.classWekaClustererInfoOutputs information of a trained weka.clusterers.Clusterer object.classWekaClustererPostProcessorApplies the specified post-processor to the cluster container (adams.flow.container.WekaModelContainer)
See also:
adams.flow.transformer.WekaTrainClusterer
Input/output:
- accepts:
adams.flow.container.WekaModelContainer
- generates:
adams.flow.container.WekaModelContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
classWekaClusterEvaluationSummaryGenerates a summary string of the weka.clusterers.ClusterEvaluation objects that it receives.classWekaClusteringUses a serialized model to cluster data being passed through.
The following order is used to obtain the model (when using AUTO):
1.classWekaCrossValidationClustererEvaluatorCross-validates a clusterer on an incoming dataset.classWekaCrossValidationEvaluatorCross-validates a classifier on an incoming dataset.classWekaCrossValidationSplitGenerates train/test pairs like during a cross-validation run.classWekaDatasetsMergeMerges 2 or more datasets into a single dataset, under a selectable merge method.classWekaDatasetSplitSplits the incoming dataset into sub-sets using the specified splitter.classWekaEnsembleGeneratorUses the specified generator to create ensembles from the incoming data.classWekaEvaluationInfoOutputs information about a Weka weka.classifiers.Evaluation object.classWekaEvaluationPostProcessorApplies the specified post-processor to the incoming Evaluation data.classWekaEvaluationSummaryGenerates a summary string of the weka.classifiers.Evaluation objects that it receives.classWekaEvaluationValuePickerPicks a specific value from an evaluation object.classWekaEvaluationValuesGenerates a spreadsheet from statistics of an Evaluation object.classWekaExperimentRepresents a Weka experiment, stored in a file.classWekaExperimentEvaluationGenerates evaluation output of an experiment that was run previously.classWekaExperimentExecutionExecutes an experiment.classWekaExperimentFileReaderLoads an experiment file.classWekaExtractArrayExtracts a column or row of data from a weka.core.Instances or SpreadSheet object.
Only numeric columns can be returned.classWekaExtractPLSMatrixTransformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.classWekaFileReaderReads any file format that Weka's converters can handle and returns the full dataset or single weka.core.Instance objects.classWekaFilterFilters Instances/Instance objects using the specified filter.
When re-using a trained filter, ensure that 'initializeOnce' is checked.
The following order is used to obtain the model (when using AUTO):
1.classWekaGenericPLSMatrixAccessTransformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.
See the respective PLS implementation for details on available matrix names (derived from: weka.filters.supervised.attribute.pls.AbstractPLS)
Input/output:
- accepts:
weka.classifiers.Classifier
weka.filters.Filter
weka.core.GenericPLSMatrixAccess
adams.flow.container.WekaModelContainer
- generates:
adams.data.spreadsheet.SpreadSheet
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
classWekaGeneticAlgorithmApplies the genetic algorithm to the incoming dataset.
Forwards the best setup(s) after the algorithm finishes.
A callable sink can be specified for receiving intermediate performance results.classWekaGeneticAlgorithmInitializerPopulates a adams.flow.container.WekaGeneticAlgorithmInitializationContainer container from the data obtained from the incoming setup (in properties format, can be gzip compressed).classWekaGetCapabilitiesRetrieves the capabilities of a weka.core.CapabilitiesHandler (eg filter or classifier) and forwards them.classWekaGetInstancesValueRetrieves a value from a WEKA Instances object.
Notes:
- date and relational values are forwarded as strings
- missing values are output as '?' (without the single quotes)
Input/output:
- accepts:
weka.core.Instances
- generates:
java.lang.Double
java.lang.String
classWekaGetInstanceValueRetrieves a value from a WEKA Instance object.
Notes:
- date and relational values are forwarded as strings
- missing values are output as '?' (without the single quotes)
- the 'attribute name' option overrides the 'index' option
Input/output:
- accepts:
weka.core.Instance
- generates:
java.lang.Double
java.lang.String
Valid options are:classWekaInstanceBufferCan act in two different ways:
1.classWekaInstanceDumperDumps weka.core.Instance objects into an ARFF file.classWekaInstanceEvaluatorAdds a new attribute to the data being passed through (normally 'evaluation') and sets the value to the evaluation value returned by the chosen evaluator scheme.classWekaInstanceFileReaderLoads a WEKA dataset from disk with a specified reader and passes on the adams.core.instance.Instance objects.classWekaInstancesAppendCreates one large dataset by appending all one after the other.classWekaInstancesHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming weka.core.Instances object.
The actor just uses the internal format (double array) and does not check whether the attributes are actually numeric.classWekaInstancesInfoOutputs statistics of a weka.core.Instances object.
FULL_ATTRIBUTE and FULL_CLASS output a spreadsheet with detailed attribute statistics.classWekaInstancesMergeMerges multiple datasets, either from file or using Instances/Instance objects.
If no 'ID' attribute is named, then all datasets must contain the same number of rows.
Attributes can be excluded from ending up in the final dataset via a regular expression.classWekaInstancesStatisticGenerates statistics from a weka.core.Instances object.
The actor just uses the internal format (double array) and does not check whether the attributes are actually numeric.classWekaInstanceStreamPlotGeneratorGenerates plot containers from a range of attributes of the weka.core.Instance objects being passed through.
The generator merely uses the internal data representation for generating the Y value of the plot container.classWekaModelReaderActor for loading a model (classifier or clusterer).classWekaMultiLabelSplitterSplits a dataset containing multiple class attributes ('multi-label') into separate datasets with only a single class attribute.classWekaNearestNeighborSearchOutputs the specified number of nearest neighbors for the incoming Weka Instance.
The data used for the nearest neighbor search is either obtained from storage.classWekaNewInstanceCreates a new weka.core.Instance-derived object, with all values marked as missing.
The class implementing the weka.core.Instance interface needs to have a constructor that takes the number of attributes as sole parameter.classWekaPredictionsToInstancesGenerates weka.core.Instances from the predictions of an Evaluation object.classWekaPredictionsToSpreadSheetGenerates a SpreadSheet object from the predictions of an Evaluation object.
See also:
adams.flow.transformer.WekaSpreadSheetToPredictions
Input/output:
- accepts:
weka.classifiers.Evaluation
adams.flow.container.WekaEvaluationContainer
- generates:
adams.data.spreadsheet.SpreadSheet
Container information:
- adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output, Original indices
classWekaPrimeForecasterPrimes a forecaster with the incoming data and outputs the updated forecaster alongside the training header (in a model container).classWekaPrincipalComponentsPerforms principal components analysis on the incoming data and outputs the loadings and the transformed data as spreadsheet array.
Automatically filters out attributes that cannot be handled by PCA.classWekaRandomSplitSplits a dataset into a training and test set according to a specified split percentage.classWekaRegexToRangeProduces a range string from a regular expression describing attributes.classWekaRelationNameDeprecated.classWekaRenameRelationModifies relation names.classWekaReorderAttributesToReferenceReorders the attributes of the Instance/Instances passing through according to the provided reference dataset (callable actor or reference file).
This ensures that the generated data always has the same structure as the reference dataset.classWekaSetInstancesValueSets a value in a WEKA Instances object.
Notes:
- relational values cannot be set
- '?' (without single quotes) is interpreted as missing value
Input/output:
- accepts:
weka.core.Instances
- generates:
weka.core.Instances
classWekaSetInstanceValueSets a value in a WEKA Instance.
Notes:
- relational values cannot be set
- '?' (without single quotes) is interpreted as missing value
Input/output:
- accepts:
weka.core.Instance
- generates:
weka.core.Instance
Valid options are:classWekaSplitGeneratorclassWekaSpreadSheetToPredictionsTurns the predictions stored in the incoming spreadsheet (actual and predicted) into a Weka weka.classifiers.Evaluation object.
For recreating the predictions of a nominal class, the class distributions must be present in the spreadsheet as well.
See also:
adams.flow.transformer.WekaPredictionsToSpreadSheet
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
weka.classifiers.Evaluation
classWekaStoreInstanceAppends the incoming weka.core.Instance to the dataset in storage.classWekaStreamEvaluatorEvaluates an incremental classifier on a data stream using prequential evaluation (first evaluate, then train).classWekaStreamFilterFilters Instance objects using the specified filter.classWekaSubsetsSplits the dataset based on the unique values of the specified attribute: all rows with the same unique value form a subset.classWekaTestSetClustererEvaluatorEvaluates a trained clusterer (obtained from input) on the dataset obtained from the callable actor.
If a class attribute is set, a classes-to-clusters evaluation is performed automatically
Input/output:
- accepts:
weka.clusterers.Clusterer
adams.flow.container.WekaModelContainer
- generates:
adams.flow.container.WekaClusterEvaluationContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
- adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood
classWekaTestSetEvaluatorEvaluates a trained classifier (obtained from input) on the dataset obtained from the callable actor.classWekaTextDirectoryReaderLoads all text files in a directory and uses the subdirectory names as class labels.classWekaTrainAssociatorTrains an associator based on the incoming dataset and outputs the built associator alongside the training header and rules (in a model container)..classWekaTrainClassifierTrains a classifier based on the incoming dataset and outputs the built classifier alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the classifier implements weka.classifiers.UpdateableClassifier.classWekaTrainClustererTrains a clusterer based on the incoming dataset and output the built clusterer alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the clusterer implements weka.clusterers.UpdateableClusterer.classWekaTrainForecasterTrains a forecaster based on the incoming dataset and outputs the built model alongside the training header (in a model container).classWekaTrainTestSetClustererEvaluatorTrains a clusterer on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The clusterer setup being used in the evaluation is a callable 'Clusterer' actor.
If a class attribute is set, a classes-to-clusters evaluation is performed automatically
Input/output:
- accepts:
adams.flow.container.WekaTrainTestSetContainer
- generates:
adams.flow.container.WekaClusterEvaluationContainer
Container information:
- adams.flow.container.WekaTrainTestSetContainer: Train, Test, Seed, FoldNumber, FoldCount
- adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood
classWekaTrainTestSetEvaluatorTrains a classifier on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The classifier setup being used in the evaluation is a callable 'Classifier' actor.classXMLFileReaderReads an XML file and forwards the parsed org.w3c.dom.Document object.classXPathApplies XPath to the DOM document object.classXSLTApplies an XSLT stylesheet to the DOM document object.classXzCreates a XZ archive from a single file.classYamlFileReaderReads a YAML file and forwards the generated Map object.
http://yaml.org/
Input/output:
- accepts:
java.lang.String
java.io.File
- generates:
java.util.Map
classZIPCreates a ZIP file containing one or more files.classZstdCreates a Zstd archive from a single file.Fields in adams.flow.transformer declared as Actor Modifier and Type Field Description protected ActorExecuteActor. m_Actorthe current actor being executed.protected ActorAbstractInteractiveTransformer. m_CallableActorthe callable actor.protected ActorSpreadSheetTransformCells. m_CallableActorthe callable actor.protected ActorSpreadSheetTransformHeaderCells. m_CallableActorthe callable actor.protected ActorWekaGeneticAlgorithm. m_CallableActorthe callable actor.protected ActorSetJsonValue. m_SourceActorthe callable source actor.protected ActorSetMapValue. m_SourceActorthe callable source actor.Methods in adams.flow.transformer that return Actor Modifier and Type Method Description protected ActorAbstractInteractiveTransformer. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorCallableTransformer. findCallableActor()Tries to find the callable actor referenced by its name.protected ActorIndexedSplitsRunsEvaluation. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorIndexedSplitsRunsPredictions. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorMergeReport. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorSetJsonValue. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorSetMapValue. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorSetReportFromSource. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorSpreadSheetTransformCells. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorSpreadSheetTransformHeaderCells. findCallableActor()Tries to find the callable actor referenced by its callable name.protected ActorWekaGeneticAlgorithm. findCallableActor()Tries to find the callable actor referenced by its callable name.ActorSpreadSheetTransformCells. getCallableActor()Returns the currently set callable actor.ActorSpreadSheetTransformHeaderCells. getCallableActor()Returns the currently set callable actor.ActorWekaGeneticAlgorithm. getCallableActor()Returns the currently set callable actor.protected ActorCopyCallableTransformer. getDefaultActor()Returns the default actor if the callable actor is optional and not found.Methods in adams.flow.transformer with parameters of type Actor Modifier and Type Method Description protected StringCopyCallableTransformer. checkCallableActor(Actor actor)Performs checks on the callable actor.protected StringIncludeExternalTransformer. checkExternalActor(Actor actor)Performs checks on the external actor.Constructors in adams.flow.transformer with parameters of type Actor Constructor Description AutogeneratedTransformer(Actor actor)Encapsulates the specified actor.AutogeneratedTransformer(Actor[] actors)Encapsulates the specified actors.InactiveTransformer(Actor actor)Encapsulates the specified actor.InactiveTransformer(Actor[] actors)Encapsulates the specified actors. -
Uses of Actor in adams.flow.transformer.draw
Fields in adams.flow.transformer.draw declared as Actor Modifier and Type Field Description protected ActorAbstractDrawOperation. m_Ownerthe owner of the operation.Methods in adams.flow.transformer.draw that return Actor Modifier and Type Method Description ActorAbstractDrawOperation. getOwner()Returns the owner.Methods in adams.flow.transformer.draw with parameters of type Actor Modifier and Type Method Description voidAbstractDrawOperation. setOwner(Actor value)Sets the owner. -
Uses of Actor in adams.flow.transformer.indexedsplitsrunsevaluation
Fields in adams.flow.transformer.indexedsplitsrunsevaluation declared as Actor Modifier and Type Field Description protected ActorAbstractIndexedSplitsRunsEvaluation. m_FlowContextthe flow context.Methods in adams.flow.transformer.indexedsplitsrunsevaluation that return Actor Modifier and Type Method Description ActorAbstractIndexedSplitsRunsEvaluation. getFlowContext()Returns the flow context, if any.Methods in adams.flow.transformer.indexedsplitsrunsevaluation with parameters of type Actor Modifier and Type Method Description voidAbstractIndexedSplitsRunsEvaluation. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.transformer.indexedsplitsrunsgenerator
Fields in adams.flow.transformer.indexedsplitsrunsgenerator declared as Actor Modifier and Type Field Description protected ActorAbstractIndexedSplitsRunsGenerator. m_FlowContextthe flow context.Methods in adams.flow.transformer.indexedsplitsrunsgenerator that return Actor Modifier and Type Method Description ActorAbstractIndexedSplitsRunsGenerator. getFlowContext()Returns the flow context, if any.Methods in adams.flow.transformer.indexedsplitsrunsgenerator with parameters of type Actor Modifier and Type Method Description voidAbstractIndexedSplitsRunsGenerator. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.transformer.indexedsplitsrunspredictions
Fields in adams.flow.transformer.indexedsplitsrunspredictions declared as Actor Modifier and Type Field Description protected ActorAbstractIndexedSplitsRunsPredictions. m_FlowContextthe flow context.Methods in adams.flow.transformer.indexedsplitsrunspredictions that return Actor Modifier and Type Method Description ActorAbstractIndexedSplitsRunsPredictions. getFlowContext()Returns the flow context, if any.Methods in adams.flow.transformer.indexedsplitsrunspredictions with parameters of type Actor Modifier and Type Method Description voidAbstractIndexedSplitsRunsPredictions. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.transformer.report
Fields in adams.flow.transformer.report declared as Actor Modifier and Type Field Description protected ActorAbstractReportPostProcessor. m_Ownerthe owning actor.protected ActorAbstractReportPreProcessor. m_Ownerthe owning actor.Methods in adams.flow.transformer.report that return Actor Modifier and Type Method Description ActorAbstractReportPostProcessor. getOwner()Returns the current owner of this preprocessor.ActorAbstractReportPreProcessor. getOwner()Returns the current owner of this preprocessor.Methods in adams.flow.transformer.report with parameters of type Actor Modifier and Type Method Description voidAbstractReportPostProcessor. setOwner(Actor value)Sets the owner for this preprocessor.voidAbstractReportPreProcessor. setOwner(Actor value)Sets the owner for this preprocessor. -
Uses of Actor in adams.flow.websocket.client
Fields in adams.flow.websocket.client declared as Actor Modifier and Type Field Description protected ActorSimpleSend. m_FlowContextthe flow context.protected ActorSimpleSendWithQueue. m_FlowContextthe flow context.Methods in adams.flow.websocket.client that return Actor Modifier and Type Method Description ActorSimpleSend. getFlowContext()Returns the flow context, if any.ActorSimpleSendWithQueue. getFlowContext()Returns the flow context, if any.Methods in adams.flow.websocket.client with parameters of type Actor Modifier and Type Method Description voidSimpleSend. setFlowContext(Actor value)Sets the flow context.voidSimpleSendWithQueue. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.flow.websocket.server
Fields in adams.flow.websocket.server declared as Actor Modifier and Type Field Description protected ActorEchoServer. m_FlowContextthe flow context.Methods in adams.flow.websocket.server that return Actor Modifier and Type Method Description ActorEchoServer. getFlowContext()Returns the flow context, if any.Methods in adams.flow.websocket.server with parameters of type Actor Modifier and Type Method Description voidEchoServer. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.gui.flow
Fields in adams.gui.flow declared as Actor Modifier and Type Field Description protected ActorFlowRunnerPanel. m_CurrentFlowthe current flow.protected ActorFlowWorker. m_Flowthe flow to execute.protected ActorFlowPanel. m_LastFlowthe last flow that was run.protected ActorFlowRunnerPanel. m_LastFlowthe last flow that was run.Methods in adams.gui.flow that return Actor Modifier and Type Method Description ActorFlowEditorPanel. getActiveFlow()Returns the active flow.ActorFlowEditorPanel. getActiveFlow(StringBuilder errors)Returns the active flow.ActorFlowEditorPanel. getActiveRoot()Returns the active root actor without its children.ActorFlowEditorPanel. getCurrentFlow()Returns the current flow.ActorFlowEditorPanel. getCurrentFlow(StringBuilder errors)Returns the current flow.ActorFlowPanel. getCurrentFlow()Returns the current flow.ActorFlowPanel. getCurrentFlow(StringBuilder errors)Returns the current flow.ActorFlowRunnerPanel. getCurrentFlow()Returns the current flow.ActorFlowEditorPanel. getCurrentRoot()Returns the current root actor without its children.ActorFlowPanel. getCurrentRoot()Returns the current root actor without its children.ActorFlowWorker. getFlow()Returns the flow.ActorFlowEditorPanel. getLastFlow()Returns the last flow executed (currently selected flow).ActorFlowPanel. getLastFlow()Returns the last executed flow (if any).ActorFlowRunnerPanel. getLastFlow()Returns the last executed flow (if any).ActorFlowWorkerHandler. getLastFlow()Returns the last executed flow (if any).ActorFlowEditorPanel. getRunningFlow()Returns the currently running flow.ActorFlowPanel. getRunningFlow()Returns the currently running flow.Methods in adams.gui.flow with parameters of type Actor Modifier and Type Method Description protected voidFlowRunnerPanel. findSetVariableActors(Actor parent, Vector<SetVariable> list)Locates all the SetVariable singleton actors below the parent.protected voidFlowEditorPanel. newFlow(Actor actor)Adds new panel with the specified actor.FlowEditorPanelFlowEditorPanel. newWindow(Actor actor)Displays a new flow editor window/frame with the specified actor.voidFlowPanel. reset(Actor actor)Resets the GUI to default values.voidFlowEditorPanel. setCurrentFlow(Actor flow)Sets the flow to work on.voidFlowPanel. setCurrentFlow(Actor flow)Sets the flow to work on.voidFlowRunnerPanel. setCurrentFlow(Actor flow)Sets the flow to work on.voidFlowPanel. setLastFlow(Actor actor)Sets the flow that was last executed.voidFlowRunnerPanel. setLastFlow(Actor value)Sets the flow that was last executed.voidFlowWorkerHandler. setLastFlow(Actor actor)Sets the flow that was last executed.Constructors in adams.gui.flow with parameters of type Actor Constructor Description FlowWorker(FlowWorkerHandler owner, Actor flow, File file, boolean showNotification, boolean debug)Initializes the worker. -
Uses of Actor in adams.gui.flow.tab
Fields in adams.gui.flow.tab declared as Actor Modifier and Type Field Description protected ActorClipboard.ClipboardItem. m_Actorthe actor.Methods in adams.gui.flow.tab that return Actor Modifier and Type Method Description ActorClipboard.ClipboardItem. getActor()Returns the stored actor.Methods in adams.gui.flow.tab with parameters of type Actor Modifier and Type Method Description voidActorHelpTab. actorSelectionChanged(TreePath[] paths, Actor[] actors)Notifies the tab of the currently selected actors.voidActorParametersTab. actorSelectionChanged(TreePath[] paths, Actor[] actors)Notifies the tab of the currently selected actors.voidAttachedVariablesTab. actorSelectionChanged(TreePath[] paths, Actor[] actors)Notifies the tab of the currently selected actors.voidClipboard. actorSelectionChanged(TreePath[] paths, Actor[] actors)Notifies the tab of the currently selected actors.voidEffectiveTagsTab. actorSelectionChanged(TreePath[] paths, Actor[] actors)Notifies the tab of the currently selected actors.voidSelectionAwareEditorTab. actorSelectionChanged(TreePath[] paths, Actor[] actors)Notifies the tab of the currently selected actors.voidFlowTabManager. notifyTabs(TreePath[] paths, Actor[] actors)Notifies all the selection aware tabs that the selection of actors has changed.Constructors in adams.gui.flow.tab with parameters of type Actor Constructor Description ClipboardItem(String name, Actor actor)Initializes the container item. -
Uses of Actor in adams.gui.flow.tree
Classes in adams.gui.flow.tree that implement Actor Modifier and Type Class Description classClipboardActorContainerA simple container for multiple actors, for easy copying to and retrieving from the clipboard.Fields in adams.gui.flow.tree declared as Actor Modifier and Type Field Description protected Actor[]ActorSuggestion. m_Defaultsthe default actor(s).Fields in adams.gui.flow.tree with type parameters of type Actor Modifier and Type Field Description protected ArrayList<Actor>ClipboardActorContainer. m_Actorsthe actors.Methods in adams.gui.flow.tree that return Actor Modifier and Type Method Description ActorClipboardActorContainer. firstActive()Returns the first non-skipped actor.ActorClipboardActorContainer. get(int index)Returns the actor at the given position.ActorNode. getActor()Returns the stored (stripped down) actor.ActorTree. getActor()Returns the underlying flow.ActorTree. getActor(StringBuilder errors)Returns the underlying flow.static ActorTreeOperations. getActorFromClipboard()Returns the actor stored on the clipboard.Actor[]ClipboardActorContainer. getActors()Returns the actors as array.Actor[]ActorSuggestion. getDefaults()Returns the available default actors.ActorNode. getFullActor()Returns the full actor, i.e., including all possible sub-actors.ActorNode. getFullActor(StringBuilder errors)Returns the full actor, i.e., including all possible sub-actors.protected ActorTree. getNearestActor(Node parent, int startIndex, boolean forward)Returns the nearest actor in the children of the provided parent node that is not disabled.ActorTree. getRootActor()Returns the top-level actor (without any children).ActorTree. getSelectedActor()Returns the currently selected actor.Actor[]Tree. getSelectedActors()Returns the currently selected actors.ActorClipboardActorContainer. lastActive()Returns the last non-skipped actor.static Actor[]TreeHelper. pathsToActors(TreePath[] paths)Converts the paths to actors (the last component in a path).static Actor[]TreeHelper. pathsToActors(TreePath[] paths, boolean full)Converts the paths to actors (the last component in a path).static ActorTreeHelper. pathToActor(TreePath path)Converts the path to an actor (the last component in a path).static ActorTreeHelper. pathToActor(TreePath path, boolean full)Converts the path to an actor (the last component in a path).ActorClipboardActorContainer. remove(int index)Removes the actor at the given position and returns the removed object.Actor[]ActorSuggestion. suggest(ActorSuggestion.SuggestionData context)Returns the suggested actors.Actor[]ExternalActorSuggestion. suggest(ActorSuggestion.SuggestionData context)Returns the suggested actors.Actor[]TreeOperations. suggestActors(TreePath path, TreeOperations.InsertPosition position)Tries to figure what actors fit best in the tree at the given position.Actor[]TreeOperations. suggestExternalActors(TreePath[] paths)Tries to figure what external actors fit best using the given selection of actors.Methods in adams.gui.flow.tree with parameters of type Actor Modifier and Type Method Description StringClipboardActorContainer. add(int index, Actor actor)Inserts the actor at the given position.StringClipboardActorContainer. add(Actor actor)Inserts the actor at the end.voidTreeOperations. addActor(TreePath path, Actor actor, TreeOperations.InsertPosition position)Brings up the GOE dialog for adding an actor if no actor supplied, otherwise just adds the given actor at the position specified by the path.voidTreeOperations. addActor(TreePath path, Actor actor, TreeOperations.InsertPosition position, boolean record)Brings up the GOE dialog for adding an actor if no actor supplied, otherwise just adds the given actor at the position specified by the path.voidTreeOperations. addActor(TreePath path, Actor actor, TreeOperations.InsertPosition position, boolean record, TreeOperations.ActorDialog dialogType)Brings up the GOE dialog for adding an actor if no actor supplied, otherwise just adds the given actor at the position specified by the path.voidTree. buildTree(Actor root)Builds the tree with the given root.static NodeTreeHelper. buildTree(Actor root)Builds the tree with the given root.protected static Node[]TreeHelper. buildTree(Node parent, Actor[] actors, boolean append)Builds the tree recursively.static NodeTreeHelper. buildTree(Node parent, Actor actor, boolean append)Builds the tree recursively.booleanTreeOperations. checkForStandalones(Actor[] actors, Node parent)Checks whether standalones can be placed beneath the parent actor.booleanTreeOperations. checkForStandalones(Actor actor, Node parent)Checks whether standalones can be placed beneath the parent actor.voidTreeOperations. externalizeActor(TreePath[] paths, Actor suggestion)Opens a new FlowEditor window with the currently selected sub-flow.protected voidTreeOperations. externalizeActor(TreePath path, boolean checkCallActors, Actor suggestion)Opens a new FlowEditor window with the currently selected sub-flow.voidTreeOperations. externalizeActor(TreePath path, Actor suggestion)Opens a new FlowEditor window with the currently selected sub-flow.protected Renderer.ActorIconRenderer. getIcon(Actor parent, Actor actor, boolean collapsed)Tries to obtain the icon for the given actor.StringClipboardActorContainer. set(int index, Actor actor)Sets the actor at the given position.voidNode. setActor(Actor value)Sets the actor.voidTree. setActor(Actor value)Sets the flow actor to display.voidClipboardActorContainer. setActors(Actor[] value)Sets the actors.static StringNode. strippedCommandLine(Actor actor)Returns the commandline of the stripped down version of the actor, i.e., for ActorHandlers, without any sub-actors.AbstractActorTemplate[]ActorTemplateSuggestion. suggest(Actor parent, int position, Actor[] actors)Returns the suggested actor templates.voidTreeOperations. swapActor(TreePath sourcePath, Actor target)Swaps the actor handler of the node with the new node, keeping the children intact, as well as some basic options.Constructors in adams.gui.flow.tree with parameters of type Actor Constructor Description Node(Tree owner, Actor actor)Initializes the node.Node(Tree owner, Actor actor, String commandline)Initializes the node.Tree(FlowPanel owner, Actor root)Initializes the tree. -
Uses of Actor in adams.gui.flow.tree.actorswap
Fields in adams.gui.flow.tree.actorswap with type parameters of type Actor Modifier and Type Field Description protected static HashMap<Class,List<Actor>>AbstractActorSwapSuggestion. m_Cachefor caching suggestions.Methods in adams.gui.flow.tree.actorswap that return types with arguments of type Actor Modifier and Type Method Description protected abstract List<Actor>AbstractActorSwapSuggestion. doSuggest(Actor current)Performs the actual search for candidates.protected List<Actor>ActorHandlerSuggestion. doSuggest(Actor current)Performs the actual search for candidates.protected List<Actor>SimpleSuggestion. doSuggest(Actor current)Performs the actual search for candidates.List<Actor>AbstractActorSwapSuggestion. suggest(Actor current)Searches for potential candidates for swaps.static List<Actor>AbstractActorSwapSuggestion. suggestAll(Actor current)Searches for potential candidates for swaps.Methods in adams.gui.flow.tree.actorswap with parameters of type Actor Modifier and Type Method Description protected abstract List<Actor>AbstractActorSwapSuggestion. doSuggest(Actor current)Performs the actual search for candidates.protected List<Actor>ActorHandlerSuggestion. doSuggest(Actor current)Performs the actual search for candidates.protected List<Actor>SimpleSuggestion. doSuggest(Actor current)Performs the actual search for candidates.List<Actor>AbstractActorSwapSuggestion. suggest(Actor current)Searches for potential candidates for swaps.static List<Actor>AbstractActorSwapSuggestion. suggestAll(Actor current)Searches for potential candidates for swaps. -
Uses of Actor in adams.gui.flow.tree.keyboardaction
Fields in adams.gui.flow.tree.keyboardaction declared as Actor Modifier and Type Field Description protected ActorAbstractKeyboardActionWithActor. m_Actorthe actor to use.Methods in adams.gui.flow.tree.keyboardaction that return Actor Modifier and Type Method Description ActorAbstractKeyboardActionWithActor. getActor()Returns the actor of the action.protected abstract ActorAbstractKeyboardActionWithActor. getDefaultActor()Returns the default actor of the action.protected ActorAddActorAfter. getDefaultActor()Returns the default actor of the action.protected ActorAddActorBeneath. getDefaultActor()Returns the default actor of the action.protected ActorAddActorHere. getDefaultActor()Returns the default actor of the action.protected ActorEncloseActor. getDefaultActor()Returns the default actor of the action.protected ActorPullUpActor. getDefaultActor()Returns the default actor of the action.Methods in adams.gui.flow.tree.keyboardaction with parameters of type Actor Modifier and Type Method Description protected voidAbstractQuickSearchActor. addActor(StateContainer state, Actor actor, TreeOperations.InsertPosition position)Inserts the actorvoidAbstractKeyboardActionWithActor. setActor(Actor value)Sets the actor of the action.voidEncloseActor. setActor(Actor value)Sets the actor of the action.voidPullUpActor. setActor(Actor value)Sets the actor of the action. -
Uses of Actor in adams.gui.flow.tree.menu
Methods in adams.gui.flow.tree.menu that return Actor Modifier and Type Method Description protected ActorAbstractAddMostCommonActorAction. newActor(String classname)Instantiates the specified actor if not blacklisted.protected abstract ActorAbstractCompareActors. nodeToActor(Node node)Turns the node into an actor.protected ActorCompareJustActors. nodeToActor(Node node)Turns the node into an actor.protected ActorCompareSubFlows. nodeToActor(Node node)Turns the node into an actor.protected ActorAbstractAddBreakpointAction. suggestBreakpoint(TreePath path, TreeOperations.InsertPosition position)Tries to figure what actors fit best in the tree at the given position.Methods in adams.gui.flow.tree.menu with parameters of type Actor Modifier and Type Method Description protected List<String>FindUsages. findActorLocations(Actor actor)Locates all the occurrences of this actor.protected List<String>FindUsages. findStorageNames(Actor actor)Tries to locate the storage name in the actor's options.protected List<String>FindUsages. findVariableNames(Actor actor)Tries to locate the variable names in the actor's options.protected StringFindUsages. getActorReference(Actor actor, Actor parent)Returns the actor reference, if applicable.protected AbstractActorReference[]GoTo. getReferences(Actor actor)Returns all the actor references for this actor.protected JMenuItemAbstractAddMostCommonActorAction. newMenuItem(List<JMenuItem> menuitems, Actor actor)Creates a new menuitem. -
Uses of Actor in adams.gui.flow.tree.postprocessor
Methods in adams.gui.flow.tree.postprocessor with parameters of type Actor Modifier and Type Method Description abstract booleanAbstractEditPostProcessor. applies(Actor parent, Actor oldActor, Actor newActor)Checks whether this post processor scheme applies to the current situation.booleanCallableActorRenamed. applies(Actor parent, Actor oldActor, Actor newActor)Checks whether this post processor scheme applies to the current situation.booleanEventRenamed. applies(Actor parent, Actor oldActor, Actor newActor)Checks whether this post processor scheme applies to the current situation.booleanStorageValueRenamed. applies(Actor parent, Actor oldActor, Actor newActor)Checks whether this post processor scheme applies to the current situation.booleanVariableRenamed. applies(Actor parent, Actor oldActor, Actor newActor)Checks whether this post processor scheme applies to the current situation.static booleanAbstractEditPostProcessor. apply(Tree tree, Actor parent, Actor oldActor, Actor newActor)Applies all the post-processors, if applicable.protected abstract booleanAbstractEditPostProcessor. doPostProcess(Tree tree, Actor parent, Actor oldActor, Actor newActor)Post-processes the tree.protected booleanCallableActorRenamed. doPostProcess(Tree tree, Actor parent, Actor oldActor, Actor newActor)Post-processes the tree.protected booleanEventRenamed. doPostProcess(Tree tree, Actor parent, Actor oldActor, Actor newActor)Post-processes the tree.protected booleanStorageValueRenamed. doPostProcess(Tree tree, Actor parent, Actor oldActor, Actor newActor)Post-processes the tree.protected booleanVariableRenamed. doPostProcess(Tree tree, Actor parent, Actor oldActor, Actor newActor)Post-processes the tree.protected StorageNameStorageValueRenamed. getStorageName(Actor actor)Extracts the variable name (the option) from the actor.protected VariableNameVariableRenamed. getVariableName(Actor actor)Extracts the variable name (the option) from the actor.booleanAbstractEditPostProcessor. postProcess(Tree tree, Actor parent, Actor oldActor, Actor newActor)Post-processes the tree. -
Uses of Actor in adams.gui.flow.tree.quickaction
Methods in adams.gui.flow.tree.quickaction with parameters of type Actor Modifier and Type Method Description protected voidAbstractTreeQuickMenuItemAction. updateSelectedActor(Actor newActor)Updates the currently selected actor and refreshes the tree. -
Uses of Actor in adams.gui.flow.tree.record.add
Methods in adams.gui.flow.tree.record.add with parameters of type Actor Modifier and Type Method Description protected abstract voidAbstractRecordActorAdded. record(Actor added, Actor parent, Actor before, Actor after, TreeOperations.InsertPosition position)Records the actor that was added.protected voidMostCommon. record(Actor added, Actor parent, Actor before, Actor after, TreeOperations.InsertPosition position)Records the actor that was added.protected voidSimpleLog. record(Actor added, Actor parent, Actor before, Actor after, TreeOperations.InsertPosition position)Records the actor that was added.protected voidSimpleLog. record(Actor actor, StringBuilder line)Adds details about an actor. -
Uses of Actor in adams.gui.goe
Methods in adams.gui.goe with parameters of type Actor Modifier and Type Method Description protected static booleanFlowHelper. findNodesMatch(Class type, HashSet<Class> restrict, Actor actor)Checks whether the actor is a match for the type/restrictions. -
Uses of Actor in adams.gui.goe.classtree
Fields in adams.gui.goe.classtree with type parameters of type Actor Modifier and Type Field Description protected static Map<Class,Actor>ActorClassTreeFilter. m_ClassActorCachefor caching class/instance relationship. -
Uses of Actor in adams.gui.goe.popupmenu
Methods in adams.gui.goe.popupmenu with parameters of type Actor Modifier and Type Method Description protected voidSwapActor. swapActor(PropertyEditor editor, Actor source, Actor target)Performs the swap. -
Uses of Actor in adams.gui.menu
Methods in adams.gui.menu that return Actor Modifier and Type Method Description ActorPlotAttributeVsAttribute. getActor()Used to create an instance of a specific actor.ActorSystemPerformance. getActor()Used to create an instance of a specific actor. -
Uses of Actor in adams.gui.tools
Fields in adams.gui.tools with type parameters of type Actor Modifier and Type Field Description protected List<Actor>SpreadSheetProcessorPanel. m_GeneratedFlowsthe generated flows (eg charts).Methods in adams.gui.tools with parameters of type Actor Modifier and Type Method Description voidSpreadSheetProcessorPanel. addGeneratedFlow(Actor flow)Adds the flow to the list of flows to clean up.voidSpreadSheetViewerPanel. filterData(String oldTitle, Object input, Actor filter)Filters the data with the transformer and adds the generated output as new tab. -
Uses of Actor in adams.gui.tools.spreadsheetprocessor.processors
Methods in adams.gui.tools.spreadsheetprocessor.processors that return Actor Modifier and Type Method Description ActorFlowProcessor. getCurrentFlow()Returns the flow.Methods in adams.gui.tools.spreadsheetprocessor.processors with parameters of type Actor Modifier and Type Method Description voidFlowProcessor. setCurrentFlow(Actor value)Sets the flow. -
Uses of Actor in adams.gui.visualization.core
Fields in adams.gui.visualization.core declared as Actor Modifier and Type Field Description protected ActorMultiPaintlet. m_Actorthe actor that this paintlet belongs to.protected ActorTextOverlayPaintlet. m_Actorthe actor that this paintlet belongs to.Methods in adams.gui.visualization.core that return Actor Modifier and Type Method Description ActorFlowAwarePaintlet. getActor()Returns the owning actor.ActorMultiPaintlet. getActor()Returns the owning actor.ActorTextOverlayPaintlet. getActor()Returns the owning actor.Methods in adams.gui.visualization.core with parameters of type Actor Modifier and Type Method Description voidFlowAwarePaintlet. setActor(Actor actor)Sets the owning actor.voidMultiPaintlet. setActor(Actor actor)Sets the owning actor.voidTextOverlayPaintlet. setActor(Actor actor)Sets the owning actor. -
Uses of Actor in adams.gui.visualization.sequence
Fields in adams.gui.visualization.sequence declared as Actor Modifier and Type Field Description protected ActorByNamePaintlet. m_Actorthe actor the paintlet belongs to.protected ActorPaintletWithFixedXRange. m_Actorthe actor the paintlet belongs to.protected ActorPaintletWithFixedXYRange. m_Actorthe actor the paintlet belongs to.protected ActorPaintletWithFixedYRange. m_Actorthe actor the paintlet belongs to.Methods in adams.gui.visualization.sequence that return Actor Modifier and Type Method Description ActorByNamePaintlet. getActor()Returns the owning actor.ActorPaintletWithFixedXRange. getActor()Returns the owning actor.ActorPaintletWithFixedYRange. getActor()Returns the owning actor.Methods in adams.gui.visualization.sequence with parameters of type Actor Modifier and Type Method Description voidByNamePaintlet. setActor(Actor actor)Sets the owning actor.voidPaintletWithFixedXRange. setActor(Actor actor)Sets the owning actor.voidPaintletWithFixedYRange. setActor(Actor actor)Sets the owning actor. -
Uses of Actor in adams.gui.visualization.timeseries
Fields in adams.gui.visualization.timeseries declared as Actor Modifier and Type Field Description protected ActorPaintletWithFixedXRange. m_Actorthe actor the paintlet belongs to.protected ActorPaintletWithFixedXYRange. m_Actorthe actor the paintlet belongs to.protected ActorPaintletWithFixedYRange. m_Actorthe actor the paintlet belongs to.Methods in adams.gui.visualization.timeseries that return Actor Modifier and Type Method Description ActorPaintletWithFixedXRange. getActor()Returns the owning actor.ActorPaintletWithFixedYRange. getActor()Returns the owning actor.Methods in adams.gui.visualization.timeseries with parameters of type Actor Modifier and Type Method Description voidPaintletWithFixedXRange. setActor(Actor actor)Sets the owning actor.voidPaintletWithFixedYRange. setActor(Actor actor)Sets the owning actor. -
Uses of Actor in adams.multiprocess
Fields in adams.multiprocess declared as Actor Modifier and Type Field Description protected ActorAbstractJobRunner. m_FlowContextthe flow context.protected ActorWekaCrossValidationExecution. m_FlowContextthe flow context.protected ActorWekaCrossValidationJob. m_FlowContextthe flow context.Methods in adams.multiprocess that return Actor Modifier and Type Method Description ActorAbstractJobRunner. getFlowContext()Return the flow context, if any.ActorJobRunner. getFlowContext()Return the flow context, if any.ActorWekaCrossValidationExecution. getFlowContext()Returns the flow context, if any.ActorWekaCrossValidationJob. getFlowContext()Returns the flow context, if any.Methods in adams.multiprocess with parameters of type Actor Modifier and Type Method Description voidAbstractJobRunner. setFlowContext(Actor value)Sets the flow context, if any.voidJobRunner. setFlowContext(Actor value)Sets the flow context, if any.voidWekaCrossValidationExecution. setFlowContext(Actor value)Sets the flow context.voidWekaCrossValidationJob. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.opt.genetic
Fields in adams.opt.genetic declared as Actor Modifier and Type Field Description protected ActorAbstractClassifierBasedGeneticAlgorithm. m_FlowContextthe flow context.Methods in adams.opt.genetic that return Actor Modifier and Type Method Description ActorAbstractClassifierBasedGeneticAlgorithm. getFlowContext()Return the flow context, if any.Methods in adams.opt.genetic with parameters of type Actor Modifier and Type Method Description voidAbstractClassifierBasedGeneticAlgorithm. setFlowContext(Actor value)Sets the flow context, if any. -
Uses of Actor in adams.opt.genetic.setupupload
Fields in adams.opt.genetic.setupupload declared as Actor Modifier and Type Field Description protected ActorAbstractSetupUpload. m_FlowContextthe flow context.Methods in adams.opt.genetic.setupupload that return Actor Modifier and Type Method Description ActorAbstractSetupUpload. getFlowContext()Return the flow context, if any.Methods in adams.opt.genetic.setupupload with parameters of type Actor Modifier and Type Method Description voidAbstractSetupUpload. setFlowContext(Actor value)Sets the flow context, if any. -
Uses of Actor in adams.parser
Fields in adams.parser declared as Actor Modifier and Type Field Description Actor[]ActorSuggestion.SuggestionData. actorsthe actors on the same level.protected Actor[]ActorSuggestion. m_Actorsthe actors in which the proposed actor gets inserted.protected Actor[]ActorTemplateSuggestion. m_Actorsthe actors in which the proposed actor template gets inserted.protected Actor[]ExternalActorSuggestion. m_Actorsthe actors in which the proposed actor gets inserted.protected ActorActorSuggestion. m_Parentthe parent of the proposed actor.protected ActorActorTemplateSuggestion. m_Parentthe parent of the proposed actor template.protected ActorExternalActorSuggestion. m_Parentthe parent of the proposed actor.ActorActorSuggestion.SuggestionData. parentthe parent.Methods in adams.parser that return Actor Modifier and Type Method Description ActorActorSuggestion. evaluate()Performs the evaluation.static Actor[]ActorSuggestion. evaluate(String[] expr, ActorSuggestion.SuggestionData data)Performs the evaluation.static ActorActorSuggestion. evaluate(String expr, ActorSuggestion.SuggestionData data)Performs the evaluation.ActorExternalActorSuggestion. evaluate()Performs the evaluation.static Actor[]ExternalActorSuggestion. evaluate(String[] expr, ActorSuggestion.SuggestionData data)Performs the evaluation.static ActorExternalActorSuggestion. evaluate(String expr, ActorSuggestion.SuggestionData data)Performs the evaluation.Actor[]ActorSuggestion. getActors()Returns the actors to insert the proposed actor in.Actor[]ActorTemplateSuggestion. getActors()Returns the actors to insert the proposed actor in.Actor[]ExternalActorSuggestion. getActors()Returns the actors to insert the proposed actor in.ActorActorSuggestion. getParent()Returns the current parent in use.ActorActorTemplateSuggestion. getParent()Returns the current parent in use.ActorExternalActorSuggestion. getParent()Returns the current parent in use.Methods in adams.parser with parameters of type Actor Modifier and Type Method Description static AbstractActorTemplate[]ActorTemplateSuggestion. evaluate(String[] expr, Actor parent, int position, Actor[] actors)Performs the evaluation.static AbstractActorTemplateActorTemplateSuggestion. evaluate(String expr, Actor parent, int position, Actor[] actors)Performs the evaluation.voidActorSuggestion. setActors(Actor[] value)Sets the actors to insert the proposed actor in.voidActorTemplateSuggestion. setActors(Actor[] value)Sets the actors to insert the proposed actor in.voidExternalActorSuggestion. setActors(Actor[] value)Sets the actors to insert the proposed actor in.voidActorSuggestion. setParent(Actor value)Sets the parent to use.voidActorTemplateSuggestion. setParent(Actor value)Sets the parent to use.voidExternalActorSuggestion. setParent(Actor value)Sets the parent to use. -
Uses of Actor in adams.parser.actorsuggestion
Fields in adams.parser.actorsuggestion declared as Actor Modifier and Type Field Description protected Actor[]Parser. m_Actorsall the current actors in which to insert/add to the proposed actor.protected ActorParser. m_LastParentthe last parent used.protected ActorParser. m_Parentthe parent of the proposed actor.protected ActorParser. m_Resultfor storing the result of the expression.Methods in adams.parser.actorsuggestion that return Actor Modifier and Type Method Description Actor[]Parser. getActors()Returns the actors in which to insert the proposed actor.ActorParser. getParent()Returns the parent of the proposed actor.ActorParser. getResult()Returns the result of the evaluation.Methods in adams.parser.actorsuggestion with parameters of type Actor Modifier and Type Method Description voidParser. setActors(Actor[] value)Sets the actors in which to insert the proposed actor.voidParser. setParent(Actor value)Sets the parent of the proposed actor.voidParser. setResult(Actor value)Sets the result of the evaluation. -
Uses of Actor in adams.parser.externalactorsuggestion
Fields in adams.parser.externalactorsuggestion declared as Actor Modifier and Type Field Description protected Actor[]Parser. m_Actorsall the current actors in which to insert/add to the proposed actor.protected ActorParser. m_LastParentthe last parent used.protected ActorParser. m_Parentthe parent of the proposed actor.protected ActorParser. m_Resultfor storing the result of the expression.Methods in adams.parser.externalactorsuggestion that return Actor Modifier and Type Method Description Actor[]Parser. getActors()Returns the actors in which to insert the proposed actor.ActorParser. getParent()Returns the parent of the proposed actor.ActorParser. getResult()Returns the result of the evaluation.Methods in adams.parser.externalactorsuggestion with parameters of type Actor Modifier and Type Method Description voidParser. setActors(Actor[] value)Sets the actors in which to insert the proposed actor.voidParser. setParent(Actor value)Sets the parent of the proposed actor.voidParser. setResult(Actor value)Sets the result of the evaluation. -
Uses of Actor in adams.parser.templatesuggestion
Fields in adams.parser.templatesuggestion declared as Actor Modifier and Type Field Description protected Actor[]Parser. m_Actorsall the current nodes in which to insert/add to the proposed actor.protected ActorParser. m_Parentthe parent of the where to suggest the template.Methods in adams.parser.templatesuggestion that return Actor Modifier and Type Method Description Actor[]Parser. getActors()Returns the actors in which to insert the proposed template.ActorParser. getParent()Returns the parent of the proposed template.Methods in adams.parser.templatesuggestion with parameters of type Actor Modifier and Type Method Description voidParser. setActors(Actor[] value)Sets the actors in which to insert the proposed template.voidParser. setParent(Actor value)Sets the parent of the proposed template. -
Uses of Actor in adams.scripting.command
Fields in adams.scripting.command declared as Actor Modifier and Type Field Description protected ActorAbstractFlowAwareCommand. m_FlowContextthe flow context.protected ActorAbstractFlowAwareCommandWithResponse. m_FlowContextthe flow context.Methods in adams.scripting.command that return Actor Modifier and Type Method Description ActorAbstractFlowAwareCommand. getFlowContext()Returns the flow context, if any.ActorAbstractFlowAwareCommandWithResponse. getFlowContext()Returns the flow context, if any.protected ActorAbstractRemoteCommandOnFlowWithResponse. retrieveFlow(boolean loadFromDisk)Retrieves the flow.Methods in adams.scripting.command with parameters of type Actor Modifier and Type Method Description voidAbstractFlowAwareCommand. setFlowContext(Actor value)Sets the flow context.voidAbstractFlowAwareCommandWithResponse. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.scripting.command.flow
Fields in adams.scripting.command.flow declared as Actor Modifier and Type Field Description protected ActorRemoteFlowExecution. m_Actorthe instantiated flow.protected ActorGetFlow. m_Flowthe flow.Methods in adams.scripting.command.flow with parameters of type Actor Modifier and Type Method Description voidRemoteFlowExecution. setActor(Actor value)Sets the actor to use instead of loading it from disk. -
Uses of Actor in adams.scripting.engine
Fields in adams.scripting.engine declared as Actor Modifier and Type Field Description protected ActorAbstractScriptingEngine. m_FlowContextthe flow context.Methods in adams.scripting.engine that return Actor Modifier and Type Method Description ActorAbstractScriptingEngine. getFlowContext()Returns the flow context, if any.ActorRemoteScriptingEngine. getFlowContext()Returns the flow context, if any.Methods in adams.scripting.engine with parameters of type Actor Modifier and Type Method Description voidAbstractScriptingEngine. setFlowContext(Actor value)Sets the flow context.voidRemoteScriptingEngine. setFlowContext(Actor value)Sets the flow context. -
Uses of Actor in adams.scripting.requesthandler
Fields in adams.scripting.requesthandler declared as Actor Modifier and Type Field Description protected ActorCallableActorsHandler. m_CallableActorthe callable actor.Methods in adams.scripting.requesthandler that return Actor Modifier and Type Method Description protected ActorCallableActorsHandler. findCallableActor()Tries to find the callable actor referenced by its global name.ActorCallableActorsHandler. getCallableActor()Returns the currently set callable actor. -
Uses of Actor in adams.scripting.responsehandler
Fields in adams.scripting.responsehandler declared as Actor Modifier and Type Field Description protected ActorCallableActorsHandler. m_CallableActorthe callable actor.Methods in adams.scripting.responsehandler that return Actor Modifier and Type Method Description protected ActorCallableActorsHandler. findCallableActor()Tries to find the callable actor referenced by its global name.ActorCallableActorsHandler. getCallableActor()Returns the currently set callable actor.
-