org.eclipse.smila.scripting.internal

Class JavascriptEngine

java.lang.Object

org.eclipse.smila.scripting.internal.JavascriptEngine

All Implemented Interfaces:

ScriptingEngine

public class JavascriptEngine
extends java.lang.Object
implements ScriptingEngine

Implements ScriptingEngine by using Mozilla Rhino to evaluate Javascript files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_NAME

Constructor Summary

Constructors

Constructor and Description
JavascriptEngine()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(ComponentContext componentContext)
AnyMap	callScript(java.lang.String scriptName, AnyMap arguments) Processes given map object using the specified script function.
Record	callScript(java.lang.String scriptName, 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.
void	setBlackboardFactory(BlackboardFactory factory) set blackboard factory reference (used by DS).
void	setPipeletTracker(PipeletTracker pipeletTracker) used by DS to set reference to pipelet tracker.
void	unsetBlackboardFactory(BlackboardFactory factory) remove blackboard factory reference (used by DS).
void	unsetPipeletTracker(PipeletTracker pipeletTracker) used by DS to remove reference to pipelet tracker.

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_NAME

public static final java.lang.String BUNDLE_NAME

See Also:

Constant Field Values

Constructor Detail

JavascriptEngine

public JavascriptEngine()

Method Detail

activate

protected void activate(ComponentContext componentContext)
                 throws java.io.IOException

Throws:

java.io.IOException

listScriptNames

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

Description copied from interface: ScriptingEngine

get the list of the names of all scripts.

Specified by:

listScriptNames in interface ScriptingEngine

Throws:

ScriptingEngineException - failed to determine available scripts.

listScripts

public AnySeq listScripts()
                   throws ScriptingEngineException

Description copied from interface: ScriptingEngine

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

Specified by:

listScripts in interface ScriptingEngine

Throws:

ScriptingEngineException - failed to determine available scripts.

callScript

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

Description copied from interface: ScriptingEngine

Processes given record using the specified script function.

Specified by:

callScript in interface ScriptingEngine

Parameters:

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

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

Description copied from interface: ScriptingEngine

Processes given map object using the specified script function.

Specified by:

callScript in interface ScriptingEngine

Parameters:

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

public ScriptExecutor getScriptExecutor()
                                 throws ScriptingEngineException

Description copied from interface: ScriptingEngine

Creates a new script executor.

Specified by:

getScriptExecutor in interface ScriptingEngine

Returns:

a ScriptExecutor

Throws:

ScriptingEngineException - error creating the executor.

setPipeletTracker

public void setPipeletTracker(PipeletTracker pipeletTracker)

used by DS to set reference to pipelet tracker.

unsetPipeletTracker

public void unsetPipeletTracker(PipeletTracker pipeletTracker)

used by DS to remove reference to pipelet tracker.

setBlackboardFactory

public void setBlackboardFactory(BlackboardFactory factory)

set blackboard factory reference (used by DS).

unsetBlackboardFactory

public void unsetBlackboardFactory(BlackboardFactory factory)

remove blackboard factory reference (used by DS).