Package java.sql

Interface 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 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.

  • Method Summary

    Modifier and Type Method 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.

  • Method Details

    • getBaseTypeName

      String getBaseTypeName() throws SQLException
      Gets the fully-qualified SQL name of the SQL structured type that this Ref references.
      Returns:
      the fully qualified name of the SQL structured type.
      Throws:
      SQLException - if there is a database error.

    • getObject

      Object getObject() throws SQLException
      Gets the SQL structured type instance referenced by this Ref.
      Returns:
      a Java object whose type is defined by the mapping for the SQL structured type.
      Throws:
      SQLException - if there is a database error.

    • getObject

      Object getObject​(Map<String,​Class<?>> map) throws SQLException
      Returns the associated object and uses the relevant mapping to convert it to a Java type.
      Parameters:
      map - the mapping for type conversion.
      Returns:
      a Java object whose type is defined by the mapping for the SQL structured type.
      Throws:
      SQLException - if there is a database error.

    • setObject

      void setObject​(Object value) throws SQLException
      Sets the value of the structured type that this Ref references to a supplied object.
      Parameters:
      value - the Object representing the new SQL structured type that this Ref references.
      Throws:
      SQLException - if there is a database error.