oracle.sql
Class REF

java.lang.Object
  |
  +--oracle.sql.Datum
        |
        +--oracle.sql.DatumWithConnection
              |
              +--oracle.sql.REF

public class REF

extends DatumWithConnection

implements java.sql.Ref, java.io.Serializable, java.lang.Cloneable

See Also:

Serialized Form

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getBaseTypeName() Implements the Ref interface method.
OracleConnection	getConnection()
StructDescriptor	getDescriptor() Oracle extension.
java.sql.Connection	getJavaSqlConnection()
java.lang.Object	getObject() JDBC 3.0 Retrieves the SQL structured type instance referenced by this Ref object.
java.lang.Object	getObject(java.util.Map map)
java.lang.String	getSQLTypeName() Oracle extension.
STRUCT	getSTRUCT() Oracle extension.
java.lang.Object	getValue() Oracle extension.
java.lang.Object	getValue(java.util.Map map) Oracle extension.
int	hashCode()
boolean	isConvertibleTo(java.lang.Class jClass) Test whether this data object can be converted to the specified Java data type.
void	setObject(java.lang.Object value) JDBC 3.0 Sets the structured type value that this Ref object references to the given instance of Object.
void	setValue(java.lang.Object value) Oracle extension.
java.lang.Object	toJdbc() Convert this data object into its default Java object type.

Methods inherited from class oracle.sql.DatumWithConnection

assertNotNull, assertNotNull, getOracleConnection

Methods inherited from class oracle.sql.Datum

asciiStreamValue, bigDecimalValue, binaryStreamValue, booleanValue, byteValue, characterStreamValue, dateValue, doubleValue, floatValue, getBytes, getLength, getStream, intValue, longValue, makeJdbcArray, setBytes, setShareBytes, shareBytes, stringValue, timestampValue, timeValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBaseTypeName

public java.lang.String getBaseTypeName()
                                 throws java.sql.SQLException

Implements the Ref interface method. Gets the fully-qualified SQL structured type name of the referenced item.

Specified by:

getBaseTypeName in interface java.sql.Ref

Returns:

fully-qualified SQL structured type name of the referenced item.

Throws:

java.sql.SQLException - if a database access error occurs

getValue

public java.lang.Object getValue(java.util.Map map)
                          throws java.sql.SQLException

Oracle extension. Get referenced object. Use "map" for customized type mapping.

Parameters:

map - contains mapping of SQL type names to Java classes

Returns:

the referenced object which can be a STRUCT or any java object defined in type map.

getValue

public java.lang.Object getValue()
                          throws java.sql.SQLException

Oracle extension. Get referenced object. Use the connection type map for customized type mapping.

Returns:

the referenced object which can be a STRUCT or any java object defined in type map.

getSTRUCT

public STRUCT getSTRUCT()
                 throws java.sql.SQLException

Oracle extension. Get the referenced object as a oracle.sql.STRUCT instance. Customized type mapping is ignored.

setValue

public void setValue(java.lang.Object value)
              throws java.sql.SQLException

Oracle extension. Set REF value. The method updated the underly object value in database.

Parameters:

value - the value to be set.

getDescriptor

public StructDescriptor getDescriptor()
                               throws java.sql.SQLException

Oracle extension. Return the type descriptor of the ADT type that this REF object points to.

getSQLTypeName

public java.lang.String getSQLTypeName()
                                throws java.sql.SQLException

Oracle extension. Return the type name of the ADT type that this REF object points to.

getObject

public java.lang.Object getObject(java.util.Map map)
                           throws java.sql.SQLException

getObject

public java.lang.Object getObject()
                           throws java.sql.SQLException

JDBC 3.0 Retrieves the SQL structured type instance referenced by this Ref object. If the connection's type map has an entry for the structured type, the instance will be custom mapped to the Java class indicated in the type map. Otherwise, the structured type instance will be mapped to a Struct object.

Returns:

a Java Object that is the mapping for the SQL structured type to which this Ref object refers

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setObject(java.lang.Object)

setObject

public void setObject(java.lang.Object value)
               throws java.sql.SQLException

JDBC 3.0 Sets the structured type value that this Ref object references to the given instance of Object. The driver converts this to an SQL structured type when it sends it to the database.

Parameters:

value - an Object representing the SQL structured type instance that this Ref object will reference

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getObject(), getObject(Map), PreparedStatement.setObject(int, Object), PreparedStatement#setObject(String, Object)

toJdbc

public java.lang.Object toJdbc()
                        throws java.sql.SQLException

Convert this data object into its default Java object type.

Returns:

this object.

Throws:

java.sql.SQLException - if any of the lower layer code throws an exception.

Overrides:

toJdbc in class Datum

isConvertibleTo

public boolean isConvertibleTo(java.lang.Class jClass)

Test whether this data object can be converted to the specified Java data type.

Parameters:

jClass - specifies the Java data type to test against.

Returns:

true if this data object is convertible to the specified Java class, and a corresponding xxxValue() method is available; otherwise, a false is returned.

Overrides:

isConvertibleTo in class Datum

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Datum

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getJavaSqlConnection

public java.sql.Connection getJavaSqlConnection()
                                         throws java.sql.SQLException

Overrides:

getJavaSqlConnection in class DatumWithConnection

getConnection

public OracleConnection getConnection()
                               throws java.sql.SQLException

Overrides:

getConnection in class DatumWithConnection