java.sql
インタフェース Array

public interface Array

SQL 型 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 2.0 API で新しく追加されたものです。

メソッドの概要

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

メソッドの詳細

getBaseTypeName

public String getBaseTypeName()
                       throws SQLException

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

JDBC 2.0 API に含まれるもの

getBaseType

public int getBaseType()
                throws SQLException

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getArray

public Object getArray()
                throws SQLException

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getArray

public Object getArray(Map map)
                throws SQLException

この Array オブジェクトによって指定された SQL 配列の内容を取り出します。このメソッドは、指定された map を型マップのカスタマイズに使います。ただし、配列の基底型が map のユーザ定義型と一致しない場合は、代わりに標準のマップが使われます。このバージョンの getArray メソッドは指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。

パラメータ:

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getArray

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

この Array オブジェクトによって指定された SQL ARRAY 値の一部が格納されている配列を返します。指定された index で始まり、最大で count の連続する SQL 配列要素が格納されます。このメソッドは、型マップのカスタマイズのための接続に関連した型マップを使います。

パラメータ:

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

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getArray

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

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

このメソッドは、指定された map を型マップのカスタマイズに使います。ただし配列の基底型が map のユーザ定義型と一致しない場合は、代わりに標準のマップが使われます。このバージョンの getArray メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。

パラメータ:

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

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

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getResultSet

public ResultSet getResultSet()
                       throws SQLException

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

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getResultSet

public ResultSet getResultSet(Map map)
                       throws SQLException

この Array オブジェクトによって指定された SQL ARRAY 値の要素を含む結果セットを返します。このメソッドは、指定された map を型マップのカスタマイズに使います。ただし配列の基底型が map のユーザ定義型と一致しない場合は、代わりに標準のマッピングが使われます。このバージョンの getResultSet メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。

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

パラメータ:

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

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 - 配列へのアクセス中にエラーが発生した場合

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

getResultSet

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

インデックス index で始まり、最大で count の連続した要素が格納されている部分配列の要素を保持する結果セットを返します。このメソッドは、指定された map を型マップのカスタマイズに使います。ただし配列の基底型が map のユーザ定義型と一致しない場合は、代わりに標準のマップが使われます。このバージョンの getResultSet メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。

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

パラメータ:

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

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

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

戻り値:

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

例外:

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

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」