org.sdm.spa

Class BrowserUI

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.sdm.spa.BrowserUI

All Implemented Interfaces:

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

public class BrowserUI
extends TypedAtomicActor

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
TypedIOPort	fileContent Content of the file.
StringParameter	fileFormat The format of the data (used for content input).
FileParameter	fileOrURLParameter Input file or URL parameter.
TypedIOPort	fileOrURLPort Input file or URL parameter.
Parameter	hasTrigger A boolean parameter indicating whether trigger port has to be activated in order to schedule the actor.
SingletonParameter	hide
Parameter	maxWaitTime A parameter indicating how many seconds this actor will wait before throwing time out exception.
StringParameter	portConfiguration Output ports configuration.
TypedIOPort	trigger The port to trigger the actor in case there are no input ports connected.
Parameter	useForDisplay A boolean parameter indicating whether this actor is used only for display only or will it be used for user interactions.
TypedIOPort	xmlOutput An xml name, value pair user response output.

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
BrowserUI(CompositeEntity container, java.lang.String name) Construct a BrowserUI actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute at) Callback for changes in attribute values.
void	fire() Given a ...., BrowserUI actor opens a broser ...
void	initialize() Initialize this actor.
boolean	postfire() Post fire the actor.
void	wrapup() Wrapup the actor.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, 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, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

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, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, 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

hide

public SingletonParameter hide

maxWaitTime

public Parameter maxWaitTime

A parameter indicating how many seconds this actor will wait before throwing time out exception.

useForDisplay

public Parameter useForDisplay

A boolean parameter indicating whether this actor is used only for display only or will it be used for user interactions.

hasTrigger

public Parameter hasTrigger

A boolean parameter indicating whether trigger port has to be activated in order to schedule the actor.

portConfiguration

public StringParameter portConfiguration

Output ports configuration.

The description of the ports should be represented as

• portName portType

one line per each output port.

fileOrURLPort

public TypedIOPort fileOrURLPort

Input file or URL parameter.

fileOrURLParameter

public FileParameter fileOrURLParameter

Input file or URL parameter.

fileContent

public TypedIOPort fileContent

Content of the file.

xmlOutput

public TypedIOPort xmlOutput

An xml name, value pair user response output.

fileFormat

public StringParameter fileFormat

The format of the data (used for content input).

trigger

public TypedIOPort trigger

The port to trigger the actor in case there are no input ports connected. This port is used only for scheduling the actor.

Please activate the hasTrigger parameter to display this port, and uncheck it to hide/disable it.

Constructor Detail

BrowserUI

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

Construct a BrowserUI actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

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

Method Detail

attributeChanged

public void attributeChanged(Attribute at)
                      throws IllegalActionException

Callback for changes in attribute values.

Overrides:

attributeChanged in class NamedObj

Parameters:

at - The attribute that changed.

Throws:

IllegalActionException - If the offsets array is not nondecreasing and nonnegative.

fire

public void fire()
          throws IllegalActionException

Given a ...., BrowserUI actor opens a broser ...

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is no director.

initialize

public void initialize()
                throws IllegalActionException

Description copied from class: AtomicActor

Initialize this actor. Derived classes override this method to perform actions that should occur once at the beginning of an execution, but after type resolution. Derived classes can produce output data and schedule events.

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

Post fire the actor. Return false to indicate that the process has finished. If it returns true, the process will continue indefinitely.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

True if execution can continue into the next iteration.

Throws:

IllegalActionException - Not thrown in this base class.

wrapup

public void wrapup()
            throws IllegalActionException

Wrapup the actor. Set _reFire to true.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.