org.kepler.dataproxy.datasource.geon

Class GEONShpResource

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.WebService

org.kepler.dataproxy.datasource.geon.GEONShpResource

All Implemented Interfaces:

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

public class GEONShpResource
extends WebService
implements DataCacheListener, DataSourceInterface

A GEON shapefile resource.

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringAttribute	_descriptionAtt
StringAttribute	_endpointAtt
TypedIOPort	_forwardGEONId
SingletonParameter	_hideErrorPort
SingletonParameter	_hideOutput
StringAttribute	_idAtt
StringAttribute	_namespaceAtt
StringParameter	_process
protected static org.apache.commons.logging.Log	log

Fields inherited from class org.sdm.spa.WebService

clientExecErrors, hasTrigger, hide, methodName, password, startTrigger, timeout, userName, wsdlUrl

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 org.kepler.dataproxy.datasource.DataSourceInterface

BLACK, ENDPOINT, MAGENTA, NAMESPACE, RECORDID, RED, TITLE_BINARY, TITLE_BUSY, TITLE_ERROR, YELLOW

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
GEONShpResource(CompositeEntity container, java.lang.String name) Construct an actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
protected void	_deletePorts() Deletes all the ports of this actor.
void	attributeChanged(Attribute attribute) Callback for changes in attribute values.
void	complete(DataCacheObject aItem)
void	fire() Get the URL address of the the location of the web service defined by the given WSDL.
java.net.URL	getDocumentation() Get a URL pointer to the ADN documentation for this data source.
java.lang.String	getEndpoint() Get the endpoint of this record.
java.lang.String	getNamespace() Get the namespace of this record.
java.lang.String	getRecordId() Get the identifier of this record.
boolean	postfire() postfire the actor.

Methods inherited from class org.sdm.spa.WebService

preinitialize

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, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

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, initialize, removeInitializable, wrapup

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

log

protected static final org.apache.commons.logging.Log log

_process

public StringParameter _process

_idAtt

public StringAttribute _idAtt

_endpointAtt

public StringAttribute _endpointAtt

_namespaceAtt

public StringAttribute _namespaceAtt

_descriptionAtt

public StringAttribute _descriptionAtt

_hideOutput

public SingletonParameter _hideOutput

_hideErrorPort

public SingletonParameter _hideErrorPort

_forwardGEONId

public TypedIOPort _forwardGEONId

Constructor Detail

GEONShpResource

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

Construct an 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.

Since:

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Callback for changes in attribute values.

Overrides:

attributeChanged in class WebService

Parameters:

attribute - The attribute that changed.

Throws:

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

getRecordId

public java.lang.String getRecordId()

Get the identifier of this record.

Returns:

the String that uniquely identifies the record

getEndpoint

public java.lang.String getEndpoint()

Get the endpoint of this record. The endpoint indicates where the service generating the record can be accessed.

Returns:

endpoint the URL of the service that contains the record

getNamespace

public java.lang.String getNamespace()

Get the namespace of this record.

Returns:

namespace the URL of the service that contains the record

getDocumentation

public java.net.URL getDocumentation()

Get a URL pointer to the ADN documentation for this data source.

Specified by:

getDocumentation in interface DataSourceInterface

Returns:

URL the URL of the HTML file containing the documentation

fire

public void fire()
          throws IllegalActionException

Description copied from class: WebService

Get the URL address of the the location of the web service defined by the given WSDL. Get the the namespace and binding information of the web service using the given WSDL and methodName. Add a parameter to the call object for each input part.Fill these parameters with the input values on channels on the ports that correspond to them. Invoke the web service using all the gathered information. Send the response of the call to the result port.

Specified by:

fire in interface Executable

Overrides:

fire in class WebService

Throws:

IllegalActionException - If there is no director.

postfire

public boolean postfire()
                 throws IllegalActionException

postfire the actor. Return false if the command is not invoking the web service client and there is no trigger.

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.

_deletePorts

protected void _deletePorts()
                     throws IllegalActionException

Deletes all the ports of this actor.

Throws:

IllegalActionException

complete

public void complete(DataCacheObject aItem)

Specified by:

complete in interface DataCacheListener