java.sql
インタフェース SQLData

public interface SQLData

SQL ユーザ定義型のカスタムマッピングに使用されるインタフェースです。このインタフェースは、型マップに登録されているどの Java クラスも実装する必要があります。通常は、このインタフェースはツールによって実装されます。このインタフェースのメソッドはドライバによって呼び出され、プログラマによって直接呼び出されることはありません。

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

メソッドの概要

String	getSQLTypeName() このオブジェクトが表す SQL ユーザ定義型の完全指定名を返します。
void	readSQL(SQLInput stream, String typeName) データベースから読み出したデータをこのオブジェクトに設定します。
void	writeSQL(SQLOutput stream) 指定された SQL データストリームにこのオブジェクトを書き込み、逆にそれをデータソースの SQL 値に変換します。

メソッドの詳細

getSQLTypeName

public String getSQLTypeName()
                      throws SQLException

このオブジェクトが表す SQL ユーザ定義型の完全指定名を返します。このメソッドは、SQLData のこのインスタンスにマッピングされる UDT インスタンスの名前を取得するために JDBC ドライバによって呼び出されます。

戻り値:

このオブジェクトが生成され、値が設定されたときに readSql メソッドに渡された型名

例外:

SQLException - データベースアクセスエラーがある場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

readSQL

public void readSQL(SQLInput stream,
                    String typeName)
             throws SQLException

データベースから読み出したデータをこのオブジェクトに設定します。このメソッドの実装は次のプロトコルに従う必要があります。

• 指定された入力ストリームから SQL 型の各属性または各要素を読み出す必要があります。これは、型の SQL 定義に現れる順序で入力ストリームのメソッドを呼び出して各項目を読み出すことによって行われます。
• 続いてメソッド readSQL が、このオブジェクトまたは他のオブジェクトの適切なフィールドまたは要素にデータを割り当てます。具体的には、該当する SQLInput.readXXX メソッドを呼び出して以下の処理を行う必要があります。個別の型の場合はその単一のデータ要素を読み込み、構造化型の場合は SQL 型の各属性の値を読み込みます。

JDBC ドライバは、型マップを使って入力ストリームを初期化してから、ストリームで対応する SQLInput.readXXX メソッドによって使用されるこのメソッドを呼び出します。

パラメータ:

stream - カスタムマッピングされるデータの値を読み出す SQLInput オブジェクト

typeName - データストリームの値の SQL 型名

例外:

SQLException - データベースアクセスエラーがある場合

関連項目:

SQLInput

writeSQL

public void writeSQL(SQLOutput stream)
              throws SQLException

指定された SQL データストリームにこのオブジェクトを書き込み、逆にそれをデータソースの SQL 値に変換します。このメソッドの実装は次のプロトコルに従う必要があります。
指定された出力ストリームに SQL 型の各属性を書き込む必要があります。これは、型の SQL 定義に表示される順番で出力ストリームのメソッドを呼び出して各項目を書き込むことによって行われます。具体的には、該当する SQLOutput.writeXXX メソッドを呼び出して次の処理を行う必要があります。個別の型の場合は単一のデータ要素を書き込み、構造化型の場合は SQL 型の各属性の値を書き込みます。

パラメータ:

stream - カスタムマッピングされたデータの値を書き込む SQLOutput オブジェクト

例外:

SQLException - データベースアクセスエラーがある場合

導入されたバージョン:

1.2

関連項目:

SQLOutput, 「JDBC 2.0 API に含まれるもの」