java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractActor
      - adams.flow.control.AbstractControlActor
        
        adams.flow.control.LocalScopeSubProcess

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

Direct Known Subclasses:: LocalScopeTransformer

public class LocalScopeSubProcess
extends AbstractControlActor
implements InputConsumer, OutputProducer, MutableActorHandler, VariablesHandler, StorageHandler, LocalScopeHandler, ProgrammaticLocalScope, StopRestrictor, AtomicExecution

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

Nested Class Summary
- Nested classes/interfaces inherited from interface adams.flow.control.ScopeHandler
  ScopeHandler.ScopeHandling

Field Summary

Fields
Modifier and Type	Field	Description
`protected SubProcess`	`m_Actors`	the actors to execute.
`protected CallableNamesRecorder`	`m_CallableNames`	the callable names.
`protected boolean`	`m_EnforceCallableNameCheck`	whether the callable name check is enforced.
`protected Storage`	`m_LocalStorage`	the storage for temporary data.
`protected FlowVariables`	`m_LocalVariables`	the variables manager.
`protected boolean`	`m_ProgrammaticLocalStorage`	whether the local storage was programmatically set.
`protected boolean`	`m_ProgrammaticLocalVariables`	whether the local vars were programmatically set.
`protected boolean`	`m_PropagateStorage`	whether to propagate variables from the local scope to the outer scope.
`protected boolean`	`m_PropagateVariables`	whether to propagate variables from the local scope to the outer scope.
`protected boolean`	`m_RestrictedStop`	whether a restricted stop occurred.
`protected ScopeHandler.ScopeHandling`	`m_ScopeHandlingStorage`	how to handle the storage.
`protected ScopeHandler.ScopeHandling`	`m_ScopeHandlingVariables`	how to handle the variables.
`protected BaseRegExp`	`m_StorageFilter`	the regular expression of the storage items to allow into the local scope.
`protected BaseRegExp`	`m_StorageRegExp`	the regular expression of the variables to propagate.
`protected BaseRegExp`	`m_VariablesFilter`	the regular expression of the variables to allow into the local scope.
`protected BaseRegExp`	`m_VariablesRegExp`	the regular expression of the variables to propagate.

Fields inherited from class adams.flow.control.AbstractControlActor
m_Compatibility, m_PauseStateManager, m_SetUpSubActors

Fields inherited from class adams.flow.core.AbstractActor
m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors
Constructor Description

LocalScopeSubProcess()
Default constructor.

