public interface Ref
The data structure identified by an instance of Ref is held in the
database, so the data is not necessarily read and converted
into a Java object until getObject
is called. However, if
the database supports the Ref
type, it is not typically
necessary to get the underlying object before using it in a method call -
the Ref
object can be used in place of the data structure.
A Ref
object is stored into the database using the
PreparedStatement.setRef(int, Ref)
method.
Modifier and Type | Method and Description |
---|---|
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 type that this
Ref references to
a supplied object. |
String getBaseTypeName() throws SQLException
Ref
references.SQLException
- if there is a database error.Object getObject() throws SQLException
Ref
.SQLException
- if there is a database error.Object getObject(Map<String,Class<?>> map) throws SQLException
map
- the mapping for type conversion.SQLException
- if there is a database error.void setObject(Object value) throws SQLException
Ref
references to
a supplied object.value
- the Object
representing the new SQL structured type
that this Ref
references.SQLException
- if there is a database error.