Package adams.flow.execution.debug

Class SubFlowRestriction

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.execution.debug.AbstractScopeRestriction

adams.flow.execution.debug.SubFlowRestriction

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class SubFlowRestriction
extends AbstractScopeRestriction

Restricts the scope to the sub-flow specified by the path (= root of subflow).

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-root <adams.flow.core.ActorPath> (property: root)
    The root of the sub-flow to restrict the scope to.
    default: Flow
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ActorPath	m_Root	the root of the tree to restrict to.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
SubFlowRestriction()

Method Summary

Modifier and Type	Method	Description
boolean	checkScope(Actor actor, ExecutionStage stage)	Checks whether the specified actor falls within the scope.
void	defineOptions()	Adds options to the internal list of options.
ActorPath	getRoot()	Returns the root of the subtree to retrict the scope to.
String	globalInfo()	Returns a string describing the object.
String	rootTipText()	Returns the tip text for this property.
void	setRoot(ActorPath value)	Sets the root of the subtree to restrict the scope to.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Root

protected ActorPath m_Root

the root of the tree to restrict to.

Constructor Detail

SubFlowRestriction

public SubFlowRestriction()

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 AbstractOptionHandler

setRoot

public void setRoot(ActorPath value)

Sets the root of the subtree to restrict the scope to.

Parameters:

value - the root

getRoot

public ActorPath getRoot()

Returns the root of the subtree to retrict the scope to.

Returns:

the root

rootTipText

public String rootTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

checkScope

public boolean checkScope(Actor actor,
                          ExecutionStage stage)

Checks whether the specified actor falls within the scope.

Specified by:

checkScope in class AbstractScopeRestriction

Parameters:

actor - the actor to check

stage - the execution stage

Returns:

true if within scope