Package adams.flow.condition.bool

Class VariableFlagSet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.bool.AbstractBooleanCondition

adams.flow.condition.bool.VariableFlagSet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<BooleanCondition>, SizeOfHandler, Stoppable, BooleanCondition, Serializable

public class VariableFlagSet
extends AbstractBooleanCondition

Evaluates to true if the specified variable is present, a boolean and true.

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

-variable-name <adams.core.VariableName> (property: variableName)
    The name of the flag variable to evaluate.
    default: variable
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected VariableName	m_VariableName	the name of the flag variable.

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
VariableFlagSet()	Default constructor.
VariableFlagSet(VariableName variableName)	Initializes with the specified variable name.
VariableFlagSet(String variableName)	Initializes with the specified variable name.

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doEvaluate(Actor owner, Token token)	Performs the actual evaluation.
String	getQuickInfo()	Returns the quick info string to be displayed in the flow editor.
VariableName	getVariableName()	Returns the name of the variable flag to evaluate.
String	globalInfo()	Returns a string describing the object.
void	setVariableName(VariableName value)	Sets the name of the variable flag to evaluate.
void	setVariableName(String value)	Sets the name of the variable to check.
String	variableNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.condition.bool.AbstractBooleanCondition

evaluate, preEvaluate, setUp, shallowCopy, shallowCopy, stopExecution

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_VariableName

protected VariableName m_VariableName

the name of the flag variable.

Constructor Detail

VariableFlagSet

public VariableFlagSet()

Default constructor.

VariableFlagSet

public VariableFlagSet(VariableName variableName)

Initializes with the specified variable name.

Parameters:

variableName - the variable name to use

VariableFlagSet

public VariableFlagSet(String variableName)

Initializes with the specified variable name.

Parameters:

variableName - the variable 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 AbstractOptionHandler

getQuickInfo

public String getQuickInfo()

Returns the quick info string to be displayed in the flow editor.

Specified by:

getQuickInfo in interface BooleanCondition

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in class AbstractBooleanCondition

Returns:

the info or null if no info to be displayed

setVariableName

public void setVariableName(String value)

Sets the name of the variable to check.

Parameters:

value - the name

setVariableName

public void setVariableName(VariableName value)

Sets the name of the variable flag to evaluate.

Parameters:

value - the name

getVariableName

public VariableName getVariableName()

Returns the name of the variable flag to evaluate.

Returns:

the name

variableNameTipText

public String variableNameTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface BooleanCondition

Specified by:

accepts in class AbstractBooleanCondition

Returns:

adams.flow.core.Unknown.class

doEvaluate

protected boolean doEvaluate(Actor owner,
                             Token token)

Performs the actual evaluation.

Specified by:

doEvaluate in class AbstractBooleanCondition

Parameters:

owner - the owning actor

token - the current token passing through

Returns:

the result of the evaluation