LocalScopeSubProcess(String name)
Initializes with the specified name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Class[]`	`accepts()`	Returns the class that the consumer accepts.
`String`	`actorsTipText()`	Returns the tip text for this property.
`String`	`add(int index, Actor actor)`	Inserts the actor at the given position.
`String`	`add(Actor actor)`	Inserts the actor at the end.
`String`	`addCallableName(ActorHandler handler, Actor actor)`	Adds the callable name to the list of used ones.
`void`	`cleanUp()`	Cleans up after the execution has finished.
`Token`	`currentInput()`	Returns the current input token, if any.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected String`	`doExecute()`	Executes the flow item.
`String`	`finishBeforeStoppingTipText()`	Returns the tip text for this property.
`void`	`flushExecution()`	Stops the processing of tokens without stopping the flow.
`protected void`	`forceVariables(Variables value)`	Updates the Variables instance in use.
`Class[]`	`generates()`	Returns the class of objects that it generates.
`Actor`	`get(int index)`	Returns the actor at the given position.
`ActorHandlerInfo`	`getActorHandlerInfo()`	Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
`Actor[]`	`getActors()`	Returns the actors of the loop.
`boolean`	`getEnforceCallableNameCheck()`	Returns whether the check of callable names is enforced.
`boolean`	`getFinishBeforeStopping()`	Returns whether to finish processing before stopping execution.
`Variables`	`getLocalVariables()`	Returns the Variables instance to use.
`boolean`	`getPropagateStorage()`	Returns whether to propagate storage items from the local to the outer scope.
`boolean`	`getPropagateVariables()`	Returns whether to propagate variables from the local to the outer scope.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`ScopeHandler.ScopeHandling`	`getScopeHandlingStorage()`	Returns how storage is handled in the local scope.
`ScopeHandler.ScopeHandling`	`getScopeHandlingVariables()`	Returns how variables are handled in the local scope.
`int`	`getStoppingTimeout()`	Returns the timeout for waiting for the sub-flow to stop.
`int`	`getStoppingWarningInterval()`	Returns the interval for outputting warnings if the sub-flow hasn't stopped yet (and no stopping timeout set).
`Storage`	`getStorage()`	Returns the storage container.
`BaseRegExp`	`getStorageFilter()`	Returns the regular expression that storage item names must match to get into the local scope.
`BaseRegExp`	`getStorageRegExp()`	Returns the regular expression that storage item names must match to get propagated.
`Variables`	`getVariables()`	Returns the Variables instance to use.
`BaseRegExp`	`getVariablesFilter()`	Returns the regular expression that variable names must match to get into the local scope.
`BaseRegExp`	`getVariablesRegExp()`	Returns the regular expression that variable names must match to get propagated.
`String`	`globalInfo()`	Returns a string describing the object.
`boolean`	`hasInput()`	Returns whether an input token is currently present.
`boolean`	`hasPendingOutput()`	Checks whether there is pending output to be collected after executing the flow item.
`int`	`indexOf(String actor)`	Returns the index of the actor.
`protected void`	`initialize()`	Initializes the members.
`void`	`input(Token token)`	Does nothing.
`boolean`	`isCallableNameUsed(ActorHandler handler, Actor actor)`	Checks whether a callable name is already in use.
`boolean`	`isRestrictedStop()`	Returns whether the stop was a restricted one (that can be resumed).
`boolean`	`isRestrictingStops()`	Returns whether stops are being restricted.
`Token`	`output()`	Returns the generated token.
`protected String`	`postExecute()`	Post-execute hook.
`protected String`	`preExecute()`	Pre-execute hook.
`String`	`propagateStorageTipText()`	Returns the tip text for this property.
`String`	`propagateVariablesTipText()`	Returns the tip text for this property.
`Actor`	`remove(int index)`	Removes the actor at the given position and returns the removed object.
`void`	`removeAll()`	Removes all actors.
`protected void`	`reset()`	Resets the actor.
`void`	`restrictedStopExecution()`	Stops the (restricted) execution.
`void`	`restrictedStopExecution(String msg)`	Stops the (restricted) execution.
`String`	`scopeHandlingStorageTipText()`	Returns the tip text for this property.
`String`	`scopeHandlingVariablesTipText()`	Returns the tip text for this property.
`String`	`set(int index, Actor actor)`	Sets the actor at the given position.
`void`	`setActors(Actor[] value)`	Sets the actors of the loop.
`void`	`setEnforceCallableNameCheck(boolean value)`	Sets whether to enforce the callable name check.
`void`	`setFinishBeforeStopping(boolean value)`	Sets whether to finish processing before stopping execution.
`void`	`setLoggingLevel(LoggingLevel value)`	Sets the logging level.
`void`	`setPropagateStorage(boolean value)`	Sets whether to propagate storage items from the local to the outer scope.
`void`	`setPropagateVariables(boolean value)`	Sets whether to propagate variables from the local to the outer scope.
`void`	`setScopeHandlingStorage(ScopeHandler.ScopeHandling value)`	Sets how to handle storage in the local scope.
`void`	`setScopeHandlingVariables(ScopeHandler.ScopeHandling value)`	Sets how to handle variables into the local scope.
`void`	`setSkip(boolean value)`	Sets whether the transformation is skipped or not.
`void`	`setStoppingTimeout(int value)`	Sets the timeout for waiting for the sub-flow to stop.
`void`	`setStoppingWarningInterval(int value)`	Sets the interval for outputting warnings if the sub-flow hasn't stopped yet (and no stopping timeout set).
`void`	`setStorageFilter(BaseRegExp value)`	Sets the regular expression that storage item names must match to get into the local scope.
`void`	`setStorageRegExp(BaseRegExp value)`	Sets the regular expression that storage item names must match to get propagated.
`protected String`	`setUpSubActors()`	Gets called in the setUp() method.
`void`	`setVariablesFilter(BaseRegExp value)`	Sets the regular expression that variable names must match to get into the local scope.
`void`	`setVariablesRegExp(BaseRegExp value)`	Sets the regular expression that variable names must match to get propagated.
`int`	`size()`	Returns the size of the group.
`void`	`stopExecution()`	Stops the execution.
`String`	`stoppingTimeoutTipText()`	Returns the tip text for this property.
`String`	`stoppingWarningIntervalTipText()`	Returns the tip text for this property.
`String`	`storageFilterTipText()`	Returns the tip text for this property.
`String`	`storageRegExpTipText()`	Returns the tip text for this property.
`protected void`	`updateParent()`	Updates the parent of all actors in this group.
`void`	`useLocalStorage(Storage storage)`	The local storage to use.
`void`	`useLocalVariables(Variables variables)`	The local variables to use.
`String`	`variablesFilterTipText()`	Returns the tip text for this property.
`String`	`variablesRegExpTipText()`	Returns the tip text for this property.

