Интерфейс Array

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

public interface Array

Сопоставление в языке программирования Java для типа SQL ARRAY. По умолчанию значение Array — ссылка на значение SQL ARRAY, использующаяся в рамках транзакции. По умолчанию объект Array реализован с использованием внутреннего SQL-локатора (массива), что означает, что объект Array содержит логическую ссылку на данные в значении SQL ARRAY, а не данные самого значения ARRAY.

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

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

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

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

С:: 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 типа элементов в массиве, обозначенном этим объектом. Если элементы имеют встроенный тип, возвращает имя типа, специфичное для базы данных. Если элементы имеют пользовательский тип (UDT), метод возвращает полностью квалифицированное имя SQL типа.

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

getBaseType

int getBaseType() throws SQLException

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

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

getArray

Object getArray() throws SQLException

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

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

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

getArray

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

Получает содержимое значения SQL массива, обозначенного этим объектом. Этот метод использует указанную 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 массива, обозначенного этим объектом, начиная с указанного 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 массива, обозначенного этим объектом, начиная с указанного index и содержащего до count последовательных элементов SQL массива.

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

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

getResultSet

ResultSet getResultSet() throws SQLException

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

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

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

getResultSet

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

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

Параметры:: map - содержит сопоставление SQL пользовательских типов с классами в языке программирования Java
Возвращает:: объект ResultSet, содержащий одну строку для каждого элемента в массиве, обозначенном этим объектом, со строками в порядке возрастания по индексам.
Выбрасывает:: 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 обрабатываются как no-op.

Исключения:: SQLException - если произошла ошибка при освобождении ресурсов массива; 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://download.java.net/java/early_access/jdk24/docs/api/java.sql/java/sql/Array.html