java.sql
Interface Ref

public interface Ref

A manifestation of the SQL REF type - a reference to an SQL type contained in the database.

The SQL REF's are held in a table along with SQL structured types. Every REF has an individual identifier for each single instance. The SQL REF is used instead of the structured type it references.

A Ref object is stored into the database using the PreparedStatement.setRef method.

Method Summary

String	getBaseTypeName() Gets the fully-qualified SQL name of the SQL structured type that this Ref references.
Object	getObject() Gets the SQL structured type instance referenced by this Ref.
Object	getObject(Map<String,Class<?>> map) Returns the associated object and uses the relevant mapping to convert it to a Java type.
void	setObject(Object value) Sets the value of the structured typethat this Ref references to a supplied Object.

Method Detail

getBaseTypeName

String getBaseTypeName()
                       throws SQLException

Gets the fully-qualified SQL name of the SQL structured type that this Ref references.

Returns:

the fully qualified name of the SQL structured type

Throws:

SQLException - if there is a database error

getObject

Object getObject()
                 throws SQLException

Gets the SQL structured type instance referenced by this Ref.

Returns:

a Java object whose type is defined by the mapping for the SQL structured type.

Throws:

SQLException - if there is a database error

getObject

Object getObject(Map<String,Class<?>> map)
                 throws SQLException

Returns the associated object and uses the relevant mapping to convert it to a Java type.

Parameters:

map - a java.util.Map which contains the mapping to use

Returns:

a Java object whose type is defined by the mapping for the SQL structured type.

Throws:

SQLException - if there is a database error

setObject

void setObject(Object value)
               throws SQLException

Sets the value of the structured typethat this Ref references to a supplied Object.

Parameters:

value - the Object representing the new SQL structured type that this Ref will reference.

Throws:

SQLException - if there is a database error