Name

adams.flow.control.LocalScopeTransformer

Synopsis

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.

Additional information

Flow input/output:
- input: adams.flow.core.Unknown
- output: adams.flow.core.Unknown
Actor handler information:
- Actor execution: SEQUENTIAL
- Standalones allowed: false
- Source allowed: false
- Forwards input: true
Stop restriction: always

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	LocalScopeTransformer

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• 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.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• actors
  

  The actors to execute in the loop.

  command-line	-actor <adams.flow.core.Actor> [-actor ...]
  default

  
  
• 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.

  command-line	-scope-handling-variables <EMPTY|COPY|SHARE>
  default	EMPTY

  
  
• variablesFilter
  

  The regular expression that variable names must match in order to get into the local scope (when using COPY).

  command-line	-variables-filter <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• propagateVariables
  

  If enabled and variables are not shared with outer scope, variables that match the specified regular expression get propagated to the outer scope.

  command-line	-propagate-variables <boolean>
  default	false

  
  
• variablesRegExp
  

  The regular expression that variable names must match in order to get propagated.

  command-line	-variables-regexp <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• 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.

  command-line	-scope-handling-storage <EMPTY|COPY|SHARE>
  default	EMPTY

  
  
• storageFilter
  

  The regular expression that storage item names must match in order to get into the local scope (when using COPY).

  command-line	-storage-filter <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• 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.

  command-line	-propagate-storage <boolean>
  default	false

  
  
• storageRegExp
  

  The regular expression that the names of storage items must match in order to get propagated.

  command-line	-storage-regexp <adams.core.base.BaseRegExp>
  default	.*
  more	https://docs.oracle.com/javase/tutorial/essential/regex/
  	https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html

  
  
• finishBeforeStopping
  

  If enabled, actor first finishes processing all data before stopping.

  command-line	-finish-before-stopping <boolean>
  default	false

  
  
• stoppingTimeout
  

  The timeout in milliseconds when waiting for actors to finish (<= 0 for infinity; see 'finishBeforeStopping').

  command-line	-stopping-timeout <int>
  default	-1
  minimum	-1

  
  
• stoppingWarningInterval
  

  The interval in milliseconds to output logging warnings if the actors haven't stopped yet (and no stopping timeout set); no warning if <= 0.

  command-line	-stopping-warning-interval <int>
  default	10000
  minimum	-1