public interface java.sql
Ref


Show All Login
Java SE 6
  
Implemented by: SerialRef
Details
The mapping in the Java programming language of an SQL REF value, which is a reference to an SQL structured type value in the database.

SQL REF values are stored in a table that contains instances of a referenceable SQL structured type, and each REF value is a unique identifier for one instance in that table. An SQL REF value 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 REF value is a logical pointer to an SQL structured type, a Ref object is by default also a logical pointer. Thus, retrieving an SQL REF value as a Ref object does not materialize the attributes of the structured type on the client.

A Ref object can be stored in the database using the PreparedStatement.setRef method.

All methods on the Ref interface must be fully implemented if the JDBC driver supports the data type.
since1.2
See also java.sql.Struct


Properties
public String getBaseTypeName() throws SQLException Details
Retrieves the fully-qualified SQL name of the SQL structured type that this Ref object references.
returnthe fully-qualified SQL name of the referenced SQL structured type
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.2
public void setObject(Object value) throws SQLException Details
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.
valuean Object representing the SQL structured type instance that this Ref object will reference
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.4
See also getObject(), getObject(Map), setObject(int, Object), setObject(String, Object)
public Object getObject(Map map) throws SQLException Details
Retrieves the referenced object and maps it to a Java type using the given type map.
mapa java.util.Map object that contains the mapping to use (the fully-qualified name of the SQL structured type being referenced and the class object for SQLData implementation to which the SQL structured type will be mapped)
returna Java Object that is the custom mapping for the SQL structured type to which this Ref object refers
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.4
See also setObject
public Object getObject() throws SQLException Details
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.
returna Java Object that is the mapping for the SQL structured type to which this Ref object refers
ThrowsSQLException: if a database access error occurs
ThrowsSQLFeatureNotSupportedException: if the JDBC driver does not support this method
since1.4
See also setObject
About DocWeb · Bundles · Export · Export AllTop 10 · Statistics · Login
About Sun · Contact · Privacy · Terms of Use · Trademarks
Java SE 6
· Copyright © 1994-2009 Sun Microsystems, Inc.
All rights reserved. Use is subject to license terms