org.geon

Class OpenDBConnection

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

All Implemented Interfaces:

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

public class OpenDBConnection
extends TypedAtomicActor

This actor opens a database connection using the database format, database URL, username and password, and sends a reference to it.

Since:

Ptolemy II 3.0.2

Author:

Efrat Jaeger

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	databaseFormat
StringParameter	databaseURL
TypedIOPort	dbcon A reference to a db connection
TypedIOPort	dbParams A record containing parameters to create a db connection.
StringParameter	password
java.lang.String	strFileOrURL
TypedIOPort	trigger Input trigger: if connected, actor will only run once token is available.
StringParameter	username

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
OpenDBConnection(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 at) Callback for changes in attribute values.
void	connectionsChanged(Port port) When connecting the dbcon port, trigger the connectionsChanged of the connected actor.
void	fire() Connect to a database outputs a reference to the DB connection.
static java.sql.Connection	getConnection(RecordToken params) Get a JDBC Connection from a database parameter token.
static Type	getDBParamsType() Get the type of database parameter token.
boolean	postfire() postfiring the actor.
java.lang.String	sendSchemaToConnected() Returns the database schema.

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

trigger

public TypedIOPort trigger

Input trigger: if connected, actor will only run once token is available.

dbcon

public TypedIOPort dbcon

A reference to a db connection

dbParams

public TypedIOPort dbParams

A record containing parameters to create a db connection.

databaseFormat

public StringParameter databaseFormat

databaseURL

public StringParameter databaseURL

username

public StringParameter username

password

public StringParameter password

strFileOrURL

public java.lang.String strFileOrURL

Constructor Detail

OpenDBConnection

public OpenDBConnection(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.

Method Detail

attributeChanged

public void attributeChanged(Attribute at)
                      throws IllegalActionException

Callback for changes in attribute values. If the dbFormat has changed, points to the new driver path. At any change in the connection attributes, tries to connect to the referenced database to get the schema and send it to connected actors.

Overrides:

attributeChanged in class NamedObj

Parameters:

at - The attribute that changed.

Throws:

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

connectionsChanged

public void connectionsChanged(Port port)

When connecting the dbcon port, trigger the connectionsChanged of the connected actor.

Overrides:

connectionsChanged in class AtomicActor<TypedIOPort>

Parameters:

port - The port that has connection changes.

fire

public void fire()
          throws IllegalActionException

Connect to a database outputs a reference to the DB connection.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

postfire

public boolean postfire()

postfiring the actor.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

True if execution can continue into the next iteration.

sendSchemaToConnected

public java.lang.String sendSchemaToConnected()
                                       throws IllegalActionException

Returns the database schema. This function is called from the dbcon port connected actors.

Throws:

IllegalActionException

getDBParamsType

public static Type getDBParamsType()

Get the type of database parameter token.

getConnection

public static java.sql.Connection getConnection(RecordToken params)
                                         throws IllegalActionException

Get a JDBC Connection from a database parameter token.

Throws:

IllegalActionException