org.eclipse.smila.scripting

Interface ScriptingEngine

All Known Implementing Classes:

JavascriptEngine

public interface ScriptingEngine

Interface for services that processes records by using a script.

Method Summary

Methods

Modifier and Type	Method and Description
AnyMap	callScript(java.lang.String scriptFunction, AnyMap arguments) Processes given map object using the specified script function.
Record	callScript(java.lang.String scriptFunction, Record record) Processes given record using the specified script function.
ScriptExecutor	getScriptExecutor() Creates a new script executor.
java.util.Collection<java.lang.String>	listScriptNames() get the list of the names of all scripts.
AnySeq	listScripts() get the list of script descriptions.

Method Detail

listScripts

AnySeq listScripts()
                   throws ScriptingEngineException

get the list of script descriptions. Each element is map containing at least the name of the script.

Throws:

ScriptingEngineException - failed to determine available scripts.

listScriptNames

java.util.Collection<java.lang.String> listScriptNames()
                                                       throws ScriptingEngineException

get the list of the names of all scripts.

Throws:

ScriptingEngineException - failed to determine available scripts.

callScript

Record callScript(java.lang.String scriptFunction,
                Record record)
                  throws ScriptingEngineException

Processes given record using the specified script function.

Parameters:

scriptFunction - name of script function to use for processing. ("script.function")

record - record to process.

Returns:

Processed record. Does not have to be the same object as the input record, may be null

Throws:

ScriptingEngineException - error processing the record.

callScript

AnyMap callScript(java.lang.String scriptFunction,
                AnyMap arguments)
                  throws ScriptingEngineException

Processes given map object using the specified script function.

Parameters:

scriptFunction - name of script function to use for processing. ("script.function")

arguments - object to process.

Returns:

Processed object. Does not have to be the same object as the input arguments, may be null

Throws:

ScriptingEngineException - error processing the record.

getScriptExecutor

ScriptExecutor getScriptExecutor()
                                 throws ScriptingEngineException

Creates a new script executor.

Returns:

a ScriptExecutor

Throws:

ScriptingEngineException - error creating the executor.