Package adams.flow.template

Class AbstractScriptedTemplate

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.template.AbstractActorTemplate

adams.flow.template.AbstractScriptedTemplate

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, FileBasedScripting, FileBasedScriptingWithOptions, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable

Direct Known Subclasses:

Groovy, Scripted

public abstract class AbstractScriptedTemplate
extends AbstractActorTemplate
implements CleanUpHandler, FileBasedScriptingWithOptions

Abstract ancestor for templates that execute external scripts.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_ScriptFile	the script.
protected Object	m_ScriptObject	the loaded script object.
protected String	m_ScriptOptions	the options for the script.

Fields inherited from class adams.flow.template.AbstractActorTemplate

m_Name

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

Method Summary

Modifier and Type	Method	Description
protected abstract String	checkScriptObject()	Checks the script object.
void	cleanUp()	Cleans up, frees up memory.
void	defineOptions()	Adds options to the internal list of options.
protected Actor	doGenerate()	Generates the actor.
protected abstract Actor	executeScript()	Executes the script to generate the actor.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
PlaceholderFile	getScriptFile()	Gets the script file.
BaseText	getScriptOptions()	Gets the script options.
protected String	initScriptObject()	Tries to initialize the scripts object, sets its options and performs some checks.
protected abstract String	loadScriptObject()	Loads the scripts object and sets its options.
String	scriptFileTipText()	Returns the tip text for this property.
String	scriptOptionsTipText()	Returns the tip text for this property.
void	setScriptFile(PlaceholderFile value)	Sets the script file.
void	setScriptOptions(BaseText value)	Sets the script options.

Methods inherited from class adams.flow.template.AbstractActorTemplate

compareTo, equals, forCommandLine, forName, generate, getBaselineCorrections, getDefaultName, getName, isInteractive, nameTipText, postGenerate, preGenerate, setName, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_ScriptFile

protected PlaceholderFile m_ScriptFile

the script.

m_ScriptOptions

protected String m_ScriptOptions

the options for the script.

m_ScriptObject

protected transient Object m_ScriptObject

the loaded script object.

Constructor Detail

AbstractScriptedTemplate

public AbstractScriptedTemplate()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActorTemplate

getQuickInfo

public String getQuickInfo()

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

Returns:

null if no info available, otherwise short string

setScriptFile

public void setScriptFile(PlaceholderFile value)

Sets the script file.

Specified by:

setScriptFile in interface FileBasedScripting

Parameters:

value - the script

getScriptFile

public PlaceholderFile getScriptFile()

Gets the script file.

Specified by:

getScriptFile in interface FileBasedScripting

Returns:

the script

scriptFileTipText

public String scriptFileTipText()

Returns the tip text for this property.

Specified by:

scriptFileTipText in interface FileBasedScripting

Returns:

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

setScriptOptions

public void setScriptOptions(BaseText value)

Sets the script options.

Specified by:

setScriptOptions in interface FileBasedScriptingWithOptions

Parameters:

value - the options

getScriptOptions

public BaseText getScriptOptions()

Gets the script options.

Specified by:

getScriptOptions in interface FileBasedScriptingWithOptions

Returns:

the options

scriptOptionsTipText

public String scriptOptionsTipText()

Returns the tip text for this property.

Specified by:

scriptOptionsTipText in interface FileBasedScriptingWithOptions

Returns:

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

loadScriptObject

protected abstract String loadScriptObject()

Loads the scripts object and sets its options.

Returns:

null if OK, otherwise the error message

checkScriptObject

protected abstract String checkScriptObject()

Checks the script object.

Returns:

null if OK, otherwise the error message

initScriptObject

protected String initScriptObject()

Tries to initialize the scripts object, sets its options and performs some checks.

Returns:

null if OK, otherwise the error message

executeScript

protected abstract Actor executeScript()

Executes the script to generate the actor.

Returns:

the generated actor

doGenerate

protected Actor doGenerate()

Generates the actor.

Specified by:

doGenerate in class AbstractActorTemplate

Returns:

the generated actor

cleanUp

public void cleanUp()

Cleans up, frees up memory.

Default implementation does nothing.

Specified by:

cleanUp in interface CleanUpHandler