org.eclipse.smila.scripting

Interface ScriptExecutor

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

JavascriptExecutor

public interface ScriptExecutor
extends java.lang.AutoCloseable

Load script files and executes functions. Notes:

• MUST be used by a single thread only.
• MUST be closed after use.

Best usage pattern:

 try (ScriptExecutor executor = scriptingEngine.getScriptExecutor()) {
   executor.loadScript("myScript");
   executor.call("myFunction", record);
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ScriptExecutor.Installable Interface for object that add something to the ScriptExecutor.

Method Summary

Methods

Modifier and Type	Method and Description
AnyMap	call(java.lang.String scriptFunction, AnyMap arguments) execute the function with the given map object.
Record	call(java.lang.String scriptFunction, Record record) execute the function with the given record.
void	close()
void	install(ScriptExecutor.Installable extension)
java.lang.Object	loadScript(java.lang.String scriptFile) load and execute file from scripting directory in this executor.

Method Detail

loadScript

java.lang.Object loadScript(java.lang.String scriptFile)
                            throws ScriptingEngineException

load and execute file from scripting directory in this executor.

Parameters:

scriptFile - Script file. Relative path some base directory, without suffix.

Returns:

result result object from the script execution.

Throws:

ScriptingEngineException - error loading or executing scripts.

call

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

execute the function with the given record. The function must have been defined by previous loadScript(String) calls.

Parameters:

scriptFunction - name of function. The function must be able to take one argument.

record - record to process with the script.

Returns:

result of function as a record.

Throws:

ScriptingEngineException - error processing the script.

call

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

execute the function with the given map object. The function must have been defined by previous loadScript(String) calls.

Parameters:

scriptFunction - name of function. The function must be able to take one argument.

arguments - arguments to process.

Returns:

result of function as an AnyMap object.

Throws:

ScriptingEngineException - error processing the script.

install

void install(ScriptExecutor.Installable extension)
             throws ScriptingEngineException

Parameters:

extension - the extension to install to the ScriptExecutor

Throws:

ScriptingEngineException

close

void close()

Specified by:

close in interface java.lang.AutoCloseable