FileDocCategorySizeDatePackage
Ref.javaAPI DocAndroid 1.5 API3228Wed May 06 22:41:06 BST 2009java.sql

Ref

public interface Ref
This interface represents an SQL Ref - a data object containing a cursor or pointer to a result table.

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 {@code getObject} is called. However, if the database supports the {@code Ref} type, it is not typically necessary to get the underlying object before using it in a method call - the {@code Ref} object can be used in place of the data structure.

A {@code Ref} object is stored into the database using the {@link PreparedStatement#setRef(int, Ref)} method.
since
Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetBaseTypeName()
Gets the fully-qualified SQL name of the SQL structured type that this {@code Ref} references.

return
the fully qualified name of the SQL structured type.
throws
SQLException if there is a database error.
since
Android 1.0

public java.lang.ObjectgetObject()
Gets the SQL structured type instance referenced by this {@code Ref}.

return
a Java object whose type is defined by the mapping for the SQL structured type.
throws
SQLException if there is a database error.
since
Android 1.0

public java.lang.ObjectgetObject(java.util.Map map)
Returns the associated object and uses the relevant mapping to convert it to a Java type.

param
map the mapping for type conversion.
return
a Java object whose type is defined by the mapping for the SQL structured type.
throws
SQLException if there is a database error.
since
Android 1.0

public voidsetObject(java.lang.Object value)
Sets the value of the structured type that this {@code Ref} references to a supplied object.

param
value the {@code Object} representing the new SQL structured type that this {@code Ref} references.
throws
SQLException if there is a database error.
since
Android 1.0