Интерфейс 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, а не кодом приложения.

Методы

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