Package adams.flow.condition.test

Class Jython

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.test.AbstractTestCondition

adams.flow.condition.test.AbstractScriptedCondition

adams.flow.condition.test.Jython

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, FileBasedScripting, FileBasedScriptingWithOptions, ShallowCopySupporter<TestCondition>, SizeOfHandler, TestCondition, Serializable, Comparable

public class Jython
extends AbstractScriptedCondition

A condition that uses the condition defined in an external Jython script.

Valid options are:

-D (property: debug)
    If set to true, scheme may output additional info to the console.
 

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

-options <java.lang.String> (property: scriptOptions)
    The options for the Jython script; must consist of 'key=value' pairs separated
    by blanks; the value of 'key' can be accessed via the 'getAdditionalOption
    (String)' in the Jython actor.
    default:
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Jython, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Hashtable<String,String>	m_AdditionalOptions	for storing the additional options.
protected AbstractTestCondition	m_ConditionObject	the loaded script object.
protected JythonScript	m_InlineScript	the inline script.

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

m_ScriptFile, m_ScriptObject, m_ScriptOptions

Fields inherited from class adams.flow.condition.test.AbstractTestCondition

m_Tested, m_TestResult

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

Method Summary

Modifier and Type	Method	Description
protected String	checkScriptObject()	Checks the script object.
void	defineOptions()	Adds options to the internal list of options.
String	getAdditionalOption(String name, String defValue)	Returns the value associated with the (additional) option.
protected JythonScript	getDefaultInlineScript()	Returns the default inline script.
JythonScript	getInlineScript()	Gets the inline script to use instead of the external script file.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
String	inlineScriptTipText()	Returns the tip text for this property.
protected String	loadScriptObject()	Loads the scripts object and sets its options.
protected String	performScriptTest()	Runs the script test.
String	scriptOptionsTipText()	Returns the tip text for this property.
void	setAdditionalOptions(Hashtable<String,String> options)	Sets the additional options.
void	setInlineScript(JythonScript value)	Sets the inline script to use instead of the external script file.

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

getScriptFile, getScriptOptions, initScriptObject, performTest, reset, scriptFileTipText, setScriptFile, setScriptOptions

Methods inherited from class adams.flow.condition.test.AbstractTestCondition

compareTo, equals, forCommandLine, forName, getConditions, getQuickInfo, getTestResult, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ConditionObject

protected transient AbstractTestCondition m_ConditionObject

the loaded script object.

m_InlineScript

protected JythonScript m_InlineScript

the inline script.

m_AdditionalOptions

protected Hashtable<String,String> m_AdditionalOptions

for storing the additional options.

Constructor Detail

Jython

public Jython()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractTestCondition

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractScriptedCondition

getDefaultInlineScript

protected JythonScript getDefaultInlineScript()

Returns the default inline script.

Returns:

the default script

setInlineScript

public void setInlineScript(JythonScript value)

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

Parameters:

value - the inline script

getInlineScript

public JythonScript 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

scriptOptionsTipText

public String scriptOptionsTipText()

Returns the tip text for this property.

Specified by:

scriptOptionsTipText in interface FileBasedScriptingWithOptions

Overrides:

scriptOptionsTipText in class AbstractScriptedCondition

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

performScriptTest

protected String performScriptTest()

Runs the script test.

Specified by:

performScriptTest in class AbstractScriptedCondition

Returns:

the test result, null if everything OK, otherwise the error message

setAdditionalOptions

public void setAdditionalOptions(Hashtable<String,String> options)

Sets the additional options.

Parameters:

options - the options (name <->value relation)

getAdditionalOption

public String getAdditionalOption(String name,
                                  String defValue)

Returns the value associated with the (additional) option.

Parameters:

name - the name of the additional option to retrieve

defValue - the default value

Returns:

the value or null if not available