adams.data.conversion
Class Groovy

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.conversion.AbstractConversion
              adams.data.conversion.AbstractScriptConversion
                  adams.data.conversion.Groovy

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Debuggable, adams.core.Destroyable, OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractConversion>, adams.core.SizeOfHandler, Conversion, ConversionWithInitialization, Serializable

public class Groovy
extends AbstractScriptConversion

A conversion that uses a Groovy script for processing the data.

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 Groovy script; must consist of 'key=value' pairs separated 
    by blanks; the value of 'key' can be accessed via the 'getAdditionalOptions
    ().getXYZ("key")' method in the Groovy actor.
    default: 
 

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

Version:

$Revision: 6612 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractConversion	m_ConversionObject the loaded script object.
protected GroovyScript	m_InlineScript the inline script.

Fields inherited from class adams.data.conversion.AbstractScriptConversion

m_ScriptFile, m_ScriptObject, m_ScriptOptions

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Groovy()

Method Summary

Class	accepts() Returns the class that is accepted as input.
protected String	checkScriptObject() Checks the script object.
void	defineOptions() Adds options to the internal list of options.
void	destroy() Frees up memory in a "destructive" non-reversible way.
protected Object	doConvert() Performs the actual conversion.
Class	generates() Returns the class that is generated as output.
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.
String	scriptOptionsTipText() Returns the tip text for this property.
void	setInlineScript(GroovyScript value) Sets the inline script to use instead of the external script file.
String	setUp() Initializes the item for flow execution.

Methods inherited from class adams.data.conversion.AbstractScriptConversion

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

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getInput, getOutput, getOwner, setInput, setOwner, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.data.conversion.Conversion

convert, getInput, getOutput, getOwner, setInput, setOwner

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Field Detail

m_ConversionObject

protected transient AbstractConversion m_ConversionObject

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 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 AbstractScriptConversion

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractScriptConversion

Returns:

null if no info available, otherwise short string

scriptOptionsTipText

public String scriptOptionsTipText()

Returns the tip text for this property.

Overrides:

scriptOptionsTipText in class AbstractScriptConversion

Returns:

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

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

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

Object.class, since

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

loadScriptObject

protected String loadScriptObject()

Loads the scripts object and sets its options.

Specified by:

loadScriptObject in class AbstractScriptConversion

Returns:

null if OK, otherwise the error message

checkScriptObject

protected String checkScriptObject()

Checks the script object.

Specified by:

checkScriptObject in class AbstractScriptConversion

Returns:

null if OK, otherwise the error message

setUp

public String setUp()

Initializes the item for flow execution.

Specified by:

setUp in interface ConversionWithInitialization

Overrides:

setUp in class AbstractScriptConversion

Returns:

null if everything is fine, otherwise error message

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion

destroy

public void destroy()

Frees up memory in a "destructive" non-reversible way.

Specified by:

destroy in interface adams.core.Destroyable

Overrides:

destroy in class AbstractScriptConversion