com.oceanbase.jdbc

Class Clob

java.lang.Object

com.oceanbase.jdbc.Lob

com.oceanbase.jdbc.Clob

All Implemented Interfaces:

ObClob, Serializable, Clob

Direct Known Subclasses:

JDBC4NClob

public class Clob
extends Lob
implements ObClob

See Also:

Serialized Form

Field Summary

Fields inherited from class com.oceanbase.jdbc.Lob

charData, data, encoding, exceptionInterceptor, length, locator, offset

Constructor Summary

Constructors

Constructor and Description
Clob() Creates an empty Clob.
Clob(boolean hasLocator, byte[] data, String encoding, OceanBaseConnection conn)
Clob(byte[] bytes) Creates a Clob with content.
Clob(byte[] bytes, ExceptionInterceptor exceptionInterceptor)
Clob(byte[] bytes, int offset, int length) Creates a Clob with content.
Clob(String charDataInit, ExceptionInterceptor exceptionInterceptor)

Method Summary

Modifier and Type	Method and Description
InputStream	getAsciiStream()
Reader	getCharacterStream()
Reader	getCharacterStream(long pos, long length) Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.
static Clob	getEmptyCLOB()
com.oceanbase.jdbc.ObLobLocator	getLocator()
String	getSubString(long pos, int length) Get sub string.
long	length() Return character length of the Clob.
long	position(Clob searchStr, long start)
long	position(String searchStr, long start)
OutputStream	setAsciiStream(long pos)
Writer	setCharacterStream(long pos) Set character stream.
void	setLocator(com.oceanbase.jdbc.ObLobLocator locator)
int	setString(long pos, String str) Set String.
int	setString(long pos, String str, int offset, int len)
String	toString() ToString implementation.
void	trimClobToServer(int len) Truncate Clob object by the DBMS_LOB.trim(?,?), truncate data from len, exception if len is big than data's length and success when len is less than data's length.
void	truncate(long truncateLen)
void	updateClobToServer(long writeAt, byte[] bytes, int offset, int length) Update Clob object by the DBMS_LOB.write(?,?,?,?), starting with writeAt and write the bytes to database.

Methods inherited from class com.oceanbase.jdbc.Lob

free, getBinaryStream, getBinaryStream, getBytes, isEmptyLob, setBinaryStream, setBytes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.sql.Clob

free

Constructor Detail

Clob

public Clob(byte[] bytes)

Creates a Clob with content.

Parameters:

bytes - the content for the Clob.

Clob

public Clob(byte[] bytes,
            ExceptionInterceptor exceptionInterceptor)

Clob

public Clob(byte[] bytes,
            int offset,
            int length)

Creates a Clob with content.

Parameters:

bytes - the content for the Clob.

offset - offset

length - length

Clob

public Clob(String charDataInit,
            ExceptionInterceptor exceptionInterceptor)

Clob

public Clob(boolean hasLocator,
            byte[] data,
            String encoding,
            OceanBaseConnection conn)
     throws SQLException

Throws:

SQLException

Clob

public Clob()

Creates an empty Clob.

Method Detail

getEmptyCLOB

public static Clob getEmptyCLOB()
                         throws SQLException

Throws:

SQLException

getLocator

public com.oceanbase.jdbc.ObLobLocator getLocator()

Specified by:

getLocator in interface ObClob

setLocator

public void setLocator(com.oceanbase.jdbc.ObLobLocator locator)

Specified by:

setLocator in interface ObClob

toString

public String toString()

ToString implementation.

Overrides:

toString in class Object

Returns:

string value of blob content.

getSubString

public String getSubString(long pos,
                           int length)
                    throws SQLException

Get sub string.

Specified by:

getSubString in interface Clob

Parameters:

pos - position

length - length of sub string

Returns:

substring

Throws:

SQLException - if pos is less than 1 or length is less than 0

getCharacterStream

public Reader getCharacterStream()

Specified by:

getCharacterStream in interface Clob

getCharacterStream

public Reader getCharacterStream(long pos,
                                 long length)
                          throws SQLException

Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length.

Specified by:

getCharacterStream in interface Clob

Parameters:

pos - the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.

length - the length in characters of the partial value to be retrieved.

Returns:

Reader through which the partial Clob value can be read.

Throws:

SQLException - if pos is less than 1 or if pos is greater than the number of characters in the Clob or if pos + length is greater than the number of characters in the Clob

setCharacterStream

public Writer setCharacterStream(long pos)
                          throws SQLException

Set character stream.

Specified by:

setCharacterStream in interface Clob

Parameters:

pos - position

Returns:

writer

Throws:

SQLException - if position is invalid

getAsciiStream

public InputStream getAsciiStream()
                           throws SQLException

Specified by:

getAsciiStream in interface Clob

Throws:

SQLException

position

public long position(String searchStr,
                     long start)
              throws SQLException

Specified by:

position in interface Clob

Throws:

SQLException

position

public long position(Clob searchStr,
                     long start)
              throws SQLException

Specified by:

position in interface Clob

Throws:

SQLException

setString

public int setString(long pos,
                     String str)
              throws SQLException

Set String.

Specified by:

setString in interface Clob

Parameters:

pos - position

str - string

Returns:

string length

Throws:

SQLException - if UTF-8 conversion failed

setString

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

Specified by:

setString in interface Clob

Throws:

SQLException

setAsciiStream

public OutputStream setAsciiStream(long pos)
                            throws SQLException

Specified by:

setAsciiStream in interface Clob

Throws:

SQLException

length

public long length()

Return character length of the Clob. Assume UTF8 encoding.

Specified by:

length in interface Clob

truncate

public void truncate(long truncateLen)
              throws SQLException

Specified by:

truncate in interface Clob

Throws:

SQLException

updateClobToServer

public void updateClobToServer(long writeAt,
                               byte[] bytes,
                               int offset,
                               int length)
                        throws SQLException

Update Clob object by the DBMS_LOB.write(?,?,?,?), starting with writeAt and write the bytes to database.

Specified by:

updateClobToServer in interface ObClob

Parameters:

writeAt - Start position to be write.

bytes - byte[] data to be write.

offset - first position offset will be write.

length - date length to be write.

Throws:

SQLException - if database error occur

trimClobToServer

public void trimClobToServer(int len)
                      throws SQLException

Truncate Clob object by the DBMS_LOB.trim(?,?), truncate data from len, exception if len is big than data's length and success when len is less than data's length.

Parameters:

len - truncate data from len

Throws:

SQLException - if database error occur