java.sql
インタフェース Array

public abstract interface Array

JDBC 2.0

SQL の ARRAY の Java^TM プログラミング言語でのマッピングです。デフォルトでは、Array は SQL 配列へのトランザクション期間中の参照です。デフォルトでは、Array は内部的に SQL LOCATOR(array) を使って実装されます。

メソッドの概要

Object	getArray() この Array オブジェクトによって指定された SQL 配列の内容を、Java プログラミング言語の配列の形式で取り出します。
Object	getArray(long index, int count) SQL 配列の一部が格納されている配列を返します。
Object	getArray(long index, int count, Map map) このオブジェクトによって指定された SQL 配列オブジェクトの一部が格納されている配列を返します。
Object	getArray(Map map) この Array オブジェクトによって指定された SQL 配列の内容を取り出します。
int	getBaseType() この Array オブジェクトによって指定された配列の要素の JDBC タイプを返します。
String	getBaseTypeName() この Array オブジェクトによって指定された配列の要素の SQL タイプ名を返します。
ResultSet	getResultSet() この Array オブジェクトによって指定された配列の要素が格納されている結果セットを返します。
ResultSet	getResultSet(long index, int count) インデックス index で始まり、最大で count の連続した部分配列の要素が格納されている結果セットを返します。
ResultSet	getResultSet(long index, int count, Map map) インデックス index で始まり、最大で count の連続した部分配列の要素が格納されている結果セットを返します。
ResultSet	getResultSet(Map map) この Array オブジェクトによって指定された配列の要素が格納されている結果セットを返し、指定された map を使って配列要素をマッピングします。

メソッドの詳細

getBaseTypeName

public String getBaseTypeName()
                       throws SQLException

この Array オブジェクトによって指定された配列の要素の SQL タイプ名を返します。要素が組み込み型の場合、このメソッドは要素のデータベース特有のタイプ名を返します。要素がユーザ定義型 (UDT) の場合、このメソッドは完全指定の SQL タイプ名を返します。

戻り値:

組み込み基底型の場合はデータベース特有の名前である String、UDT の基底型の場合は完全指定の SQL タイプ名

例外:

SQLException - タイプ名へのアクセス中にエラーが発生した場合

getBaseType

public int getBaseType()
                throws SQLException

この Array オブジェクトによって指定された配列の要素の JDBC タイプを返します。

戻り値:

この Array オブジェクトによって指定された配列の要素のタイプコードである、Types クラスからの定数

例外:

SQLException - 基底型へのアクセス中にエラーが発生した場合

getArray

public Object getArray()
                throws SQLException

この Array オブジェクトによって指定された SQL 配列の内容を、Java プログラミング言語の配列の形式で取り出します。このバージョンの getArray メソッドは、型マッピングのカスタマイズのために、接続に関連付けられている型マッピングを使います。

戻り値:

このオブジェクトによって指定された SQL ARRAY オブジェクトの順序付き要素が格納されている、Java プログラミング言語の配列

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getArray

public Object getArray(Map map)
                throws SQLException

この Array オブジェクトによって指定された SQL 配列の内容を取り出します。型マッピングのカスタマイズには、指定された map を使います。配列の基底型が map のユーザ定義型と一致しない場合は、代わりに標準のマッピングが使われます。

パラメータ:

map - SQL タイプ名の Java プログラミング言語のクラスへのマッピングが格納されている java.util.Map オブジェクト

戻り値:

このオブジェクトによって指定された SQL 配列の順序付き要素が格納されている、Java プログラミング言語の配列

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getArray

public Object getArray(long index,
                       int count)
                throws SQLException

SQL 配列の一部が格納されている配列を返します。指定された index で始まり、最大で count の連続する SQL 配列要素が格納されます。このメソッドは、型マッピングのカスタマイズには、接続に関連付けられている型マッピングを使います。

パラメータ:

index - 最初に取り出す要素の配列インデックス。最初の要素のインデックスは 1

count - 取り出す連続する SQL 配列要素の数

戻り値:

要素 index で始まり、最大で count の連続する SQL 配列要素が格納されている配列

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getArray

public Object getArray(long index,
                       int count,
                       Map map)
                throws SQLException

このオブジェクトによって指定された SQL 配列オブジェクトの一部が格納されている配列を返します。指定された index で始まり、最大で count の連続する SQL 配列要素が格納されます。配列の基底型が map のユーザ定義型と一致する場合、このメソッドは型マッピングのカスタマイズには、指定された map を使います。一致しない場合は、標準のマッピングが使われます。

