モジュール java.sql
パッケージ java.sql

インタフェースRef

既知のすべての実装クラス:
SerialRef
public interface Ref
Javaプログラミング言語でのSQL REF値のマッピングで、データベースのSQL構造化型の値への参照となります。

SQL REF値は参照可能SQL構造化型のインスタンスを含む表に格納され、各REF値はその表の1つのインスタンスに対する一意の識別子となります。 インスタンスが参照するSQL構造化型の代わりに、表の列値または構造化型の属性値のどちらかとしてSQL REF値を使用できます。

SQL REF値はSQL構造化型への論理ポインタであるため、Refオブジェクトもまたデフォルトでは論理ポインタです。 したがって、SQL REF値をRefオブジェクトとして取得しても、クライアントの構造化型の属性を生成しません。

RefオブジェクトはPreparedStatement.setRefメソッドを使用してデータベースに格納できます。

JDBCドライバがそのデータ型をサポートする場合は、Refインタフェースのすべてのメソッドが完全に実装される必要があります。

導入されたバージョン:
1.2
関連項目:
Struct

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    String
    getBaseTypeName()
    このRefオブジェクトが参照する、完全指定されたSQL構造化型のSQL名を取得します。
    Object
    getObject()
    このRefオブジェクトによって参照されるSQL構造化型インスタンスを取得します。
    Object
    getObject​(Map<String,​Class<?>> map)
    参照されるオブジェクトを取得し、そのオブジェクトを指定された型マップを使用してJava型へマップします。
    void
    setObject​(Object value)
    このRefオブジェクトが参照する構造化型値をObjectの指定されたインスタンスに設定します。

  • メソッドの詳細

    • getBaseTypeName

      String getBaseTypeName() throws SQLException
      このRefオブジェクトが参照する、完全指定されたSQL構造化型のSQL名を取得します。
      戻り値:
      参照されるSQL構造化型の、完全指定されたSQL名
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.2

    • getObject

      Object getObject​(Map<String,​Class<?>> map) throws SQLException
      参照されるオブジェクトを取得し、そのオブジェクトを指定された型マップを使用してJava型へマップします。
      パラメータ:
      map - 使用するマッピングが格納されているjava.util.Mapオブジェクト(参照されるSQL構造化型の完全指定名とSQL構造化型がマップされるSQLData実装のクラス・オブジェクト)
      戻り値:
      このRefオブジェクトが参照するSQL構造化型のカスタム・マッピングであるJavaのObject
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.4
      関連項目:
      setObject(java.lang.Object)

    • getObject

      Object getObject() throws SQLException
      このRefオブジェクトによって参照されるSQL構造化型インスタンスを取得します。 接続の型マップが構造化型のエントリを持つ場合、インスタンスはその型マップで示されるJavaのクラスへカスタム・マッピングされます。 そうでない場合は、構造化型インスタンスはStructオブジェクトにマップされます。
      戻り値:
      このRefオブジェクトが参照するSQL構造化型のマッピングであるJavaのObject
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.4
      関連項目:
      setObject(java.lang.Object)

    • setObject

      void setObject​(Object value) throws SQLException
      このRefオブジェクトが参照する構造化型値をObjectの指定されたインスタンスに設定します。 データベースに送るときに、ドライバはこれをSQL構造化型に変換します。
      パラメータ:
      value - このRefオブジェクトが参照するSQL構造化型インスタンスを表すObject
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.4
      関連項目:
      getObject(), getObject(Map), PreparedStatement.setObject(int, Object), CallableStatement.setObject(String, Object)