Interface Ref

public interface Ref

The Ref interface represents a database structured type value_—_that is, a SQL REF value. Like SQL REF, a Ref is a logical pointer to the SQL structured type in the database. Retrieving a Ref doesn’t retrieve all the attributes of the structured type.

Methods

getBaseTypeName

public String getBaseTypeName() throws SQLException

This gets the SQL name of the SQL structured type that the Ref object references.

Returns: The SQL name of the referenced SQL structured type. A SQLException is thrown if an error occurs while accessing this value.

getValue

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

This gets the referenced object and maps it to a Java type using the type map. A SQLException is thrown if an error occurs while accessing this value.

Parameters:

map:

A java.util.Map object containing the mapping to use

Returns: The object referenced by Ref mapped to a Java class

getValue

public Object getValue() throws SQLException

This gets the referenced object and maps it to a Java type using the type map of the current connection, if available, or to a Struct object if no mapping is provided for this type. A SQLException is thrown if an error occurs while accessing this value.

Returns: The object referenced by Ref mapped to a Java class

setValue

public void setValue(Object value) throws SQLException

This sets the value referenced by the Ref. A SQLException is thrown if an error occurs while accessing this value.

Parameters:

value:

The object to be set