Interface Ref
-
- All Known Implementing Classes:
- SerialRef
public interface RefThe mapping in the Java programming language of an SQLREFvalue, which is a reference to an SQL structured type value in the database.SQL
REFvalues are stored in a table that contains instances of a referenceable SQL structured type, and eachREFvalue is a unique identifier for one instance in that table. An SQLREFvalue may be used in place of the SQL structured type it references, either as a column value in a table or an attribute value in a structured type.Because an SQL
REFvalue is a logical pointer to an SQL structured type, aRefobject is by default also a logical pointer. Thus, retrieving an SQLREFvalue as aRefobject does not materialize the attributes of the structured type on the client.A
Refobject can be stored in the database using thePreparedStatement.setRefmethod.All methods on the
Refinterface must be fully implemented if the JDBC driver supports the data type.- Since:
- 1.2
- See Also:
-
Struct
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description StringgetBaseTypeName()Retrieves the fully-qualified SQL name of the SQL structured type that thisRefobject references.ObjectgetObject()Retrieves the SQL structured type instance referenced by thisRefobject.ObjectgetObject(Map<String,Class<?>> map)Retrieves the referenced object and maps it to a Java type using the given type map.voidsetObject(Object value)Sets the structured type value that thisRefobject references to the given instance ofObject.
-
-
-
Method Detail
getBaseTypeName
String getBaseTypeName() throws SQLException
Retrieves the fully-qualified SQL name of the SQL structured type that thisRefobject references.- Returns:
- the fully-qualified SQL name of the referenced SQL structured type
- Throws:
-
SQLException- if a database access error occurs -
SQLFeatureNotSupportedException- if the JDBC driver does not support this method - Since:
- 1.2
getObject
Object getObject(Map<String,Class<?>> map) throws SQLException
Retrieves the referenced object and maps it to a Java type using the given type map.- Parameters:
-
map- ajava.util.Mapobject that contains the mapping to use (the fully-qualified name of the SQL structured type being referenced and the class object forSQLDataimplementation to which the SQL structured type will be mapped) - Returns:
-
a Java
Objectthat is the custom mapping for the SQL structured type to which thisRefobject refers - Throws:
-
SQLException- if a database access error occurs -
SQLFeatureNotSupportedException- if the JDBC driver does not support this method - Since:
- 1.4
- See Also:
-
setObject(java.lang.Object)
getObject
Object getObject() throws SQLException
Retrieves the SQL structured type instance referenced by thisRefobject. 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 aStructobject.- Returns:
-
a Java
Objectthat is the mapping for the SQL structured type to which thisRefobject refers - Throws:
-
SQLException- if a database access error occurs -
SQLFeatureNotSupportedException- if the JDBC driver does not support this method - Since:
- 1.4
- See Also:
-
setObject(java.lang.Object)
setObject
void setObject(Object value) throws SQLException
Sets the structured type value that thisRefobject references to the given instance ofObject. The driver converts this to an SQL structured type when it sends it to the database.- Parameters:
-
value- anObjectrepresenting the SQL structured type instance that thisRefobject will reference - Throws:
-
SQLException- if a database access error occurs -
SQLFeatureNotSupportedException- if the JDBC driver does not support this method - Since:
- 1.4
- See Also:
-
getObject(),getObject(Map),PreparedStatement.setObject(int, Object),CallableStatement.setObject(String, Object)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
