org.geon

Class DBConnectionToken

java.lang.Object

ptolemy.data.Token

org.geon.DBConnectionToken

public class DBConnectionToken
extends Token

A token that contains a reference to a database connection. Note that when this token constructed, the object passed to the constructor is not cloned. Thus, care must be exercised to ensure that actors do not modify that object in a nondeterministic way, unless such nondeterminism is acceptable.

Author:

jaeger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBConnectionToken.DBConnectionType The database connection type.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.sql.Connection	_value
static Type	DBCONNECTION The DBConnection type: the least upper bound of all the cryptographic key types.

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor and Description
DBConnectionToken() Construct an empty token.
DBConnectionToken(java.sql.Connection value) Construct a token with a reference to the specified connection.

Method Summary

Modifier and Type	Method and Description
static DBConnectionToken	convert(Token token) Convert the specified token into an instance of DBConnectionToken.
boolean	equals(java.lang.Object object) Return true if the argument is an instance of DBConnectionToken and its contained object is equal to the object contained in this token, as tested by the equals() method of the contained object.
Type	getType() Return the type of this token.
java.sql.Connection	getValue() Return the java.sql.connection.
int	hashCode() Return a hash code value for this token.
java.lang.String	toString() Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value.

Methods inherited from class ptolemy.data.Token

add, addReverse, divide, divideReverse, isCloseTo, isCloseTo, isEqualTo, isNil, modulo, moduloReverse, multiply, multiplyReverse, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, notSupportedNullNilStringMessage, one, pow, subtract, subtractReverse, zero, zeroReturnType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCONNECTION

public static final Type DBCONNECTION

The DBConnection type: the least upper bound of all the cryptographic key types.

_value

protected java.sql.Connection _value

Constructor Detail

DBConnectionToken

public DBConnectionToken()

Construct an empty token.

DBConnectionToken

public DBConnectionToken(java.sql.Connection value)
                  throws IllegalActionException

Construct a token with a reference to the specified connection.

Throws:

IllegalActionException - If the argument is not of the appropriate type (may be thrown by derived classes, but is not thrown here).

Method Detail

convert

public static DBConnectionToken convert(Token token)
                                 throws IllegalActionException

Convert the specified token into an instance of DBConnectionToken. This method does lossless conversion. If the argument is already an instance of DBConnectionToken, it is returned without any change. Otherwise, if the argument is below DBConnectionToken in the type hierarchy, it is converted to an instance of DBConnectionToken and returned. If none of the above condition is met, an exception is thrown.

Parameters:

token - The token to be converted to a DBConnectionToken.

Returns:

A DBConnectionToken.

Throws:

IllegalActionException - If the conversion cannot be carried out.

equals

public boolean equals(java.lang.Object object)

Return true if the argument is an instance of DBConnectionToken and its contained object is equal to the object contained in this token, as tested by the equals() method of the contained object.

Overrides:

equals in class java.lang.Object

Parameters:

object - An instance of Object.

Returns:

True if the argument is an instance of DBConnectionToken and its contained object is equal to the object contained in this token.

getType

public Type getType()

Return the type of this token.

Overrides:

getType in class Token

Returns:

DBCONNECTION, the least upper bound of all the database connections

getValue

public java.sql.Connection getValue()

Return the java.sql.connection.

Returns:

The connection in this token.

hashCode

public int hashCode()

Return a hash code value for this token. This method returns the hash code of the contained object.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this token.

toString

public java.lang.String toString()

Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value. The returned syntax looks like a function call to a one argument method named "dbconnection". The argument is the string representation of the contained object, or the string "null" if the object is null. Notice that this syntax is not currently parseable by the expression language.

Overrides:

toString in class Token

Returns:

A String representing the object.