java.sql
インタフェース Ref

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 メソッドを使用してデータベースに格納できます。

導入されたバージョン:

1.2

関連項目:

Struct

メソッドの概要

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

メソッドの詳細

getBaseTypeName

public String getBaseTypeName()
                       throws SQLException

この Ref オブジェクトが参照する、完全指定された SQL 構造化型の SQL 名を取得します。

戻り値:

参照される SQL 構造化型の、完全指定された SQL 名

例外:

SQLException - データベースアクセスエラーが発生した場合

導入されたバージョン:

1.2

getObject

public Object getObject(Map map)
                 throws SQLException

参照されるオブジェクトを取得し、そのオブジェクトを指定された型マップを使用して Java 型へマップします。

パラメータ:

map - 使用するマッピングが格納されている java.util.Map オブジェクト (参照される SQL 構造化型の完全指定名と SQL 構造化型がマップされる SQLData 実装のクラスオブジェクト)

戻り値:

この Ref オブジェクトが参照する SQL 構造化型のカスタムマッピングである Java の Object

例外:

SQLException - データベースアクセスエラーが発生した場合

導入されたバージョン:

1.4

関連項目:

setObject(java.lang.Object)

getObject

public Object getObject()
                 throws SQLException

この Ref オブジェクトによって参照される SQL 構造化型インスタンスを取得します。接続の型マップが構造化型のエントリを持つ場合、インスタンスはその型マップで示される Java のクラスへカスタムマッピングされます。そうでない場合は、構造化型インスタンスは Struct オブジェクトにマップされます。

戻り値:

この Ref オブジェクトが参照する SQL 構造化型のマッピングである Java の Object

例外:

SQLException - データベースアクセスエラーが発生した場合

導入されたバージョン:

1.4

関連項目:

setObject(java.lang.Object)

setObject

public void setObject(Object value)
               throws SQLException

この Ref オブジェクトが参照する構造化型値を Object の指定されたインスタンスに設定します。データベースに送るときに、ドライバはこれを SQL 構造化型に変換します。

パラメータ:

value - この Ref オブジェクトが参照する SQL 構造化型インスタンスを表す Object

例外:

SQLException - データベースアクセスエラーが発生した場合

導入されたバージョン:

1.4

関連項目:

getObject(), getObject(Map), PreparedStatement.setObject(int, Object), PreparedStatement#setObject(String, Object)