Methods inherited from class adams.flow.control.AbstractControlActor
active, canInspectOptions, check, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, resumeExecution, setParent, setUp, wrapUp, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canPerformSetUpCheck, compareTo, configureLogger, equals, execute, finalUpdateVariables, findVariables, findVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setSilent, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor
compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.flow.core.ActorHandler
check, firstActive, lastActive

Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions

- Field Detail
  - m_Actors
```
protected SubProcess m_Actors
```
    the actors to execute.
  - m_LocalStorage
```
protected transient Storage m_LocalStorage
```
    the storage for temporary data.
  - m_LocalVariables
```
protected FlowVariables m_LocalVariables
```
    the variables manager.
  - m_ProgrammaticLocalStorage
```
protected boolean m_ProgrammaticLocalStorage
```
    whether the local storage was programmatically set.
  - m_ProgrammaticLocalVariables
```
protected boolean m_ProgrammaticLocalVariables
```
    whether the local vars were programmatically set.
  - m_CallableNames
```
protected CallableNamesRecorder m_CallableNames
```
    the callable names.
  - m_EnforceCallableNameCheck
```
protected boolean m_EnforceCallableNameCheck
```
    whether the callable name check is enforced.
  - m_ScopeHandlingVariables
```
protected ScopeHandler.ScopeHandling m_ScopeHandlingVariables
```
    how to handle the variables.
  - m_VariablesFilter
```
protected BaseRegExp m_VariablesFilter
```
    the regular expression of the variables to allow into the local scope.
  - m_ScopeHandlingStorage
```
protected ScopeHandler.ScopeHandling m_ScopeHandlingStorage
```
    how to handle the storage.
  - m_StorageFilter
```
protected BaseRegExp m_StorageFilter
```
    the regular expression of the storage items to allow into the local scope.
  - m_PropagateVariables
```
protected boolean m_PropagateVariables
```
    whether to propagate variables from the local scope to the outer scope.
  - m_VariablesRegExp
```
protected BaseRegExp m_VariablesRegExp
```
    the regular expression of the variables to propagate.
  - m_PropagateStorage
```
protected boolean m_PropagateStorage
```
    whether to propagate variables from the local scope to the outer scope.
  - m_StorageRegExp
```
protected BaseRegExp m_StorageRegExp
```
    the regular expression of the variables to propagate.
  - m_RestrictedStop
```
protected boolean m_RestrictedStop
```
    whether a restricted stop occurred.
- Constructor Detail
  - LocalScopeSubProcess
```
public LocalScopeSubProcess()
```
    Default constructor.
  - LocalScopeSubProcess
```
public LocalScopeSubProcess(String name)
```
    Initializes with the specified name.
    
    Parameters:
    
    name - the name to use
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractActor
  - initialize
```
protected void initialize()
```
    Initializes the members.
    
    Overrides:
    
    initialize in class AbstractControlActor
  - reset
