Интерфейс SQLData

public interface SQLData

Интерфейс, используемый для пользовательского сопоставления SQL типа данных (UDT) с классом в языке программирования Java. Объект класса для класса, реализующего интерфейс SQLData, будет введён в соответствующую карту типов объекта Connection вместе с SQL именем UDT, для которого он является пользовательским сопоставлением.

Обычно реализация SQLData определяет поле для каждого атрибута структурированного SQL типа или единственное поле для SQL типа DISTINCT. Когда UDT извлекается из источника данных с помощью метода ResultSet.getObject, он будет сопоставлен как экземпляр этого класса. Программист может работать с этим экземпляром класса так же, как с любым другим объектом в языке программирования Java, а затем сохранить любые внесённые изменения, вызвав метод PreparedStatement.setObject, который сопоставит его обратно к SQL типу.

Ожидается, что реализация класса для пользовательского сопоставления будет выполнена инструментом. В типичной реализации программист просто предоставит имя SQL UDT, имя класса, которому он сопоставляется, и имена полей, которым должно быть сопоставлено каждое из атрибутов UDT. Инструмент воспользуется этой информацией для реализации методов SQLData.readSQL и SQLData.writeSQL. Метод readSQL вызывает соответствующие методы SQLInput для чтения каждого атрибута из объекта SQLInput, а метод writeSQL вызывает методы SQLOutput для записи каждого атрибута обратно в источник данных через объект SQLOutput.

Прикладной программист обычно не будет вызывать методы SQLData напрямую, а методы SQLInput и SQLOutput вызываются внутренне методами SQLData, а не кодом приложения.

С момента:: 1.2

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

Модификатор и тип	Метод	Описание
`String`	`getSQLTypeName()`	Возвращает полное имя SQL типа данных, представляемого этим объектом.
`void`	`readSQL(SQLInput stream, String typeName)`	Заполняет этот объект данными, считанными из базы данных.
`void`	`writeSQL(SQLOutput stream)`	Записывает этот объект в заданный SQL поток данных, преобразуя его обратно в его SQL значение в источнике данных.

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

getSQLTypeName

String getSQLTypeName() throws SQLException

Возвращает полное имя SQL типа данных, представляемого этим объектом. Этот метод вызывается драйвером JDBC для получения имени экземпляра UDT, который сопоставляется с этим экземпляром SQLData.

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

readSQL

void readSQL(SQLInput stream, String typeName) throws SQLException

Заполняет этот объект данными, считанными из базы данных. Реализация метода должна следовать этому протоколу:

Он должен прочитать каждый из атрибутов или элементов SQL типа из данного потока ввода. Это делается путём вызова метода потока ввода для чтения каждого элемента в порядке их появления в SQL определении типа.
Метод readSQL затем присваивает данные соответствующим полям или элементам (этого или других объектов). В частности, он должен вызвать соответствующий метод чтения (SQLInput.readString, SQLInput.readBigDecimal, и т.д.) для выполнения следующих действий: для дискретного типа, прочитать его единственный элемент данных; для структурированного типа, прочитать значение для каждого атрибута SQL типа.

Драйвер JDBC инициализирует поток ввода с картой типов перед вызовом этого метода, который используется соответствующим методом чтения SQLInput потока.

Параметры:

stream - объект SQLInput для чтения данных значения, которое пользовательски сопоставляется

typeName - имя SQL типа значения в потоке данных

Исключения:

SQLException - если произошла ошибка доступа к базе данных

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.2

См. также:

SQLInput

writeSQL

void writeSQL(SQLOutput stream) throws SQLException

Записывает этот объект в заданный SQL поток данных, преобразуя его обратно в его SQL значение в источнике данных. Реализация метода должна следовать этому протоколу:
Он должен записать каждый из атрибутов SQL типа в заданный поток вывода. Это делается путём вызова метода потока вывода для записи каждого элемента в порядке их появления в SQL определении типа. В частности, он должен вызвать соответствующие методы записи SQLOutput (writeInt, writeString, и т.д.) для выполнения следующих действий: для дискретного типа, записать его единственный элемент данных; для структурированного типа, записать значение для каждого атрибута SQL типа.

Параметры:

stream - объект SQLOutput для записи данных значения, которое было пользовательски сопоставлено

Исключения:

SQLException - если произошла ошибка доступа к базе данных

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.2

См. также:

SQLOutput

© 1993, 2021, 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/17/docs/api/java.sql/java/sql/SQLData.html