Package adams.flow.control

Interface LocalScopeHandler

All Superinterfaces:

Actor, ActorHandler, AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, ErrorHandler, Flushable, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ScopeHandler, Serializable, ShallowCopySupporter<Actor>, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Implementing Classes:

LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger

public interface LocalScopeHandler
extends ScopeHandler

Interface for actor handlers that provide a local scope for their sub-actors.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Nested Class Summary

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

ScopeHandler.ScopeHandling

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
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.
ScopeHandler.ScopeHandling	getScopeHandlingStorage()	Returns how storage is handled in the local scope.
ScopeHandler.ScopeHandling	getScopeHandlingVariables()	Returns how variables are handled in the local scope.
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.
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	propagateStorageTipText()	Returns the tip text for this property.
String	propagateVariablesTipText()	Returns the tip text for this property.
String	scopeHandlingStorageTipText()	Returns the tip text for this property.
String	scopeHandlingVariablesTipText()	Returns the tip text for this property.
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	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.
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.
String	storageFilterTipText()	Returns the tip text for this property.
String	storageRegExpTipText()	Returns the tip text for this property.
String	variablesFilterTipText()	Returns the tip text for this property.
String	variablesRegExpTipText()	Returns the tip text for this property.

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.flow.core.ActorHandler

check, firstActive, flushExecution, get, getActorHandlerInfo, indexOf, lastActive, set, size

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.flow.control.ScopeHandler

addCallableName, getEnforceCallableNameCheck, isCallableNameUsed, setEnforceCallableNameCheck

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

setScopeHandlingVariables

void setScopeHandlingVariables(ScopeHandler.ScopeHandling value)

Sets how to handle variables into the local scope.

Parameters:

value - the scope handling

getScopeHandlingVariables

ScopeHandler.ScopeHandling getScopeHandlingVariables()

Returns how variables are handled in the local scope.

Returns:

the scope handling

scopeHandlingVariablesTipText

String scopeHandlingVariablesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setVariablesFilter

void setVariablesFilter(BaseRegExp value)

Sets the regular expression that variable names must match to get into the local scope.

Parameters:

value - the expression

getVariablesFilter

BaseRegExp getVariablesFilter()

Returns the regular expression that variable names must match to get into the local scope.

Returns:

the expression

variablesFilterTipText

String variablesFilterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPropagateVariables

void setPropagateVariables(boolean value)

Sets whether to propagate variables from the local to the outer scope.

Parameters:

value - if true then variables get propagated

getPropagateVariables

boolean getPropagateVariables()

Returns whether to propagate variables from the local to the outer scope.

Returns:

true if variables get propagated

propagateVariablesTipText

String propagateVariablesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setVariablesRegExp

void setVariablesRegExp(BaseRegExp value)

Sets the regular expression that variable names must match to get propagated.

Parameters:

value - the expression

getVariablesRegExp

BaseRegExp getVariablesRegExp()

Returns the regular expression that variable names must match to get propagated.

Returns:

the expression

variablesRegExpTipText

String variablesRegExpTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setScopeHandlingStorage

void setScopeHandlingStorage(ScopeHandler.ScopeHandling value)

Sets how to handle storage in the local scope.

Parameters:

value - the scope handling

getScopeHandlingStorage

ScopeHandler.ScopeHandling getScopeHandlingStorage()

Returns how storage is handled in the local scope.

Returns:

the scope handling

scopeHandlingStorageTipText

String scopeHandlingStorageTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStorageFilter

void setStorageFilter(BaseRegExp value)

Sets the regular expression that storage item names must match to get into the local scope.

Parameters:

value - the expression

getStorageFilter

BaseRegExp getStorageFilter()

Returns the regular expression that storage item names must match to get into the local scope.

Returns:

the expression

storageFilterTipText

String storageFilterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPropagateStorage

void setPropagateStorage(boolean value)

Sets whether to propagate storage items from the local to the outer scope.

Parameters:

value - if true then storage items get propagated

getPropagateStorage

boolean getPropagateStorage()

Returns whether to propagate storage items from the local to the outer scope.

Returns:

true if storage items get propagated

propagateStorageTipText

String propagateStorageTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStorageRegExp

void setStorageRegExp(BaseRegExp value)

Sets the regular expression that storage item names must match to get propagated.

Parameters:

value - the expression

getStorageRegExp

BaseRegExp getStorageRegExp()

Returns the regular expression that storage item names must match to get propagated.

Returns:

the expression

storageRegExpTipText

String storageRegExpTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.