SerialStruct (Java 2 Platform SE 5.0)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM 2 Platform
Standard Ed. 5.0

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.sql.rowset.serial
クラス SerialStruct

java.lang.Object
  javax.sql.rowset.serial.SerialStruct

すべての実装されたインタフェース:: Serializable, Cloneable, Struct

public class SerialStruct
extends Object
implements Struct, Serializable, Cloneable
extends Object
implements Struct, Serializable, Cloneable

Java プログラミング言語での SQL 構造型の直列化マッピングです。まだ直列化されていない属性は、直列化フォームにマッピングされます。属性そのものが構造型である場合も、その属性のまだ直列化されていない属性は、それぞれ直列化フォームにマッピングされます。

このようなマッピングが存在する場合、構造型は、属性と同様に、Java プログラミング言語内のクラスにカスタムマップされます (適切な場合)。

SerialStruct クラスは、Struct オブジェクトからインスタンスを作成するためのコンストラクタと、データベース内の SQL 構造型の SQL 型名を取得するためのメソッドと、その属性値を取得するためのメソッドを提供します。

関連項目:: 直列化された形式

コンストラクタの概要
`SerialStruct(SQLData in, Map<String,Class<?>> map)` 指定された `SQLData` オブジェクトから、指定の型マップを使って `SerialStruct` オブジェクトを構築し、これを Java プログラミング言語のクラスにカスタムマップします。
`SerialStruct(Struct in, Map<String,Class<?>> map)` 指定された `Struct` オブジェクトから、指定された `java.util.Map` オブジェクトを使って、SQL 構造型か SQL 構造型の属性のいずれかのカスタムマッピングに使用する `SerialStruct` オブジェクトを構築します。

メソッドの概要
`Object[]`	`getAttributes()` この `SerialStruct` オブジェクトによって表される SQL 構造型の属性を格納する `Object` 値の配列を取得します。
`Object[]`	`getAttributes(Map<String,Class<?>> map)` 指定されたカスタムマッピング用の型マップを使って、この `SerialStruct` によって表される SQL 構造型の属性に相当する `Object` 値の配列を取得します (適切な場合)。
`String`	`getSQLTypeName()` この `SerialStruct` オブジェクトの SQL 型名を取得します。

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

SerialStruct

public SerialStruct(Struct in,
                    Map<String,Class<?>> map)
             throws SerialException

指定された Struct オブジェクトから、指定された java.util.Map オブジェクトを使って、SQL 構造型か SQL 構造型の属性のいずれかのカスタムマッピングに使用する SerialStruct オブジェクトを構築します。

パラメータ:: map - java.util.Map オブジェクト。オブジェクト内の各エントリは、(1) UDT の完全修飾名を指定する String オブジェクトと、(2) UDT のマッピング方法を定義する SQLData 実装の Class オブジェクトで構成される
例外:: SerialException - エラーが発生した場合
関連項目:: Struct

SerialStruct

public SerialStruct(SQLData in,
                    Map<String,Class<?>> map)
             throws SerialException

指定された SQLData オブジェクトから、指定の型マップを使って SerialStruct オブジェクトを構築し、これを Java プログラミング言語のクラスにカスタムマップします。型マップは、SQL 型とマップ先のクラスを指定します。SQLData オブジェクトは、SQL 型のマップ先のクラスを定義します。

パラメータ:: in - SQL 構造型と Java プログラミング言語の 1 個以上のオブジェクトのマッピングを定義する SQLData クラスのインスタンス; map - java.util.Map オブジェクト。オブジェクト内の各エントリは、(1) UDT の完全修飾名を指定する String オブジェクトと、(2) UDT のマッピング方法を定義する SQLData 実装の Class オブジェクトで構成される
例外:: SerialException - エラーが発生した場合

メソッドの詳細

getSQLTypeName

public String getSQLTypeName()
                      throws SerialException

この SerialStruct オブジェクトの SQL 型名を取得します。これは、構造型の SQL 定義で使用される名前に一致します。

定義:: インタフェース Struct 内の getSQLTypeName

戻り値:: この SerialStruct オブジェクトによって表される SQL 構造型の SQL 型名を表す String オブジェクト
例外:: SerialException - エラーが発生した場合

getAttributes

public Object[] getAttributes()
                       throws SerialException

この SerialStruct オブジェクトによって表される SQL 構造型の属性を格納する Object 値の配列を取得します。

定義:: インタフェース Struct 内の getAttributes

戻り値:: Object 値の配列。この SerialStruct オブジェクトによって表される SQL 構造型の属性を要素として格納する
例外:: SerialException - エラーが発生した場合

getAttributes

public Object[] getAttributes(Map<String,Class<?>> map)
                       throws SerialException

指定されたカスタムマッピング用の型マップを使って、この SerialStruct によって表される SQL 構造型の属性に相当する Object 値の配列を取得します (適切な場合)。

定義:: インタフェース Struct 内の getAttributes

パラメータ:: map - java.util.Map オブジェクト。オブジェクト内の各エントリは、(1) UDT の完全修飾名を指定する String オブジェクトと、(2) UDT のマッピング方法を定義する SQLData 実装の Class オブジェクトで構成される
戻り値:: Object 値の配列。この SerialStruct オブジェクトによって表される SQL 構造型の属性を要素として格納する
例外:: SerialException - エラーが発生した場合