Package adams.core.scripting

Class SimpleJepScriptlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.scripting.AbstractJepScriptlet

adams.core.scripting.SimpleJepScriptlet

All Implemented Interfaces:

adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, adams.flow.core.FlowContextHandler, Serializable

public class SimpleJepScriptlet
extends AbstractJepScriptlet

Simple script that gets executed in memory, line by line.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	m_Inputs	the inputs.
protected String[]	m_OptionalOutputNames	the optional output names.
protected String[]	m_OutputNames	the output names.
protected Map<String,Object>	m_Outputs	the outputs.
protected String	m_Script	the script to execute.

Fields inherited from class adams.core.scripting.AbstractJepScriptlet

m_Finished, m_FlowContext, m_ID, m_LastError, m_Owner

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
SimpleJepScriptlet(String id, String script, Map<String,Object> inputs, String[] outputNames)	Initializes the scriptlet.
SimpleJepScriptlet(String id, String script, Map<String,Object> inputs, String[] outputNames, String[] optionalOutputNames)	Initializes the scriptlet.

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the script.
Map<String,Object>	getInputs()	Returns the input map of name/value.
String[]	getOptionalOutputNames()	Returns the names of the optional outputs, i.e., ones that won't throw and exception when not present.
String[]	getOutputNames()	Returns the outputs to retrieve from the interpreter.
Map<String,Object>	getOutputs()	Returns the output map.
String	getScript()	Returns the script to be executed (line by line).

Methods inherited from class adams.core.scripting.AbstractJepScriptlet

configureLogger, fail, getFlowContext, getID, getLastError, getOwner, hasFinished, hasLastError, setFlowContext, setOwner

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Script

protected String m_Script

the script to execute.

m_Inputs

protected Map<String,Object> m_Inputs

the inputs.

m_OutputNames

protected String[] m_OutputNames

the output names.

m_OptionalOutputNames

protected String[] m_OptionalOutputNames

the optional output names.

m_Outputs

protected Map<String,Object> m_Outputs

the outputs.

Constructor Detail

SimpleJepScriptlet

public SimpleJepScriptlet(String id,
                          String script,
                          Map<String,Object> inputs,
                          String[] outputNames)

Initializes the scriptlet.

Parameters:

id - the ID of the script

script - the script to execute (line by line)

inputs - the inputs for the script (name/object)

outputNames - the names of the outputs to retrieve

SimpleJepScriptlet

public SimpleJepScriptlet(String id,
                          String script,
                          Map<String,Object> inputs,
                          String[] outputNames,
                          String[] optionalOutputNames)

Initializes the scriptlet.

Parameters:

id - the ID of the script

script - the script to execute (line by line)

inputs - the inputs for the script (name/object)

outputNames - the names of the outputs to retrieve

optionalOutputNames - the names of the optional outputs (won't throw an exception if not present)

Method Detail

getScript

public String getScript()

Returns the script to be executed (line by line).

Returns:

the script

getInputs

public Map<String,Object> getInputs()

Returns the input map of name/value.

Returns:

the inputs

getOutputNames

public String[] getOutputNames()

Returns the outputs to retrieve from the interpreter.

Returns:

the names

getOptionalOutputNames

public String[] getOptionalOutputNames()

Returns the names of the optional outputs, i.e., ones that won't throw and exception when not present.

Returns:

the names

getOutputs

public Map<String,Object> getOutputs()

Returns the output map. Gets populated after execution.

Returns:

the outputs (name/value)

execute

public String execute()

Executes the script.

Specified by:

execute in class AbstractJepScriptlet

Returns:

null if successful, otherwise error message