Package adams.flow.condition.bool

Class Groovy

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.bool.AbstractBooleanCondition

adams.flow.condition.bool.AbstractScriptedCondition

adams.flow.condition.bool.Groovy

All Implemented Interfaces:

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

public class Groovy
extends AbstractScriptedCondition

A boolean condition that uses the condition defined in a Groovy script.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-script <adams.core.io.PlaceholderFile> (property: scriptFile)
    The script file to load and execute.
    default: ${CWD}
 

-options <java.lang.String> (property: scriptOptions)
    The options for the script.
    default: 
 

-inline-script <adams.core.scripting.GroovyScript> (property: inlineScript)
    The inline script, if not using an external script file.
    default: 
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Groovy, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanCondition	m_ConditionObject	the loaded script object.
protected GroovyScript	m_InlineScript	the inline script.

Fields inherited from class adams.flow.condition.bool.AbstractScriptedCondition

m_ScriptFile, m_ScriptObject, m_ScriptOptions

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
Groovy()

Method Summary

Modifier and Type	Method	Description
protected String	checkScriptObject()	Checks the script object.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doScriptEvaluate(Actor owner, Token token)	Runs the script evaluation.
protected GroovyScript	getDefaultInlineScript()	Returns the default inline script.
GroovyScript	getInlineScript()	Gets the inline script to use instead of the external script file.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	inlineScriptTipText()	Returns the tip text for this property.
protected String	loadScriptObject()	Loads the scripts object and sets its options.
void	setInlineScript(GroovyScript value)	Sets the inline script to use instead of the external script file.

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

accepts, doEvaluate, getScriptFile, getScriptOptions, initScriptObject, reset, scriptFileTipText, scriptOptionsTipText, setScriptFile, setScriptOptions, setUp

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

evaluate, preEvaluate, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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_ConditionObject

protected transient BooleanCondition m_ConditionObject

the loaded script object.

m_InlineScript

protected GroovyScript m_InlineScript

the inline script.

Constructor Detail

Groovy

public Groovy()

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 AbstractScriptedCondition

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface BooleanCondition

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractScriptedCondition

Returns:

null if no info available, otherwise short string

getDefaultInlineScript

protected GroovyScript getDefaultInlineScript()

Returns the default inline script.

Returns:

the default script

setInlineScript

public void setInlineScript(GroovyScript value)

Sets the inline script to use instead of the external script file.

Parameters:

value - the inline script

getInlineScript

public GroovyScript getInlineScript()

Gets the inline script to use instead of the external script file.

Returns:

the inline script

inlineScriptTipText

public String inlineScriptTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

loadScriptObject

protected String loadScriptObject()

Loads the scripts object and sets its options.

Specified by:

loadScriptObject in class AbstractScriptedCondition

Returns:

null if OK, otherwise the error message

checkScriptObject

protected String checkScriptObject()

Checks the script object.

Specified by:

checkScriptObject in class AbstractScriptedCondition

Returns:

always null, i.e., OK

doScriptEvaluate

protected boolean doScriptEvaluate(Actor owner,
                                   Token token)

Runs the script evaluation.

Specified by:

doScriptEvaluate in class AbstractScriptedCondition

Returns:

the boolean result of the evaluation