SQLData (Java Platform SE 7)

```
public interface SQLData
```
SQL ユーザー定義型 (UDT) を Java プログラミング言語のクラスにカスタムマッピングするのに使用されるインタフェースです。SQLData インタフェースを実装するクラスのクラスオブジェクトは、カスタムマッピングされる UDT の SQL 名とともに適切な Connection オブジェクトの型マップに入力されます。
通常 SQLData 実装は、SQL 構造化型の各属性のフィールド、または SQL DISTINCT 型の単一フィールドを定義します。ResultSet.getObject メソッドによってデータソースから UDT が取得されると、その UDT はこのクラスのインスタンスとしてマッピングされます。プログラマは、Java プログラミング言語のほかのオブジェクトの場合と同じようにこのクラスインスタンスで操作し、PreparedStatement.setObject メソッドを呼び出して、行なった変更をこのクラスインスタンスに保存することができます。このメソッドは、このクラスインスタンスを SQL 型にマッピングし直します。
カスタムマッピングのクラスの実装をツールによって行うことが期待できます。通常の実装では、プログラマは単に SQL UDT の名前、その名前がマッピングされるクラスの名前、および UDT の各属性がマッピングされるフィールドの名前を指定するだけです。ツールはこの情報を使って SQLData.readSQL メソッドおよび SQLData.writeSQL メソッドを実装します。readSQL メソッドが該当の SQLInput メソッドを呼び出して SQLInput オブジェクトから各属性を読み込み、writeSQL メソッドが SQLOutput メソッドを呼び出して SQLOutput オブジェクトを使って各属性をデータソースに書き込みます。
通常アプリケーションプログラマが SQLData メソッドを直接呼び出すことはなく、SQLInput メソッドおよび SQLOutput メソッドは、アプリケーションコードによってではなく SQLData メソッドによって内部的に呼び出されます。

導入されたバージョン:

1.2

メソッドのサマリー

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

- メソッドの詳細
  - getSQLTypeName
```
String getSQLTypeName()
                      throws SQLException
```
    このオブジェクトが表す SQL ユーザー定義型の完全指定名を返します。このメソッドは、SQLData のこのインスタンスにマッピングされる UDT インスタンスの名前を取得するために JDBC ドライバによって呼び出されます。
    
    戻り値:
    このオブジェクトが生成され、値が設定されたときに readSQL メソッドに渡された型名
    
    例外:
    
    SQLException - データベースアクセスエラーがある場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - readSQL
```
void readSQL(SQLInput stream,
           String typeName)
             throws SQLException
```
    データベースから読み出したデータをこのオブジェクトに設定します。このメソッドの実装は次のプロトコルに従う必要があります。
    - 指定された入力ストリームから SQL 型の各属性または各要素を読み出す必要があります。これは、型の SQL 定義に現れる順序で入力ストリームのメソッドを呼び出して各項目を読み出すことによって行われます。
    - 続いて readSQL メソッドが、このオブジェクトまたはほかのオブジェクトの適切なフィールドまたは要素にデータを割り当てます。具体的には、該当する reader メソッド (SQLInput.readString、SQLInput.readBigDecimal など) を呼び出して次の処理を行う必要があります。個別の型の場合はその単一のデータ要素を読み込み、構造化型の場合は SQL 型の各属性の値を読み込みます。
    JDBC ドライバは、型マップを使って入力ストリームを初期化してから、ストリームで対応する SQLInput reader メソッドによって使用されるこのメソッドを呼び出します。
    パラメータ:
    stream - カスタムマッピングされる値のデータを読み込む SQLInput オブジェクト
    typeName - データストリームの値の SQL 型名
    
    例外:
    
    SQLException - データベースアクセスエラーがある場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
    
    関連項目:
    SQLInput
  - writeSQL
```
void writeSQL(SQLOutput stream)
              throws SQLException
```
    このオブジェクトをデータソースの SQL 値に変換し、指定された SQL データストリームに書き込みます。このメソッドの実装は次のプロトコルに従う必要があります。
    指定された出力ストリームに SQL 型の各属性を書き込む必要があります。これは、型の SQL 定義に表示される順番で出力ストリームのメソッドを呼び出して各項目を書き込むことによって行われます。具体的には、該当する SQLOutput writer メソッド (writeInt、writeString など) を呼び出して次の処理を行う必要があります。個別の型の場合は単一のデータ要素を書き込み、構造化型の場合は SQL 型の各属性の値を書き込みます。
    
    パラメータ:
    stream - カスタムマッピングされた値のデータを書き込む SQLOutput オブジェクト
    
    例外:
    
    SQLException - データベースアクセスエラーがある場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
    
    関連項目:
    SQLOutput

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

インタフェース SQLData

メソッドのサマリー

メソッドの詳細

getSQLTypeName

readSQL

writeSQL