```
protected void reset()
```
    Resets the actor.
    
    Overrides:
    
    reset in class AbstractControlActor
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the actor, which will be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface Actor
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Overrides:
    
    getQuickInfo in class AbstractActor
    
    Returns:
    
    null if no info available, otherwise short string
  - setLoggingLevel
```
public void setLoggingLevel(LoggingLevel value)
```
    Sets the logging level.
    
    Specified by:
    
    setLoggingLevel in interface LoggingLevelHandler
    
    Overrides:
    
    setLoggingLevel in class AbstractOptionHandler
    
    Parameters:
    
    value - the level
  - setSkip
```
public void setSkip(boolean value)
```
    Sets whether the transformation is skipped or not.
    
    Specified by:
    
    setSkip in interface Actor
    
    Overrides:
    
    setSkip in class AbstractActor
    
    Parameters:
    
    value - true if transformation is to be skipped
  - setActors
```
public void setActors(Actor[] value)
```
    Sets the actors of the loop.
    
    Parameters:
    
    value - the actors
  - getActors
```
public Actor[] getActors()
```
    Returns the actors of the loop.
    
    Returns:
    
    the actors
  - actorsTipText
```
public String actorsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setScopeHandlingVariables
```
public void setScopeHandlingVariables(ScopeHandler.ScopeHandling value)
```
    Sets how to handle variables into the local scope.
    
    Specified by:
    
    setScopeHandlingVariables in interface LocalScopeHandler
    
    Parameters:
    
    value - the scope handling
  - getScopeHandlingVariables
```
public ScopeHandler.ScopeHandling getScopeHandlingVariables()
```
    Returns how variables are handled in the local scope.
    
    Specified by:
    
    getScopeHandlingVariables in interface LocalScopeHandler
    
    Returns:
    
    the scope handling
  - scopeHandlingVariablesTipText
```
public String scopeHandlingVariablesTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    scopeHandlingVariablesTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setVariablesFilter
```
public void setVariablesFilter(BaseRegExp value)
```
    Sets the regular expression that variable names must match to get into the local scope.
    
    Specified by:
    
    setVariablesFilter in interface LocalScopeHandler
    
    Parameters:
    
    value - the expression
  - getVariablesFilter
```
public BaseRegExp getVariablesFilter()
```
    Returns the regular expression that variable names must match to get into the local scope.
    
    Specified by:
    
    getVariablesFilter in interface LocalScopeHandler
    
    Returns:
    
    the expression
  - variablesFilterTipText
```
public String variablesFilterTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    variablesFilterTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPropagateVariables
```
public void setPropagateVariables(boolean value)
```
    Sets whether to propagate variables from the local to the outer scope.
    
    Specified by:
    
    setPropagateVariables in interface LocalScopeHandler
    
    Parameters:
    
    value - if true then variables get propagated
  - getPropagateVariables
```
public boolean getPropagateVariables()
```
    Returns whether to propagate variables from the local to the outer scope.
    
    Specified by:
    
    getPropagateVariables in interface LocalScopeHandler
    
    Returns:
    
    true if variables get propagated
  - propagateVariablesTipText
```
public String propagateVariablesTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    propagateVariablesTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setVariablesRegExp
```
public void setVariablesRegExp(BaseRegExp value)
```
    Sets the regular expression that variable names must match to get propagated.
    
    Specified by:
    
    setVariablesRegExp in interface LocalScopeHandler
    
    Parameters:
    
    value - the expression
  - getVariablesRegExp
```
public BaseRegExp getVariablesRegExp()
```
    Returns the regular expression that variable names must match to get propagated.
    
    Specified by:
    
    getVariablesRegExp in interface LocalScopeHandler
    
    Returns:
    
    the expression
  - variablesRegExpTipText
