org.kepler.dataproxy.datasource.geon

Class GEONDatabaseResource

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.geon.DatabaseAccessor

org.geon.DatabaseQuery

org.kepler.dataproxy.datasource.geon.GEONDatabaseResource

All Implemented Interfaces:

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

public class GEONDatabaseResource
extends DatabaseQuery
implements DataCacheListener, DataSourceInterface

An actor that serves as a proxy to query a specific database (defined by geon id).

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
protected EllipseAttribute	_elli Icon indicating the communication region.
StringAttribute	_endpointAtt
SingletonParameter	_hideNS
StringAttribute	_idAtt
StringAttribute	_namespaceAtt
protected ResizablePolygonAttribute	_rect
protected TextAttribute	_text
SingletonParameter	hideCon
protected static org.apache.commons.logging.Log	log

Fields inherited from class org.geon.DatabaseQuery

_qbTableauFactory, _schemaAttr, _schemaDef, _sqlAttr, lowerColumnNames, outputEachRowSeparately, outputType, query, queryValues, result

Fields inherited from class org.geon.DatabaseAccessor

_db, dbcon, dbconTokenConsumptionRate, dbParams

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

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) Callback for changes in attribute values.
void	complete(DataCacheObject aItem)
void	getConnection() Get the database connection.
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.

Methods inherited from class org.geon.DatabaseQuery

clone, connectionsChanged, fire, postfire, preinitialize, wrapup

Methods inherited from class org.geon.DatabaseAccessor

_setPreparedStatementValue, initialize

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, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, 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, 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

_elli

protected EllipseAttribute _elli

Icon indicating the communication region.

_rect

protected ResizablePolygonAttribute _rect

_text

protected TextAttribute _text

_idAtt

public StringAttribute _idAtt

_endpointAtt

public StringAttribute _endpointAtt

_namespaceAtt

public StringAttribute _namespaceAtt

_descriptionAtt

public StringAttribute _descriptionAtt

hideCon

public SingletonParameter hideCon

_hideNS

public SingletonParameter _hideNS

log

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

Constructor Detail

GEONDatabaseResource

public GEONDatabaseResource(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. s * @since

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

Callback for changes in attribute values.

Overrides:

attributeChanged in class DatabaseQuery

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the output type is not recognized.

getConnection

public void getConnection()
                   throws IllegalActionException

Get the database connection.

Overrides:

getConnection in class DatabaseAccessor

Throws:

IllegalActionException

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

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

getRecordId

public java.lang.String getRecordId()

Get the identifier of this record.

Returns:

the String that uniquely identifies the record

complete

public void complete(DataCacheObject aItem)

Specified by:

complete in interface DataCacheListener