Package adams.flow.control

Class LocalScopeTransformer

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesHandler, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, LocalScopeHandler, ProgrammaticLocalScope, ScopeHandler, StorageHandler, Actor, ActorHandler, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OutputProducer, StopRestrictor, SubFlowWrapUp, Serializable, Comparable
    public class LocalScopeTransformer
extends LocalScopeSubProcess
    Provides a local scope for the sub-actors.
    It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope. However, storage items from caches cannot be propagated. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: LocalScopeTransformer
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -actor <adams.flow.core.Actor> [-actor ...] (property: actors)
    The actors to execute in the loop.
    default:
 
    -scope-handling-variables <EMPTY|COPY|SHARE> (property: scopeHandlingVariables)
    Defines how variables are handled in the local scope; whether to start with
    empty set, a copy of the outer scope variables or share variables with the
    outer scope.
    default: EMPTY
 
    -variables-filter <adams.core.base.BaseRegExp> (property: variablesFilter)
    The regular expression that variable names must match in order to get into
    the local scope (when using COPY).
    default: .*
 
    -propagate-variables <boolean> (property: propagateVariables)
    If enabled and variables are not shared with outer scope, variables that
    match the specified regular expression get propagated to the outer scope.
    default: false
 
    -variables-regexp <adams.core.base.BaseRegExp> (property: variablesRegExp)
    The regular expression that variable names must match in order to get propagated.
    default: .*
 
    -scope-handling-storage <EMPTY|COPY|SHARE> (property: scopeHandlingStorage)
    Defines how storage is handled in the local scope; whether to start with
    empty set, a (deep) copy of the outer scope storage or share the storage
    with the outer scope.
    default: EMPTY
 
    -storage-filter <adams.core.base.BaseRegExp> (property: storageFilter)
    The regular expression that storage item names must match in order to get
    into the local scope (when using COPY).
    default: .*
 
    -propagate-storage <boolean> (property: propagateStorage)
    If enabled and storage is not shared with outer scope, storage items which
    names match the specified regular expression get propagated to the outer
    scope.
    default: false
 
    -storage-regexp <adams.core.base.BaseRegExp> (property: storageRegExp)
    The regular expression that the names of storage items must match in order
    to get propagated.
    default: .*
 
    -finish-before-stopping <boolean> (property: finishBeforeStopping)
    If enabled, actor first finishes processing all data before stopping.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form