```
public String variablesRegExpTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    variablesRegExpTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setScopeHandlingStorage
```
public void setScopeHandlingStorage(ScopeHandler.ScopeHandling value)
```
    Sets how to handle storage in the local scope.
    
    Specified by:
    
    setScopeHandlingStorage in interface LocalScopeHandler
    
    Parameters:
    
    value - the scope handling
  - getScopeHandlingStorage
```
public ScopeHandler.ScopeHandling getScopeHandlingStorage()
```
    Returns how storage is handled in the local scope.
    
    Specified by:
    
    getScopeHandlingStorage in interface LocalScopeHandler
    
    Returns:
    
    the scope handling
  - scopeHandlingStorageTipText
```
public String scopeHandlingStorageTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    scopeHandlingStorageTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setStorageFilter
```
public void setStorageFilter(BaseRegExp value)
```
    Sets the regular expression that storage item names must match to get into the local scope.
    
    Specified by:
    
    setStorageFilter in interface LocalScopeHandler
    
    Parameters:
    
    value - the expression
  - getStorageFilter
```
public BaseRegExp getStorageFilter()
```
    Returns the regular expression that storage item names must match to get into the local scope.
    
    Specified by:
    
    getStorageFilter in interface LocalScopeHandler
    
    Returns:
    
    the expression
  - storageFilterTipText
```
public String storageFilterTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    storageFilterTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setPropagateStorage
```
public void setPropagateStorage(boolean value)
```
    Sets whether to propagate storage items from the local to the outer scope.
    
    Specified by:
    
    setPropagateStorage in interface LocalScopeHandler
    
    Parameters:
    
    value - if true then storage items get propagated
  - getPropagateStorage
```
public boolean getPropagateStorage()
```
    Returns whether to propagate storage items from the local to the outer scope.
    
    Specified by:
    
    getPropagateStorage in interface LocalScopeHandler
    
    Returns:
    
    true if storage items get propagated
  - propagateStorageTipText
```
public String propagateStorageTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    propagateStorageTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setStorageRegExp
```
public void setStorageRegExp(BaseRegExp value)
```
    Sets the regular expression that storage item names must match to get propagated.
    
    Specified by:
    
    setStorageRegExp in interface LocalScopeHandler
    
    Parameters:
    
    value - the expression
  - getStorageRegExp
```
public BaseRegExp getStorageRegExp()
```
    Returns the regular expression that storage item names must match to get propagated.
    
    Specified by:
    
    getStorageRegExp in interface LocalScopeHandler
    
    Returns:
    
    the expression
  - storageRegExpTipText
```
public String storageRegExpTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    storageRegExpTipText in interface LocalScopeHandler
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setFinishBeforeStopping
```
public void setFinishBeforeStopping(boolean value)
```
    Sets whether to finish processing before stopping execution.
    
    Specified by:
    
    setFinishBeforeStopping in interface AtomicExecution
    
    Parameters:
    
    value - if true then actor finishes processing first
  - getFinishBeforeStopping
```
public boolean getFinishBeforeStopping()
```
    Returns whether to finish processing before stopping execution.
    
    Specified by:
    
    getFinishBeforeStopping in interface AtomicExecution
    
    Returns:
    
    true if actor finishes processing first
  - finishBeforeStoppingTipText
```
public String finishBeforeStoppingTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    finishBeforeStoppingTipText in interface AtomicExecution
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setStoppingTimeout
```
public void setStoppingTimeout(int value)
```
    Sets the timeout for waiting for the sub-flow to stop.
    
    Specified by:
    
    setStoppingTimeout in interface AtomicExecution
    
    Parameters:
    
    value - timeout in milliseconds (<= 0 for infinity)
  - getStoppingTimeout
```
public int getStoppingTimeout()
```
    Returns the timeout for waiting for the sub-flow to stop.
    
    Specified by:
    
    getStoppingTimeout in interface AtomicExecution
    
    Returns:
    
    timeout in milliseconds (<= 0 for infinity)
  - stoppingTimeoutTipText
