Интерфейс Array

Все известные реализующие классы:: SerialArray

public interface Array

Отображение типа SQL ARRAY в языке программирования Java. По умолчанию значение Array является ссылкой на значение SQL ARRAY, действительной в течение транзакции. По умолчанию объект Array реализуется внутри системы с использованием SQL LOCATOR(array), то есть объект Array содержит логический указатель на данные в значении SQL ARRAY, а не сами данные значения ARRAY.

Интерфейс Array предоставляет методы для передачи данных значения SQL ARRAY клиенту в виде массива или объекта ResultSet. Если элементы SQL ARRAY являются UDT, для них можно задать пользовательское отображение. Для создания пользовательского отображения программист должен выполнить два действия:

создать класс, реализующий интерфейс SQLData для UDT, для которого задается пользовательское отображение.
добавить запись в карту типов, содержащую
- полное имя типа SQL для UDT
- объект Class для класса, реализующего SQLData

Если методам getArray и getResultSet передана карта типов с записью для базового типа, содержащиеся в ней сведения будут использоваться для отображения элементов значения ARRAY. Если карта типов не передана, что обычно и происходит, по умолчанию используется карта типов соединения. Если в карте типов соединения или переданной методу карте типов нет записи для базового типа, элементы отображаются согласно стандартному отображению.

Если драйвер JDBC поддерживает этот тип данных, все методы интерфейса Array должны быть полностью реализованы.

С версии:: 1.2

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`free()`	Этот метод освобождает объект `Array` и высвобождает занимаемые им ресурсы.
`Object`	`getArray()`	Извлекает содержимое значения SQL `ARRAY`, обозначенного этим объектом `Array`, в виде массива языка программирования Java.
`Object`	`getArray(long index, int count)`	Извлекает срез значения SQL `ARRAY`, обозначенного этим объектом `Array`, начиная с указанного `index` и содержащий до `count` следующих элементов SQL-массива.
`Object`	`getArray(long index, int count, Map<String,Class<?>> map)`	Извлекает срез значения SQL `ARRAY`, обозначенного этим объектом `Array`, начиная с указанного `index` и содержащий до `count` следующих элементов SQL-массива.
`Object`	`getArray(Map<String,Class<?>> map)`	Извлекает содержимое значения SQL `ARRAY`, обозначенного этим объектом `Array`.
`int`	`getBaseType()`	Извлекает тип JDBC элементов массива, обозначенного этим объектом `Array`.
`String`	`getBaseTypeName()`	Извлекает имя типа SQL элементов массива, обозначенного этим объектом `Array`.
`ResultSet`	`getResultSet()`	Извлекает результирующий набор, содержащий элементы значения SQL `ARRAY`, обозначенного этим объектом `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)`	Извлекает результирующий набор, содержащий элементы значения SQL `ARRAY`, обозначенного этим объектом `Array`.

Подробное описание методов

getBaseTypeName

String getBaseTypeName() throws SQLException

Извлекает имя типа SQL элементов массива, обозначенного этим объектом Array. Если элементы относятся к встроенному типу, возвращает специфичное для базы данных имя их типа. Если элементы относятся к пользовательскому типу (UDT), этот метод возвращает полное имя типа SQL.

Возвращает:: String, содержащее специфичное для базы данных имя встроенного базового типа или полное имя типа SQL для базового типа, являющегося UDT
Выбрасывает:: SQLException — если при попытке получить доступ к имени типа возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getBaseType

int getBaseType() throws SQLException

Извлекает тип JDBC элементов массива, обозначенного этим объектом Array.

Возвращает:: константу из класса Types, представляющую код типа элементов массива, обозначенного этим объектом Array
Выбрасывает:: SQLException — если при попытке получить доступ к базовому типу возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getArray

Object getArray() throws SQLException

Извлекает содержимое значения SQL ARRAY, обозначенного этим объектом Array, в виде массива языка программирования Java. Эта версия метода getArray использует карту типов, связанную с соединением, для настройки отображений типов.

Примечание: Если getArray используется для материализации базового типа, отображаемого в примитивный тип данных, то выбор между массивом этого примитивного типа данных и массивом Object для возвращаемого массива определяется реализацией.

Возвращает:: массив языка программирования Java, содержащий упорядоченные элементы значения SQL ARRAY, обозначенного этим объектом Array
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getArray

Object getArray(Map<String,Class<?>> map) throws SQLException

Извлекает содержимое значения SQL ARRAY, обозначенного этим объектом Array. Этот метод использует указанную map для настройки отображения типов, если только базовый тип массива не соответствует пользовательскому типу в map; в этом случае используется стандартное отображение. Эта версия метода getArray использует либо заданную карту типов, либо стандартное отображение и никогда не использует карту типов, связанную с соединением.

Параметры:: map — объект java.util.Map, содержащий сопоставления имен типов SQL с классами языка программирования Java
Возвращает:: массив языка программирования Java, содержащий упорядоченные элементы SQL-массива, обозначенного этим объектом
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getArray

Object getArray(long index, int count) throws SQLException

Извлекает срез значения SQL ARRAY, обозначенного этим объектом Array, начиная с указанного index и содержащий до count следующих элементов SQL-массива. Для настройки отображений типов этот метод использует карту типов, связанную с соединением.

