org.kepler.scriptengine

Class ScriptEngineActor

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.kepler.scriptengine.ScriptEngineActor

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

BeanShell, Groovy, Java, Javascript, JRuby, Jython

public abstract class ScriptEngineActor
extends TypedAtomicActor

An actor whose execution is specified by a script. The Java ScriptEngine API is used to invoke methods in the script.

Author:

Daniel Crawl

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	_ACTOR_INSTANCE_NAME The name of the actor object in the script.
protected java.lang.Object	_actorObject The actor object in the script.
protected TextEditorConfigureFactory	_editorFactory Text editor.
protected javax.script.ScriptEngine	_engine The engine to parse and execute scripts.
protected java.lang.Object	_evaluatedScriptObject The Object resulting from evaluating the script.
protected boolean	_invokeMethodWithReflection If true, use reflection to invoke the method.
protected javax.script.ScriptEngineManager	_manager An object to load script engines.
StringParameter	actorClassName The name of the class in the script defining the execution methods.
StringParameter	language The script language.
StringAttribute	script The contents of the script.

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
ScriptEngineActor(CompositeEntity container, java.lang.String name) Construct a new ScriptEngineActor with the given container and name.
ScriptEngineActor(Workspace workspace) Construct a new ScriptEngineActor for a specified workspace.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	_createActorInstance(java.lang.String actorClassNameStr) Create an instance of the actor object in the script.
protected java.lang.Object	_evaluateScript() Evaluate the script.
protected void	_putObjectToActorInstance(java.lang.String name, java.lang.Object object) Put the given object to the actor instance in the script.
protected void	_registerEngineFactory() Register an script engine factory with the scrip engine manager.
void	attributeChanged(Attribute attribute) React to an attribute change.
java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
void	debug(java.lang.String message) Send the message to all registered debug listeners.
void	error(java.lang.String message) Set an error message that will be thrown in an exception after the current or next method is invoked in the script.
void	fire() Invoke the fire() method in the script.
void	initialize() Invoke the initialize() method in the script.
boolean	postfire() Invoke the postfire() method in the script.
boolean	prefire() Invoke the prefire() method in the script.
void	preinitialize() Invoke the preinitialize() method of the script.
void	stop() Invoke the stop() method in the script.
void	stopFire() Invoke the stopFire() method in the script.
void	terminate() Invoke the terminate() method in the script.
void	wrapup() Invoke the wrapup() method in the script.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

actorClassName

public StringParameter actorClassName

The name of the class in the script defining the execution methods.

language

public StringParameter language

The script language.

script

public StringAttribute script

The contents of the script.

_engine

protected javax.script.ScriptEngine _engine

The engine to parse and execute scripts.

_ACTOR_INSTANCE_NAME

protected static final java.lang.String _ACTOR_INSTANCE_NAME

The name of the actor object in the script.

See Also:

Constant Field Values

_actorObject

protected java.lang.Object _actorObject

The actor object in the script.

_invokeMethodWithReflection

protected boolean _invokeMethodWithReflection

If true, use reflection to invoke the method. Otherwise, use the Invocable interface of the ScriptEngine to invoke the method.

_evaluatedScriptObject

protected java.lang.Object _evaluatedScriptObject

The Object resulting from evaluating the script.

_manager

protected javax.script.ScriptEngineManager _manager

An object to load script engines.

_editorFactory

protected TextEditorConfigureFactory _editorFactory

Text editor.

Constructor Detail

ScriptEngineActor

public ScriptEngineActor(Workspace workspace)

Construct a new ScriptEngineActor for a specified workspace.

ScriptEngineActor

public ScriptEngineActor(CompositeEntity container,
                         java.lang.String name)
                  throws IllegalActionException,
                         NameDuplicationException

Construct a new ScriptEngineActor with the given container and name.

Throws:

IllegalActionException

NameDuplicationException

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to an attribute change. When the language changes, this method loads the script engine for that language.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor into the specified workspace.

Overrides:

clone in class TypedAtomicActor

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

debug

public void debug(java.lang.String message)

Send the message to all registered debug listeners.

Parameters:

message - The debug message.

error

public void error(java.lang.String message)

Set an error message that will be thrown in an exception after the current or next method is invoked in the script.

Parameters:

message - The debug message.

fire

public void fire()
          throws IllegalActionException

Invoke the fire() method in the script.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

initialize

public void initialize()
                throws IllegalActionException

Invoke the initialize() method in the script.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If a derived class throws it.

postfire

public boolean postfire()
                 throws IllegalActionException

Invoke the postfire() method in the script.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

If the postfire method is present in the script, returns the return value from executing this method. Otherwise, returns the value from the parent class's postfire().

Throws:

IllegalActionException - Not thrown in this base class.

prefire

public boolean prefire()
                throws IllegalActionException

Invoke the prefire() method in the script.

Specified by:

prefire in interface Executable

Overrides:

prefire in class AtomicActor<TypedIOPort>

Returns:

If the prefire method is present in the script, returns the return value from executing this method. Otherwise, returns the value from the parent class's prefire().

Throws:

IllegalActionException - Not thrown in this base class.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Invoke the preinitialize() method of the script.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

stop

public void stop()

Invoke the stop() method in the script.

Specified by:

stop in interface Executable

Overrides:

stop in class AtomicActor<TypedIOPort>

stopFire

public void stopFire()

Invoke the stopFire() method in the script.

Specified by:

stopFire in interface Executable

Overrides:

stopFire in class AtomicActor<TypedIOPort>

terminate

public void terminate()

Invoke the terminate() method in the script.

Specified by:

terminate in interface Executable

Overrides:

terminate in class AtomicActor<TypedIOPort>

wrapup

public void wrapup()
            throws IllegalActionException

Invoke the wrapup() method in the script.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

_createActorInstance

protected java.lang.Object _createActorInstance(java.lang.String actorClassNameStr)
                                         throws javax.script.ScriptException

Create an instance of the actor object in the script.

Returns:

the actor instance.

Throws:

javax.script.ScriptException

_evaluateScript

protected java.lang.Object _evaluateScript()
                                    throws javax.script.ScriptException,
                                           IllegalActionException

Evaluate the script.

Returns:

Returns the object resulting from evaluating the script.

Throws:

javax.script.ScriptException

IllegalActionException

_putObjectToActorInstance

protected void _putObjectToActorInstance(java.lang.String name,
                                         java.lang.Object object)
                                  throws javax.script.ScriptException

Put the given object to the actor instance in the script.

Parameters:

name - the name of the object to put.

object - the object to put.

Throws:

javax.script.ScriptException

_registerEngineFactory

protected void _registerEngineFactory()

Register an script engine factory with the scrip engine manager. In this class, does nothing.