```
public String stoppingTimeoutTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    stoppingTimeoutTipText in interface AtomicExecution
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setStoppingWarningInterval
```
public void setStoppingWarningInterval(int value)
```
    Sets the interval for outputting warnings if the sub-flow hasn't stopped yet (and no stopping timeout set).
    
    Parameters:
    
    value - interval in milliseconds (<= 0 no warning)
  - getStoppingWarningInterval
```
public int getStoppingWarningInterval()
```
    Returns the interval for outputting warnings if the sub-flow hasn't stopped yet (and no stopping timeout set).
    
    Returns:
    
    interval in milliseconds (<= 0 no warning)
  - stoppingWarningIntervalTipText
```
public String stoppingWarningIntervalTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setEnforceCallableNameCheck
```
public void setEnforceCallableNameCheck(boolean value)
```
    Sets whether to enforce the callable name check.
    
    Specified by:
    
    setEnforceCallableNameCheck in interface ScopeHandler
    
    Parameters:
    
    value - true if to enforce check
  - getEnforceCallableNameCheck
```
public boolean getEnforceCallableNameCheck()
```
    Returns whether the check of callable names is enforced.
    
    Specified by:
    
    getEnforceCallableNameCheck in interface ScopeHandler
    
    Returns:
    
    true if check enforced
  - isCallableNameUsed
```
public boolean isCallableNameUsed(ActorHandler handler,
                                  Actor actor)
```
    Checks whether a callable name is already in use.
    
    Specified by:
    
    isCallableNameUsed in interface ScopeHandler
    
    Parameters:
    
    handler - the handler for the actor
    
    actor - the actor name to check
    
    See Also:
    
    getEnforceCallableNameCheck()
  - addCallableName
```
public String addCallableName(ActorHandler handler,
                              Actor actor)
```
    Adds the callable name to the list of used ones.
    
    Specified by:
    
    addCallableName in interface ScopeHandler
    
    Parameters:
    
    handler - the handler for the actor
    
    actor - the actor name to add
    
    Returns:
    
    null if successfully added, otherwise error message
    
    See Also:
    
    getEnforceCallableNameCheck()
  - useLocalVariables
```
public void useLocalVariables(Variables variables)
```
    The local variables to use.
    
    Specified by:
    
    useLocalVariables in interface ProgrammaticLocalScope
    
    Parameters:
    
    variables - the variables
  - useLocalStorage
```
public void useLocalStorage(Storage storage)
```
    The local storage to use.
    
    Specified by:
    
    useLocalStorage in interface ProgrammaticLocalScope
    
    Parameters:
    
    storage - the storage
  - getStorage
```
public Storage getStorage()
```
    Returns the storage container.
    
    Specified by:
    
    getStorage in interface StorageHandler
    
    Returns:
    
    the container
  - getLocalVariables
```
public Variables getLocalVariables()
```
    Returns the Variables instance to use.
    
    Specified by:
    
    getLocalVariables in interface VariablesHandler
    
    Returns:
    
    the local variables
  - getVariables
```
public Variables getVariables()
```
    Returns the Variables instance to use.
    
    Specified by:
    
    getVariables in interface Actor
    
    Overrides:
    
    getVariables in class AbstractActor
    
    Returns:
    
    the scope handler
  - forceVariables
```
protected void forceVariables(Variables value)
```
    Updates the Variables instance in use.
    
    Overrides:
    
    forceVariables in class AbstractControlActor
    
    Parameters:
    
    value - ignored
  - updateParent
```
protected void updateParent()
```
    Updates the parent of all actors in this group.
    
    Overrides:
    
    updateParent in class AbstractControlActor
  - size
```
public int size()
```
    Returns the size of the group.
    
    Specified by:
    
    size in interface ActorHandler
    
    Specified by:
    
    size in class AbstractControlActor
    
    Returns:
    
    always 1
  - get
```
public Actor get(int index)
```
    Returns the actor at the given position.
    
    Specified by:
    
    get in interface ActorHandler
    
    Specified by:
    
    get in class AbstractControlActor
    
    Parameters:
    
    index - the position
    
    Returns:
    
    the actor
  - set
```
public String set(int index,
                  Actor actor)
```
    Sets the actor at the given position.
    
    Specified by:
    
    set in interface ActorHandler
    
    Specified by:
    
    set in class AbstractControlActor
    
    Parameters:
    
    index - the position
    
    actor - the actor to set at this position
    
    Returns:
    
    null if successful, otherwise error message
  - indexOf