Параметры:: index — индекс массива первого извлекаемого элемента; первый элемент имеет индекс 1; count — количество следующих подряд элементов SQL-массива, которые нужно извлечь
Возвращает:: массив, содержащий до count последовательных элементов SQL-массива, начиная с элемента index
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getArray

Object getArray(long index, int count, Map<String,Class<?>> map) throws SQLException

Извлекает срез значения SQL ARRAY, обозначенного этим объектом Array, начиная с указанного index и содержащий до count следующих элементов SQL-массива.

Этот метод использует указанную map для настройки отображения типов, если только базовый тип массива не соответствует пользовательскому типу в map; в этом случае используется стандартное отображение. Эта версия метода getArray использует либо заданную карту типов, либо стандартное отображение и никогда не использует карту типов, связанную с соединением.

Параметры:: index — индекс массива первого извлекаемого элемента; первый элемент имеет индекс 1; count — количество следующих подряд элементов SQL-массива, которые нужно извлечь; map — объект java.util.Map, содержащий имена типов SQL и соответствующие им классы языка программирования Java
Возвращает:: массив, содержащий до count последовательных элементов значения SQL ARRAY, обозначенного этим объектом Array, начиная с элемента index
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getResultSet

ResultSet getResultSet() throws SQLException

Извлекает результирующий набор, содержащий элементы значения SQL ARRAY, обозначенного этим объектом Array. Если это применимо, элементы массива отображаются с использованием карты типов соединения; в противном случае используется стандартное отображение.

Результирующий набор содержит одну строку для каждого элемента массива и два столбца в каждой строке. Во втором столбце хранится значение элемента, а в первом — индекс этого элемента в массиве (первый элемент массива имеет индекс 1). Строки упорядочены по возрастанию индексов.

Возвращает:: объект ResultSet, содержащий по одной строке для каждого элемента массива, обозначенного этим объектом Array; строки упорядочены по возрастанию индексов.
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getResultSet

ResultSet getResultSet(Map<String,Class<?>> map) throws SQLException

Извлекает результирующий набор, содержащий элементы значения SQL ARRAY, обозначенного этим объектом Array. Этот метод использует указанную map для настройки отображения типов, если только базовый тип массива не соответствует пользовательскому типу в map; в этом случае используется стандартное отображение. Эта версия метода getResultSet использует либо заданную карту типов, либо стандартное отображение и никогда не использует карту типов, связанную с соединением.

Параметры:: map — содержит сопоставление пользовательских типов SQL с классами языка программирования Java
Возвращает:: объект ResultSet, содержащий по одной строке для каждого элемента массива, обозначенного этим объектом Array; строки упорядочены по возрастанию индексов.
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getResultSet

ResultSet getResultSet(long index, int count) throws SQLException

Извлекает результирующий набор, содержащий элементы подмассива, который начинается с индекса index и включает до count следующих элементов. Этот метод использует карту типов соединения для отображения элементов массива, если карта содержит запись для базового типа. В противном случае используется стандартное отображение.

Результирующий набор содержит одну строку для каждого элемента SQL-массива, обозначенного этим объектом; в первой строке находится элемент с индексом index. Результирующий набор содержит до count строк, упорядоченных по возрастанию индексов. Каждая строка имеет два столбца: во втором хранится значение элемента, а в первом — его индекс в массиве.

Параметры:: index — индекс массива первого извлекаемого элемента; первый элемент имеет индекс 1; count — количество следующих подряд элементов SQL-массива, которые нужно извлечь
Возвращает:: объект ResultSet, содержащий до count последовательных элементов SQL-массива, обозначенного этим объектом Array, начиная с индекса index.
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

getResultSet

ResultSet getResultSet(long index, int count, Map<String,Class<?>> map) throws SQLException

Извлекает результирующий набор, содержащий элементы подмассива, который начинается с индекса index и включает до count следующих элементов. Этот метод использует указанную map для настройки отображения типов, если только базовый тип массива не соответствует пользовательскому типу в map; в этом случае используется стандартное отображение. Эта версия метода getResultSet использует либо заданную карту типов, либо стандартное отображение и никогда не использует карту типов, связанную с соединением.

Параметры:: index — индекс массива первого извлекаемого элемента; первый элемент имеет индекс 1; count — количество следующих подряд элементов SQL-массива, которые нужно извлечь; map — объект Map, содержащий сопоставления имен типов SQL с классами языка программирования Java(tm)
Возвращает:: объект ResultSet, содержащий до count последовательных элементов SQL-массива, обозначенного этим объектом Array, начиная с индекса index.
Выбрасывает:: SQLException — если при попытке получить доступ к массиву возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.2

free

void free() throws SQLException

Этот метод освобождает объект Array и высвобождает занимаемые им ресурсы. После вызова метода free объект становится недействительным.

После вызова free любая попытка вызвать метод, отличный от free, приведет к выбрасыванию SQLException. При многократном вызове free последующие вызовы free не выполняют никаких действий.

Выбрасывает:: SQLException — если при освобождении ресурсов Array возникает ошибка; SQLFeatureNotSupportedException — если драйвер JDBC не поддерживает этот метод
С версии:: 1.6

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.sql/java/sql/Array.html