- 既知のすべての実装クラス:
SerialArray
ARRAY
のJavaプログラミング言語でのマッピングです。 デフォルトでは、Array
値はSQL ARRAY
値へのトランザクション期間中の参照です。 デフォルトでは、Array
オブジェクトは内部的にSQL LOCATOR(array)を使って実装されます。これはつまり、Array
オブジェクトは、ARRAY
値のデータを含むのではなく、SQL ARRAY
値のデータへの論理ポインタを含むということです。
Array
インタフェースは、SQL ARRAY
値のデータを配列またはResultSet
オブジェクトとしてクライアントに渡すメソッドを提供します。 SQL ARRAY
の要素がUDTの場合、要素はカスタム・マッピングできます。 カスタム・マッピングを作成するために、プログラマは次の2つを行う必要があります。
- カスタム・マッピングされるUDTの
SQLData
インタフェースを実装するクラスを作成します。 - 次の項目を含む型マップにエントリを作成します。
- UDTの完全指定されたSQLの型名
SQLData
を実装するクラスのClass
オブジェクト
基底型のエントリを持つ型マップがgetArray
およびgetResultSet
メソッドに提供されると、その型マップに含まれるマッピングは、ARRAY
値の要素をマッピングするのに使用されます。 通常は型マップは提供されず、その場合には接続の型マップがデフォルトで使用されます。 接続の型マップまたはメソッドに提供された型マップが基底型のエントリを持っていない場合、要素は標準マップに従ってマッピングされます。
JDBCドライバがそのデータ型をサポートする場合は、Array
インタフェースのすべてのメソッドが完全に実装される必要があります。
- 導入されたバージョン:
- 1.2
-
メソッドのサマリー
修飾子と型メソッド説明void
free()
このメソッドは、Array
オブジェクトを解放して、保持されているリソースを解放します。getArray()
このArray
オブジェクトによって指定されたSQLARRAY
値の内容を、Javaプログラミング言語の配列の形式で取り出します。getArray
(long index, int count) このArray
オブジェクトによって指定されたSQLARRAY
値の一部を取り出します。指定されたindex
で始まり、最大でcount
の連続するSQL配列要素が格納されます。このArray
オブジェクトによって指定されたSQLARRAY
値の一部を取り出します。指定されたindex
で始まり、最大でcount
の連続するSQL配列要素が格納されます。このArray
オブジェクトによって指定されたSQLARRAY
値の内容を取り出します。int
このArray
オブジェクトによって指定された配列の要素のJDBCの型を取得します。このArray
オブジェクトによって指定された配列の要素のSQLの型名を取得します。このArray
オブジェクトによって指定されたSQLARRAY
値の要素を含む結果セットを取得します。getResultSet
(long index, int count) インデックスindex
で始まり、最大でcount
の連続した要素が格納されている部分配列の要素を保持する結果セットを取得します。getResultSet
(long index, int count, Map<String, Class<?>> map) インデックスindex
で始まり、最大でcount
の連続した要素が格納されている部分配列の要素を保持する結果セットを取得します。getResultSet
(Map<String, Class<?>> map) このArray
オブジェクトによって指定されたSQLARRAY
値の要素を含む結果セットを取得します。
-
メソッドの詳細
-
getBaseTypeName
String getBaseTypeName() throws SQLExceptionこのArray
オブジェクトによって指定された配列の要素のSQLの型名を取得します。 要素が組込み型の場合、このメソッドは要素のデータベース特有の型名を返します。 要素がユーザー定義型(UDT)の場合、このメソッドは完全指定のSQLの型名を返します。- 戻り値:
- 組込み基底型の場合はデータベース特有の名前である
String
、UDTの基底型の場合は完全指定のSQLの型名 - 例外:
SQLException
- 型名へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getBaseType
int getBaseType() throws SQLExceptionこのArray
オブジェクトによって指定された配列の要素のJDBCの型を取得します。- 戻り値:
- この
Array
オブジェクトによって指定された配列の要素の型コードである、Types
クラスからの定数 - 例外:
SQLException
- 基底型へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getArray
Object getArray() throws SQLExceptionこのArray
オブジェクトによって指定されたSQLARRAY
値の内容を、Javaプログラミング言語の配列の形式で取り出します。 このバージョンのgetArray
メソッドは、型マッピングのカスタマイズのために、接続に関連した型マップを使用します。ノート:
getArray
を使用してプリミティブ・データ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブ・データ型の配列とObject
の配列のどちらであるかは、実装で定義されます。- 戻り値:
- この
Array
オブジェクトによって指定されたSQLARRAY
値の順序付き要素が格納されている、Javaプログラミング言語の配列 - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getArray
このArray
オブジェクトによって指定されたSQLARRAY
値の内容を取り出します。 このメソッドは、指定されたmap
を型マップのカスタマイズに使います。ただし配列の基底型がmap
のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。 このバージョンのgetArray
メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。ノート:
getArray
を使用してプリミティブ・データ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブ・データ型の配列とObject
の配列のどちらであるかは、実装で定義されます。- パラメータ:
map
- SQLの型名のJavaプログラミング言語のクラスへのマッピングが格納されているjava.util.Map
オブジェクト- 戻り値:
- このオブジェクトによって指定されたSQL配列の順序付き要素が格納されている、Javaプログラミング言語の配列
- 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getArray
このArray
オブジェクトによって指定されたSQLARRAY
値の一部を取り出します。指定されたindex
で始まり、最大でcount
の連続するSQL配列要素が格納されます。 このメソッドは、型マップのカスタマイズには、接続に関連する型マップを使います。ノート:
getArray
を使用してプリミティブ・データ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブ・データ型の配列とObject
の配列のどちらであるかは、実装で定義されます。- パラメータ:
index
- 最初に取り出す要素の配列インデックス。最初の要素のインデックスは1count
- 取り出す連続するSQL配列要素の数- 戻り値:
- 要素
index
で始まり、最大でcount
の連続するSQL配列要素が格納されている配列 - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getArray
このArray
オブジェクトによって指定されたSQLARRAY
値の一部を取り出します。指定されたindex
で始まり、最大でcount
の連続するSQL配列要素が格納されます。このメソッドは、指定された
map
を型マップのカスタマイズに使います。ただし配列の基底型がmap
のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。 このバージョンのgetArray
メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。ノート:
getArray
を使用してプリミティブ・データ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブ・データ型の配列とObject
の配列のどちらであるかは、実装で定義されます。- パラメータ:
index
- 最初に取り出す要素の配列インデックス。最初の要素のインデックスは1count
- 取り出す連続するSQL配列要素の数map
- SQLの型名とそれらがマッピングされるJavaプログラミング言語のクラスが格納されているjava.util.Map
オブジェクト- 戻り値:
- この
Array
オブジェクトによって指定されたSQLARRAY
値の、要素index
で始まり、最大でcount
の連続する要素が格納されている配列 - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getResultSet
ResultSet getResultSet() throws SQLExceptionこのArray
オブジェクトによって指定されたSQLARRAY
値の要素を含む結果セットを取得します。 該当する場合は、配列の要素が接続の型マップを使ってマッピングされます。そうでない場合は、標準のマップが使用されます。結果セットは配列要素ごとに1行を含み、各行には2つの列があります。 2番目の列には要素の値が格納され、1番目の列には配列内の対応する要素のインデックスが格納されます(最初の配列要素のインデックスは1)。 行は、インデックスに基づく昇順で並べられます。
- 戻り値:
- この
Array
オブジェクトによって指定された配列の要素ごとに1行が格納されているResultSet
オブジェクト。行はインデックスに基づく昇順で並べられている。 - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getResultSet
このArray
オブジェクトによって指定されたSQLARRAY
値の要素を含む結果セットを取得します。 このメソッドは、指定されたmap
を型マップのカスタマイズに使います。ただし配列の基底型がmap
のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。 このバージョンのgetResultSet
メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。結果セットは配列要素ごとに1行を含み、各行には2つの列があります。 2番目の列には要素の値が格納され、1番目の列には配列内の対応する要素のインデックスが格納されます(最初の配列要素のインデックスは1)。 行は、インデックスに基づく昇順で並べられます。
- パラメータ:
map
- SQLユーザー定義型のJavaプログラミング言語のクラスへのマッピングを格納する- 戻り値:
- この
Array
オブジェクトによって指定された配列の要素ごとに1行が格納されているResultSet
オブジェクト。行はインデックスに基づく昇順で並べられている。 - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getResultSet
インデックスindex
で始まり、最大でcount
の連続した要素が格納されている部分配列の要素を保持する結果セットを取得します。 マップに基底型のエントリが格納されている場合、このメソッドは接続の型マップを使って配列の要素をマッピングします。 そうでない場合は、標準のマップが使われます。結果セットは、このオブジェクトで指定されたSQL配列の要素ごとに1行を含み、最初の行にはインデックス
index
にある要素が格納されます。 結果セットには、最大でcount
の行がインデックスに基づく昇順で格納されます。 各行には2つの列があります。2番目の列には要素の値が格納され、1番目の列には配列内の要素に対応するインデックスが格納されます。- パラメータ:
index
- 最初に取り出す要素の配列インデックス。最初の要素のインデックスは1count
- 取り出す連続するSQL配列要素の数- 戻り値:
- この
Array
オブジェクトによって指定されたSQL配列の、インデックスindex
で始まり、最大でcount
の連続した要素が格納されているResultSet
オブジェクト - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
getResultSet
インデックスindex
で始まり、最大でcount
の連続した要素が格納されている部分配列の要素を保持する結果セットを取得します。 このメソッドは、指定されたmap
を型マップのカスタマイズに使います。ただし配列の基底型がmap
のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。 このバージョンのgetResultSet
メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。結果セットは、このオブジェクトで指定されたSQL配列の要素ごとに1行を含み、最初の行にはインデックス
index
にある要素が格納されます。 結果セットには、最大でcount
の行がインデックスに基づく昇順で格納されます。 各行には2つの列があります。2番目の列には要素の値が格納され、1番目の列には配列内の要素に対応するインデックスが格納されます。- パラメータ:
index
- 最初に取り出す要素の配列インデックス。最初の要素のインデックスは1count
- 取り出す連続するSQL配列要素の数map
- SQL型名のJavaプログラミング言語のクラスへのマップが格納されているMap
オブジェクト- 戻り値:
- この
Array
オブジェクトによって指定されたSQL配列の、インデックスindex
で始まり、最大でcount
の連続した要素が格納されているResultSet
オブジェクト - 例外:
SQLException
- 配列へのアクセス中にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.2
-
free
void free() throws SQLExceptionこのメソッドは、Array
オブジェクトを解放して、保持されているリソースを解放します。free
メソッドが一度呼び出されたあとは、オブジェクトは無効になります。free
が呼び出されると、free
以外のメソッドを呼び出そうとしても、SQLException
がスローされます。free
を複数回呼び出した場合、2回目以降のfree
呼出しは何も行わないものとして扱われます。- 例外:
SQLException
- Arrayのリソースの解放時にエラーが発生した場合SQLFeatureNotSupportedException
- JDBCドライバがこのメソッドをサポートしない場合- 導入されたバージョン:
- 1.6
-