```
public int indexOf(String actor)
```
    Returns the index of the actor.
    
    Specified by:
    
    indexOf in interface ActorHandler
    
    Specified by:
    
    indexOf in class AbstractControlActor
    
    Parameters:
    
    actor - the name of the actor to look for
    
    Returns:
    
    the index of -1 if not found
  - add
```
public String add(Actor actor)
```
    Inserts the actor at the end.
    
    Specified by:
    
    add in interface MutableActorHandler
    
    Parameters:
    
    actor - the actor to insert
    
    Returns:
    
    null if successful, otherwise error message
  - add
```
public String add(int index,
                  Actor actor)
```
    Inserts the actor at the given position.
    
    Specified by:
    
    add in interface MutableActorHandler
    
    Parameters:
    
    index - the position
    
    actor - the actor to insert
    
    Returns:
    
    null if successful, otherwise error message
  - remove
```
public Actor remove(int index)
```
    Removes the actor at the given position and returns the removed object.
    
    Specified by:
    
    remove in interface MutableActorHandler
    
    Parameters:
    
    index - the position
    
    Returns:
    
    the removed actor
  - removeAll
```
public void removeAll()
```
    Removes all actors.
    
    Specified by:
    
    removeAll in interface MutableActorHandler
  - getActorHandlerInfo
```
public ActorHandlerInfo getActorHandlerInfo()
```
    Returns some information about the actor handler, e.g., whether it can contain standalones and the actor execution.
    
    Specified by:
    
    getActorHandlerInfo in interface ActorHandler
    
    Specified by:
    
    getActorHandlerInfo in class AbstractControlActor
    
    Returns:
    
    the info
  - accepts
```
public Class[] accepts()
```
    Returns the class that the consumer accepts.
    
    Specified by:
    
    accepts in interface InputConsumer
    
    Returns:
    
    the Class of objects that can be processed
  - generates
```
public Class[] generates()
```
    Returns the class of objects that it generates.
    
    Specified by:
    
    generates in interface OutputProducer
    
    Returns:
    
    the Class of the generated tokens
  - setUpSubActors
```
protected String setUpSubActors()
```
    Gets called in the setUp() method. Returns null if loop-actors are fine, otherwise error message.
    
    Overrides:
    
    setUpSubActors in class AbstractControlActor
    
    Returns:
    
    null if everything OK, otherwise error message
  - input
```
public void input(Token token)
```
    Does nothing.
    
    Specified by:
    
    input in interface InputConsumer
    
    Parameters:
    
    token - the token to accept and process
  - hasInput
```
public boolean hasInput()
```
    Returns whether an input token is currently present.
    
    Specified by:
    
    hasInput in interface InputConsumer
    
    Returns:
    
    true if input token present
  - currentInput
```
public Token currentInput()
```
    Returns the current input token, if any.
    
    Specified by:
    
    currentInput in interface InputConsumer
    
    Returns:
    
    the input token, null if none present
  - isRestrictingStops
```
public boolean isRestrictingStops()
```
    Returns whether stops are being restricted.
    
    Specified by:
    
    isRestrictingStops in interface StopRestrictor
    
    Returns:
    
    true if restricting stops
  - preExecute
```
protected String preExecute()
```
    Pre-execute hook.
    
    Overrides:
    
    preExecute in class AbstractControlActor
    
    Returns:
    
    null if everything is fine, otherwise error message
    
    See Also:
    
    SubFlowWrapUp.wrapUpSubFlow()
  - doExecute
```
protected String doExecute()
```
    Executes the flow item.
    
    Specified by:
    
    doExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message
  - postExecute
```
protected String postExecute()
```
    Post-execute hook.
    
    Overrides:
    
    postExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message
    
    See Also:
    
    AbstractActor.m_Executed
  - hasPendingOutput
```
public boolean hasPendingOutput()
```
    Checks whether there is pending output to be collected after executing the flow item.
    
    Specified by:
    
    hasPendingOutput in interface OutputProducer
    
    Returns:
    
    true if there is pending output
  - output
