Интерфейс Clob

Сопоставление в языке программирования Java™ для типа SQL CLOB. SQL CLOB — это встроенный тип, который хранит объект большого характера как значение столбца в строке таблицы базы данных. По умолчанию драйверы реализуют объект Clob с помощью SQL locator(CLOB), что означает, что объект Clob содержит логическую ссылку на данные SQL CLOB, а не сами данные. Объект Clob действителен в течение транзакции, в которой он был создан.

Интерфейс Clob предоставляет методы для получения длины значения SQL CLOB (объект большого характера), для материализации значения CLOB на клиенте и для поиска подстроки или объекта CLOB внутри значения CLOB. Методы в интерфейсах ResultSet, CallableStatement и PreparedStatement, такие как getClob и setClob, позволяют программисту получить доступ к значению SQL CLOB. Кроме того, этот интерфейс имеет методы для обновления значения CLOB.

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

Методы

length

long length()
     throws SQLException

Возвращает количество символов в значении CLOB, обозначенном этим объектом Clob.

Возвращает:

длина CLOB в символах

Исключения:

SQLException - если произошла ошибка при доступе к длине значения CLOB

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

С тех пор:

1.2

getSubString

String getSubString(long pos,
                    int length)
             throws SQLException

Возвращает копию указанного подстроки в значении CLOB, обозначенном этим объектом Clob. Подстрока начинается с позиции pos и содержит до length последовательных символов.

Параметры:

pos - первый символ подстроки для извлечения. Первый символ имеет позицию 1.

length - количество последовательных символов для копирования; значение длины должно быть 0 или больше

Возвращает:

строка, являющаяся указанной подстрокой значения CLOB, обозначенного этим объектом Clob

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB; если pos меньше 1 или length меньше 0

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

С тех пор:

1.2

getCharacterStream

Reader getCharacterStream()
                   throws SQLException

Возвращает значение CLOB, обозначенное этим объектом Clob, как объект java.io.Reader (или как поток символов).

Возвращает:

объект java.io.Reader, содержащий данные CLOB

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB

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

С тех пор:

1.2

См. также:

setCharacterStream(long)

getAsciiStream

InputStream getAsciiStream()
                    throws SQLException

Возвращает значение CLOB, обозначенное этим объектом Clob, как поток ASCII.

Возвращает:

объект java.io.InputStream, содержащий данные CLOB

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB

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

С тех пор:

1.2

См. также:

setAsciiStream(long)

position

long position(String searchstr,
              long start)
       throws SQLException

Возвращает позицию символа, на которой появляется указанная подстрока searchstr в значении SQL CLOB, представленном этим объектом Clob. Поиск начинается с позиции start.

Параметры:

searchstr - подстрока для поиска

start - позиция, с которой начинается поиск; первая позиция равна 1

Возвращает:

позиция, на которой появляется подстрока, или -1, если она отсутствует; первая позиция равна 1

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1

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

С тех пор:

1.2

position

long position(Clob searchstr,
              long start)
       throws SQLException

Возвращает позицию символа, на которой появляется указанный объект Clob в этом объекте Clob. Поиск начинается с позиции start.

Параметры:

searchstr - объект Clob для поиска

start - позиция, с которой начинается поиск; первая позиция равна 1

Возвращает:

позиция, на которой появляется объект Clob, или -1, если он отсутствует; первая позиция равна 1

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если start меньше 1

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

С тех пор:

1.2

setString

int setString(long pos,
              String str)
       throws SQLException

Параметры:

pos - позиция, с которой начинается запись в значение CLOB, представленное этим объектом Clob; Первая позиция равна 1

str - строка, подлежащая записи в значение CLOB, обозначаемое этим объектом Clob

Возвращает:

количество записанных символов

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1

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

С тех пор:

1.4

setString

int setString(long pos,
              String str,
              int offset,
              int len)
       throws SQLException

Параметры:

pos - позиция, с которой начинается запись в этот объект CLOB; Первая позиция равна 1

str - строка, подлежащая записи в значение CLOB, обозначаемое этим объектом Clob

offset - смещение в str для начала чтения символов для записи

len - количество символов для записи

Возвращает:

количество записанных символов

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1

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

С тех пор:

1.4

setAsciiStream

OutputStream setAsciiStream(long pos)
                     throws SQLException

Параметры:

pos - позиция, с которой начинается запись в этот объект CLOB; Первая позиция равна 1

Возвращает:

поток, в который можно записывать символы ASCII

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1

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

С тех пор:

1.4

См. также:

getAsciiStream()

setCharacterStream

Writer setCharacterStream(long pos)
                   throws SQLException

Параметры:

pos - позиция, с которой начинается запись в значение CLOB; Первая позиция равна 1

Возвращает:

поток, в который можно записывать символы Unicode

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1

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

С тех пор:

1.4

См. также:

getCharacterStream()

truncate

void truncate(long len)
       throws SQLException

Параметры:

len - длина, в символах, до которой должно быть укорочено значение CLOB

Исключения:

SQLException - если произошла ошибка при доступе к значению CLOB или если len меньше 0

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

С тех пор:

1.4

free

void free()
   throws SQLException

Исключение:

SQLException - если произошла ошибка при высвобождении ресурсов Clob.

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

С:

1.6

getCharacterStream

Reader getCharacterStream(long pos,
                          long length)
                   throws SQLException

Возвращает объект Reader, содержащий частичное значение Clob, начиная с символа, заданного pos, длиной length символов.

Параметры:

pos - смещение до первого символа частичного значения для извлечения. Первый символ в Clob находится на позиции 1.

length - длина в символах частичного значения для извлечения.

Возвращает:

Reader, через который можно прочитать частичное значение Clob.

Исключение:

SQLException - если pos меньше 1 или pos больше числа символов в Clob, или если pos + length больше числа символов в Clob.

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

С:

1.6