org.kepler.webview.actor

Class WebViewAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

org.kepler.webview.actor.WebViewAttribute

All Implemented Interfaces:

java.lang.Cloneable, WebViewable, ActorFiringListener, Initializable, IOPortEventListener, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable

Direct Known Subclasses:

ControlAttribute, ParametersAttribute

public class WebViewAttribute
extends StringAttribute
implements Initializable, WebViewable, IOPortEventListener, ActorFiringListener

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	html
StringAttribute	htmlCode
FileParameter	htmlFile
StringParameter	title

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.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Constructor Summary

Constructors

Constructor and Description
WebViewAttribute(NamedObj container, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected void	_connectionClosed(java.lang.String id)
protected void	_connectionOpened(java.lang.String id)
protected java.lang.Object	_convertInputToJson(Token token)
protected void	_dataReceived(java.lang.String name, java.lang.Object value)
protected void	_optionReceived(java.lang.String name, java.lang.Object value)
protected void	_registerHandler()
void	addInitializable(Initializable initializable) Add the specified object to the set of objects whose preinitialize(), initialize(), and wrapup() methods should be invoked upon invocation of the corresponding methods of this object.
void	attributeChanged(Attribute attribute) React to an attribute change.
java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
void	firingEvent(FiringEvent event) Report an actor firing state.
java.lang.String	getHTML()
Parameter	getOption(java.lang.String name) Get a parameter that is an option for the client.
java.util.List<Parameter>	getOptions() Get a list of parameters to send as options to the client.
void	initialize() Begin execution of the actor.
void	portEvent(IOPortEvent event) Report a port activity.
void	preinitialize() This method should be invoked exactly once per execution of a model, before any of these other methods are invoked.
void	removeInitializable(Initializable initializable) Remove the specified object from the set of objects whose preinitialize(), initialize(), and wrapup() methods should be invoked upon invocation of the corresponding methods of this object.
void	setContainer(NamedObj container) Set the container.
void	unregisterHandler() Stop listening for events from clients.
void	wrapup() This method is invoked exactly once per execution of an application.

Methods inherited from class ptolemy.kernel.util.StringAttribute

_propagateValue, addValueListener, exportMoML, getExpression, getVisibility, removeValueListener, setExpression, setVisibility, validate

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getDefaultExpression, getValueAsString

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kepler.webview.actor.WebViewable

getAttribute, toplevel

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Field Detail

htmlFile

public FileParameter htmlFile

html

public StringParameter html

htmlCode

public StringAttribute htmlCode

title

public StringParameter title

Constructor Detail

WebViewAttribute

public WebViewAttribute(NamedObj container,
                        java.lang.String name)
                 throws IllegalActionException,
                        NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

Method Detail

addInitializable

public void addInitializable(Initializable initializable)

Description copied from interface: Initializable

Add the specified object to the set of objects whose preinitialize(), initialize(), and wrapup() methods should be invoked upon invocation of the corresponding methods of this object.

Specified by:

addInitializable in interface Initializable

Parameters:

initializable - The object whose methods should be invoked.

See Also:

Initializable.removeInitializable(Initializable)

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to an attribute change.

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 StringAttribute

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)

firingEvent

public void firingEvent(FiringEvent event)

Description copied from interface: ActorFiringListener

Report an actor firing state. This method will be called when an begins/finishes firing iteration.

Specified by:

firingEvent in interface ActorFiringListener

Parameters:

event - The event to report.

getHTML

public java.lang.String getHTML()
                         throws java.io.IOException,
                                IllegalActionException

Specified by:

getHTML in interface WebViewable

Throws:

java.io.IOException

IllegalActionException

getOptions

public java.util.List<Parameter> getOptions()

Description copied from interface: WebViewable

Get a list of parameters to send as options to the client.

Specified by:

getOptions in interface WebViewable

getOption

public Parameter getOption(java.lang.String name)

Description copied from interface: WebViewable

Get a parameter that is an option for the client.

Specified by:

getOption in interface WebViewable

initialize

public void initialize()
                throws IllegalActionException

Description copied from interface: Initializable

Begin execution of the actor. This is invoked exactly once after the preinitialization phase. Since type resolution is done in the preinitialization phase, along with topology changes that may be requested by higher-order function actors, an actor can produce output data and schedule events in the initialize() method.

Specified by:

initialize in interface Initializable

Throws:

IllegalActionException - If execution is not permitted.

portEvent

public void portEvent(IOPortEvent event)
               throws IllegalActionException

Description copied from interface: IOPortEventListener

Report a port activity. This method is called when a token has been sent or received from one IOPort to another.

Specified by:

portEvent in interface IOPortEventListener

Parameters:

event - The event to report.

Throws:

IllegalActionException - If thrown by the implementation.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Description copied from interface: Initializable

This method should be invoked exactly once per execution of a model, before any of these other methods are invoked. For actors, this is invoked prior to type resolution and may trigger changes in the topology, changes in the type constraints.

Specified by:

preinitialize in interface Initializable

Throws:

IllegalActionException - If initializing is not permitted.

removeInitializable

public void removeInitializable(Initializable initializable)

Description copied from interface: Initializable

Remove the specified object from the set of objects whose preinitialize(), initialize(), and wrapup() methods should be invoked upon invocation of the corresponding methods of this object. If the specified object is not on the list, do nothing.

Specified by:

removeInitializable in interface Initializable

Parameters:

initializable - The object whose methods should no longer be invoked.

See Also:

Initializable.addInitializable(Initializable)

setContainer

public void setContainer(NamedObj container)
                  throws IllegalActionException,
                         NameDuplicationException

Set the container.

Overrides:

setContainer in class Attribute

Parameters:

container - The container to attach this attribute to..

Throws:

IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.

NameDuplicationException - If the container already has an attribute with the name of this attribute.

See Also:

Attribute.getContainer()

unregisterHandler

public void unregisterHandler()

Stop listening for events from clients. This must be called when the containing model is no longer used.

wrapup

public void wrapup()
            throws IllegalActionException

Description copied from interface: Initializable

This method is invoked exactly once per execution of an application. None of the other action methods should be be invoked after it. It finalizes an execution, typically closing files, displaying final results, etc. When this method is called, no further execution should occur.

Specified by:

wrapup in interface Initializable

Throws:

IllegalActionException - If wrapup is not permitted.

_registerHandler

protected void _registerHandler()
                         throws IllegalActionException

Throws:

IllegalActionException

_connectionClosed

protected void _connectionClosed(java.lang.String id)

_connectionOpened

protected void _connectionOpened(java.lang.String id)
                          throws IllegalActionException

Throws:

IllegalActionException

_dataReceived

protected void _dataReceived(java.lang.String name,
                             java.lang.Object value)

_optionReceived

protected void _optionReceived(java.lang.String name,
                               java.lang.Object value)

_convertInputToJson

protected java.lang.Object _convertInputToJson(Token token)
                                        throws IllegalActionException

Throws:

IllegalActionException