インタフェース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
関連 目:
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    このRefオブジェクトが参照する、完全指定されたSQL構 化型のSQL名を取得します。
    このRefオブジェクトによって参照されるSQL構 化型インスタンスを取得します。
    参照されるオブジェクトを取得し、そのオブジェクトを指定された型マップを使用してJava型へマップします。
    void
    このRefオブジェクトが参照する構 化型値をObjectの指定されたインスタンスに設定します。
  • メソッドの詳細

    • getBaseTypeName

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

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

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

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