```
public Token output()
```
    Returns the generated token.
    
    Specified by:
    
    output in interface OutputProducer
    
    Returns:
    
    the generated token
  - flushExecution
```
public void flushExecution()
```
    Stops the processing of tokens without stopping the flow.
    
    Specified by:
    
    flushExecution in interface ActorHandler
    
    Specified by:
    
    flushExecution in interface Flushable
    
    Overrides:
    
    flushExecution in class AbstractControlActor
  - stopExecution
```
public void stopExecution()
```
    Stops the execution.
    
    Specified by:
    
    stopExecution in interface Actor
    
    Specified by:
    
    stopExecution in interface Stoppable
    
    Overrides:
    
    stopExecution in class AbstractControlActor
  - isRestrictedStop
```
public boolean isRestrictedStop()
```
    Returns whether the stop was a restricted one (that can be resumed).
    
    Specified by:
    
    isRestrictedStop in interface StopRestrictor
    
    Returns:
    
    true if restricted stop occurred
  - restrictedStopExecution
```
public void restrictedStopExecution()
```
    Stops the (restricted) execution. No message set.
    
    Specified by:
    
    restrictedStopExecution in interface StopRestrictor
  - restrictedStopExecution
```
public void restrictedStopExecution(String msg)
```
    Stops the (restricted) execution.
    
    Specified by:
    
    restrictedStopExecution in interface StopRestrictor
    
    Parameters:
    
    msg - the message to set as reason for stopping, can be null
  - cleanUp
```
public void cleanUp()
```
    Cleans up after the execution has finished. Also removes graphical components.
    
    Specified by:
    
    cleanUp in interface Actor
    
    Specified by:
    
    cleanUp in interface CleanUpHandler
    
    Overrides:
    
    cleanUp in class AbstractControlActor

Constructor	Description
`LocalScopeSubProcess()`	Default constructor.
`LocalScopeSubProcess(String name)`	Initializes with the specified name.

Class LocalScopeSubProcess

Nested Class Summary

Nested classes/interfaces inherited from interface adams.flow.control.ScopeHandler

Field Summary

Fields inherited from class adams.flow.control.AbstractControlActor

Fields inherited from class adams.flow.core.AbstractActor

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.flow.core.Actor

Constructor Summary

Method Summary

Methods inherited from class adams.flow.control.AbstractControlActor

Methods inherited from class adams.flow.core.AbstractActor

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.flow.core.Actor

Methods inherited from interface adams.flow.core.ActorHandler

Methods inherited from interface adams.core.AdditionalInformationHandler

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.logging.LoggingSupporter

Methods inherited from interface adams.core.option.OptionHandler

Methods inherited from interface adams.core.VariablesInspectionHandler

Field Detail

m_Actors

m_LocalStorage

m_LocalVariables

m_ProgrammaticLocalStorage

m_ProgrammaticLocalVariables

m_CallableNames

m_EnforceCallableNameCheck

m_ScopeHandlingVariables

m_VariablesFilter

m_ScopeHandlingStorage

m_StorageFilter

m_PropagateVariables

m_VariablesRegExp

m_PropagateStorage

m_StorageRegExp

m_RestrictedStop

Constructor Detail

LocalScopeSubProcess

LocalScopeSubProcess

Method Detail

globalInfo

defineOptions

initialize

reset

getQuickInfo

setLoggingLevel

setSkip

setActors

getActors

actorsTipText

setScopeHandlingVariables

getScopeHandlingVariables

scopeHandlingVariablesTipText

setVariablesFilter

getVariablesFilter

variablesFilterTipText

setPropagateVariables

getPropagateVariables

propagateVariablesTipText

setVariablesRegExp

getVariablesRegExp

variablesRegExpTipText

setScopeHandlingStorage

getScopeHandlingStorage

scopeHandlingStorageTipText

setStorageFilter

getStorageFilter

storageFilterTipText

setPropagateStorage

getPropagateStorage

propagateStorageTipText

setStorageRegExp

getStorageRegExp

storageRegExpTipText

setFinishBeforeStopping

getFinishBeforeStopping