org.eclipse.smila.scripting.internal

Class JavascriptExecutor

java.lang.Object

org.eclipse.smila.scripting.internal.JavascriptExecutor

All Implemented Interfaces:

java.lang.AutoCloseable, ScriptExecutor

public class JavascriptExecutor
extends java.lang.Object
implements java.lang.AutoCloseable, ScriptExecutor

Loads a Javascript script and executes functions. Note: MUST be used by a single thread only, MUST be closed after use.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.smila.scripting.ScriptExecutor

ScriptExecutor.Installable

Constructor Summary

Constructors

Constructor and Description
JavascriptExecutor(ModuleScriptProvider scriptProvider, Scriptable baseScope) create instance.

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 plugin)
java.lang.Object	loadScript(java.lang.String scriptFile) load and execute file from scripting directory in this executor.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavascriptExecutor

public JavascriptExecutor(ModuleScriptProvider scriptProvider,
                  Scriptable baseScope)

create instance.

Method Detail

loadScript

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

Description copied from interface: ScriptExecutor

load and execute file from scripting directory in this executor.

Specified by:

loadScript in interface ScriptExecutor

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

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

Description copied from interface: ScriptExecutor

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

Specified by:

call in interface ScriptExecutor

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

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

Description copied from interface: ScriptExecutor

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

Specified by:

call in interface ScriptExecutor

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

public void install(ScriptExecutor.Installable plugin)
             throws ScriptingEngineException

Specified by:

install in interface ScriptExecutor

Parameters:

plugin - the extension to install to the ScriptExecutor

Throws:

ScriptingEngineException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ScriptExecutor