# Ref

public interface **Ref** 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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Struct.html`

### Public Method Summary

|---|---|
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getBaseTypeName](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#getBaseTypeName())() Retrieves the fully-qualified SQL name of the SQL structured type that this `Ref` object references. |
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [getObject](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#getObject())() Retrieves the SQL structured type instance referenced by this `Ref` object. |
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [getObject](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#getObject(java.util.Map<java.lang.String,%20java.lang.Class<?>>))([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html), [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\>\> map) Retrieves the referenced object and maps it to a Java type using the given type map. |
| abstract void | [setObject](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#setObject(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value) Sets the structured type value that this `Ref` object references to the given instance of `Object`. |

## Public Methods

#### public abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getBaseTypeName**
()

Retrieves the fully-qualified SQL name of the SQL structured type that
this `Ref` object references.

##### Returns

- the fully-qualified SQL name of the referenced SQL structured type

##### Throws

| [SQLException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLException.html) | if a database access error occurs |
| [SQLFeatureNotSupportedException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLFeatureNotSupportedException.html) | if the JDBC driver does not support this method |
|---|---|

#### public abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**getObject**
()

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.

##### Returns

- a Java `Object` that is the mapping for the SQL structured type to which this `Ref` object refers

##### Throws

| [SQLException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLException.html) | if a database access error occurs |
| [SQLFeatureNotSupportedException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLFeatureNotSupportedException.html) | if the JDBC driver does not support this method |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#setObject(java.lang.Object)`

#### public abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**getObject**
([Map](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Map.html)\<[String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html), [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\>\> map)

Retrieves the referenced object and maps it to a Java type
using the given type map.

##### Parameters

| map | a `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) |
|---|---|

##### Returns

- a Java `Object` that is the custom mapping for the SQL structured type to which this `Ref` object refers

##### Throws

| [SQLException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLException.html) | if a database access error occurs |
| [SQLFeatureNotSupportedException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLFeatureNotSupportedException.html) | if the JDBC driver does not support this method |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#setObject(java.lang.Object)`

#### public abstract void
**setObject**
([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) value)

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.

##### Parameters

| value | an `Object` representing the SQL structured type instance that this `Ref` object will reference |
|---|---|

##### Throws

| [SQLException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLException.html) | if a database access error occurs |
| [SQLFeatureNotSupportedException](https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/SQLFeatureNotSupportedException.html) | if the JDBC driver does not support this method |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#getObject()`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/Ref.html#getObject(java.util.Map<java.lang.String,%20java.lang.Class<?>>)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/PreparedStatement.html#setObject(int,%20java.lang.Object)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/sql/CallableStatement.html#setObject(java.lang.String,%20java.lang.Object)`