java.sql
インタフェース SQLData

public abstract interface SQLData

JDBC 2.0

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

メソッドの概要

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

メソッドの詳細

getSQLTypeName

public String getSQLTypeName()
                      throws SQLException

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

戻り値:

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

readSQL

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

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

指定された入力ストリームから SQL タイプの各属性または各要素を読み出す必要があります。これは、タイプの SQL 定義に表示される順番で、入力ストリームのメソッドを呼び出して各項目を読み出すことによって行われます。次に、readSQL メソッドはそのデータを、(このオブジェクトまたはほかのオブジェクトの) 対応するフィールドまたは要素に代入します。特に、次の処理を行うために対応する SQLInput.readXXX メソッドを呼び出す必要があります。個別の型の場合は、単一のデータ要素を読み出し、構造化型の場合は、SQL タイプの各属性の値を読み出します。

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

パラメータ:

stream - 入力 SQL データストリーム

typeName - データストリームの値の SQL タイプ

関連項目:

SQLInput

writeSQL

public void writeSQL(SQLOutput stream)
              throws SQLException

このオブジェクトを指定された SQL データストリームに書き込みます。このメソッドの実装は次のプロトコルに従う必要があります。

指定された出力ストリームに SQL タイプの各属性を書き込む必要があります。これは、タイプの SQL 定義に表示される順番で、出力ストリームのメソッドを呼び出して各項目を書き込むことによって行われます。特に、次の処理を行うために対応する SQLOutput.writeXXX メソッドを呼び出す必要があります。個別の型の場合は、単一のデータ要素を書き込み、構造化型の場合、SQL タイプの各属性の値を書き込みます。

パラメータ:

stream - 出力 SQL データストリーム

関連項目:

SQLOutput