Array (Java Platform SE 7)

既知のすべての実装クラス:

SerialArray
```
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 ドライバがそのデータ型をサポートする場合は、Array インタフェースのすべてのメソッドが完全に実装される必要があります。
導入されたバージョン:

1.2

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`void`	`free()` このメソッドは、`Array` オブジェクトを解放して、保持されているリソースを解放します。
`Object`	`getArray()` この `Array` オブジェクトによって指定された SQL `ARRAY` 値の内容を、Java プログラミング言語の配列の形式で取り出します。
`Object`	`getArray(long index, int count)` この `Array` オブジェクトによって指定された SQL `ARRAY` 値の一部を取り出します。指定された `index` で始まり、最大で `count` の連続する SQL 配列要素が格納されます。
`Object`	`getArray(long index, int count, Map<String,Class<?>> map)` この `Array` オブジェクトによって指定された SQL `ARRAY` 値の一部を取り出します。指定された `index` で始まり、最大で `count` の連続する SQL 配列要素が格納されます。
`Object`	`getArray(Map<String,Class<?>> map)` この `Array` オブジェクトによって指定された SQL `ARRAY` 値の内容を取り出します。
`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<String,Class<?>> map)` インデックス `index` で始まり、最大で `count` の連続した要素が格納されている部分配列の要素を保持する結果セットを取得します。
`ResultSet`	`getResultSet(Map<String,Class<?>> map)` この `Array` オブジェクトによって指定された SQL `ARRAY` 値の要素を含む結果セットを取得します。

- メソッドの詳細
  - 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 オブジェクトによって指定された SQL ARRAY 値の内容を、Java プログラミング言語の配列の形式で取り出します。このバージョンの getArray メソッドは、型マッピングのカスタマイズのために、接続に関連した型マップを使用します。
    注:getArray を使用してプリミティブデータ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブデータ型の配列と Object の配列のどちらであるかは、実装で定義されます。
    
    戻り値:
    この Array オブジェクトによって指定された SQL ARRAY 値の順序付き要素が格納されている、Java プログラミング言語の配列
    
    例外:
    
    SQLException - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getArray
```
Object getArray(Map<String,Class<?>> map)
                throws SQLException
```
    この Array オブジェクトによって指定された SQL ARRAY 値の内容を取り出します。このメソッドは、指定された map を型マップのカスタマイズに使います。ただし配列の基底型が map のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。このバージョンの getArray メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。
    注:getArray を使用してプリミティブデータ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブデータ型の配列と Object の配列のどちらであるかは、実装で定義されます。
    
    パラメータ:
    map - SQL の型名の Java プログラミング言語のクラスへのマッピングが格納されている java.util.Map オブジェクト
    
    戻り値:
    このオブジェクトによって指定された SQL 配列の順序付き要素が格納されている、Java プログラミング言語の配列
    
    例外:
    
    SQLException - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getArray
```
Object getArray(long index,
              int count)
                throws SQLException
```
    この Array オブジェクトによって指定された SQL ARRAY 値の一部を取り出します。指定された index で始まり、最大で count の連続する SQL 配列要素が格納されます。このメソッドは、型マップのカスタマイズには、接続に関連する型マップを使います。
    注:getArray を使用してプリミティブデータ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブデータ型の配列と Object の配列のどちらであるかは、実装で定義されます。
    
    パラメータ:
    index - 最初に取り出す要素の配列インデックス。最初の要素のインデックスは 1
    count - 取り出す連続する SQL 配列要素の数
    
    戻り値:
    要素 index で始まり、最大で count の連続する SQL 配列要素が格納されている配列
    
    例外:
    
    SQLException - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getArray
```
Object getArray(long index,
              int count,
              Map<String,Class<?>> map)
                throws SQLException
```
    この Array オブジェクトによって指定された SQL ARRAY 値の一部を取り出します。指定された index で始まり、最大で count の連続する SQL 配列要素が格納されます。
    このメソッドは、指定された map を型マップのカスタマイズに使います。ただし配列の基底型が map のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。このバージョンの getArray メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。
    注:getArray を使用してプリミティブデータ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブデータ型の配列と Object の配列のどちらであるかは、実装で定義されます。
    
    パラメータ:
    index - 最初に取り出す要素の配列インデックス。最初の要素のインデックスは 1
    count - 取り出す連続する SQL 配列要素の数
    map - SQL の型名とそれらがマッピングされる Java プログラミング言語のクラスが格納されている java.util.Map オブジェクト
    
    戻り値:
    この Array オブジェクトによって指定された SQL ARRAY 値の、要素 index で始まり、最大で count の連続する要素が格納されている配列
    
    例外:
    
    SQLException - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getResultSet
```
ResultSet getResultSet()
                       throws SQLException
```
    この Array オブジェクトによって指定された SQL ARRAY 値の要素を含む結果セットを取得します。該当する場合は、配列の要素が接続の型マップを使ってマッピングされます。そうでない場合は、標準のマップが使用されます。
    結果セットは配列要素ごとに 1 行を含み、各行には 2 つの列があります。2 番目の列には要素の値が格納され、1 番目の列には配列内の対応する要素のインデックスが格納されます (最初の配列要素のインデックスは 1)。行は、インデックスに基づく昇順で並べられます。
    
    戻り値:
    この Array オブジェクトによって指定された配列の要素ごとに 1 行が格納されている ResultSet オブジェクト。行はインデックスに基づく昇順で並べられている。
    
    例外:
    
    SQLException - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getResultSet
```
ResultSet getResultSet(Map<String,Class<?>> map)
                       throws SQLException
```
    この Array オブジェクトによって指定された SQL ARRAY 値の要素を含む結果セットを取得します。このメソッドは、指定された map を型マップのカスタマイズに使います。ただし配列の基底型が map のユーザー定義型と一致しない場合は、代わりに標準のマップが使われます。このバージョンの getResultSet メソッドは、指定された型マップか、標準マップのどちらかを使います。接続に関連した型マップは使われません。
    結果セットは配列要素ごとに 1 行を含み、各行には 2 つの列があります。2 番目の列には要素の値が格納され、1 番目の列には配列内の対応する要素のインデックスが格納されます (最初の配列要素のインデックスは 1)。行は、インデックスに基づく昇順で並べられます。
    
    パラメータ:
    map - SQL ユーザー定義型の Java プログラミング言語のクラスへのマッピングを格納する
    
    戻り値:
    この Array オブジェクトによって指定された配列の要素ごとに 1 行が格納されている ResultSet オブジェクト。行はインデックスに基づく昇順で並べられている。
    
    例外:
    
    SQLException - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getResultSet
```
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 - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - getResultSet
```
ResultSet getResultSet(long index,
                     int count,
                     Map<String,Class<?>> 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 - 配列へのアクセス中にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.2
  - free
```
void free()
          throws SQLException
```
    このメソッドは、Array オブジェクトを解放して、保持されているリソースを解放します。free メソッドが一度呼び出されたあとは、オブジェクトは無効になります。
    free が呼び出されると、free 以外のメソッドを呼び出そうとしても、SQLException がスローされます。free を複数回呼び出した場合、2 回目以降の free 呼び出しは何も行わないものとして扱われます。
    
    例外:
    
    SQLException - Array のリソースの解放時にエラーが発生した場合
    
    SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
    導入されたバージョン:
    
    1.6

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

インタフェース Array

メソッドのサマリー

メソッドの詳細

getBaseTypeName

getBaseType

getArray

getArray

getArray

getArray

getResultSet

getResultSet

getResultSet

getResultSet

free