パラメータ:

index - 最初に取り出す要素の配列インデックス。最初の要素のインデックスは 1

count - 取り出す連続する SQL 配列要素の数

map - SQL タイプ名とそれらがマッピングされる Java プログラミング言語のクラスが格納されている java.util.Map オブジェクト

戻り値:

この Array オブジェクトによって指定された SQL 配列の、要素 index で始まり、最大で count の連続する要素が格納されている配列

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getResultSet

public ResultSet getResultSet()
                       throws SQLException

この Array オブジェクトによって指定された配列の要素が格納されている結果セットを返します。適切な場合は、配列の要素は接続の型マッピングを使ってマッピングされます。そうでない場合は、標準のマッピングが使われます。

結果セットは配列要素ごとに 1 行を含み、各行には 2 つのカラムがあります。2 番目のカラムには要素の値が格納され、1 番目のカラムには配列内の対応する要素のインデックスが格納されます (最初の配列要素のインデックスは 1)。行は、インデックスに基づく昇順で並べられます。

戻り値:

この Array オブジェクトによって指定された配列の要素ごとに 1 行が格納されている ResultSet オブジェクト。行はインデックスに基づく昇順で並べられている

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getResultSet

public ResultSet getResultSet(Map map)
                       throws SQLException

この Array オブジェクトによって指定された配列の要素が格納されている結果セットを返し、指定された map を使って配列要素をマッピングします。配列の基底型が map のユーザ定義型と一致しない場合は、代わりに標準のマッピングが使われます。

結果セットは配列要素ごとに 1 行を含み、各行には 2 つのカラムがあります。2 番目のカラムには要素の値が格納され、1 番目のカラムには配列内の対応する要素のインデックスが格納されます (最初の配列要素のインデックスは 1)。行は、インデックスに基づく昇順で並べられます。

パラメータ:

map - SQL ユーザ定義型の Java プログラミング言語のクラスへのマッピングを格納する

戻り値:

この Array オブジェクトによって指定された配列の要素ごとに 1 行が格納されている ResultSet オブジェクト。行はインデックスに基づく昇順で並べられている

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getResultSet

public ResultSet getResultSet(long index,
                              int count)
                       throws SQLException

インデックス index で始まり、最大で count の連続した部分配列の要素が格納されている結果セットを返します。マップに基底型のエントリが格納されている場合、このメソッドは接続の型マッピングを使って配列の要素をマッピングします。そうでない場合は、標準のマッピングが使われます。

結果セットは、このオブジェクトによって指定された SQL 配列の要素ごとに 1 行を含み、最初の行にはインデックス index にある要素が格納されます。結果セットには、最大で count の行がインデックスに基づく昇順で格納されます。各行には 2 つのカラムがあります。2 番目のカラムには要素の値が格納され、1 番目のカラムには配列内に対応する要素のインデックスが格納されます。

パラメータ:

index - 最初に取り出す要素の配列インデックス。最初の要素のインデックスは 1

count連続した取り出す - SQL 配列要素の数

戻り値:

この Array オブジェクトによって指定された SQL 配列の、インデックス index で始まり、最大で count の連続する要素が格納されている ResultSet オブジェクト

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合

getResultSet

public ResultSet getResultSet(long index,
                              int count,
                              Map map)
                       throws SQLException

インデックス index で始まり、最大で count の連続した部分配列の要素が格納されている結果セットを返します。配列の基底型が map のユーザ定義型と一致する場合、このメソッドは Map オブジェクト map を使って配列の要素をマッピングします。一致する場合は、標準のマッピングが使われます。

結果セットは、このオブジェクトで指定された SQL 配列の要素ごとに 1 行を含み、最初の行にはインデックス index にある要素が格納されます。結果セットには、最大で count の行がインデックスに基づく昇順で格納されます。各行には 2 つのカラムがあります。2 番目のカラムには要素の値が格納され、1 番目のカラムには配列内の要素に対応するインデックスが格納されます。

パラメータ:

index - 最初に取り出す要素の配列インデックス。最初の要素のインデックスは 1

count - 取り出す連続する SQL 配列要素の数

map - SQL タイプ名の Java プログラミング言語のクラスへのマッピングが格納されている Map オブジェクト

戻り値:

この Array オブジェクトによって指定された SQL 配列の、インデックス index で始まり、最大で count の連続した要素が格納されている ResultSet オブジェクト

例外:

SQLException - 配列へのアクセス中にエラーが発生した場合