com.oceanbase.jdbc

Class Blob

java.lang.Object

com.oceanbase.jdbc.Lob

com.oceanbase.jdbc.Blob

All Implemented Interfaces:

ObBlob, Serializable, Blob

public class Blob
extends Lob
implements ObBlob

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
Blob() Creates an empty blob.
Blob(Blob other)
Blob(boolean hasLocator, byte[] data, String encoding, OceanBaseConnection conn) Create a BLOB with Locator
Blob(byte[] bytes) Creates a blob with content.
Blob(byte[] bytes, ExceptionInterceptor exceptionInterceptor)
Blob(byte[] bytes, int offset, int length) Creates a blob with content.

Method Summary

Modifier and Type	Method and Description
Reader	getCharacterStream()
static Blob	getEmptyBLOB()
com.oceanbase.jdbc.ObLobLocator	getLocator()
long	length() Returns the number of bytes in the BLOB value designated by this Blob object.
long	position(Blob pattern, long start) Retrieves the byte position in the BLOB value designated by this Blob object at which pattern begins.
long	position(byte[] pattern, long start) Retrieves the byte position at which the specified byte array pattern begins within the BLOB value that this Blob object represents.
OutputStream	setBinaryStream(long pos) Retrieves a stream that can be used to write to the BLOB value that this Blob object represents.
int	setBytes(long pos, byte[] bytes) Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written.
int	setBytes(long pos, byte[] bytes, int offset, int len) Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written.
void	setLocator(com.oceanbase.jdbc.ObLobLocator locator) Update ObLobLocator object which Bbob contains.
void	trimBlobToServer(int len) Truncate Blob 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 len) Truncates the BLOB value that this Blob object represents to be len bytes in length.
void	updateBlobToServer(long writeAt, byte[] bytes, int offset, int length) Update Blob 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Blob

free, getBinaryStream, getBinaryStream, getBytes

Constructor Detail

Blob

public Blob()

Creates an empty blob.

Blob

public Blob(Blob other)

Blob

public Blob(byte[] bytes)

Creates a blob with content.

Parameters:

bytes - the content for the blob.

Blob

public Blob(byte[] bytes,
            ExceptionInterceptor exceptionInterceptor)

Blob

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

Creates a blob with content.

Parameters:

bytes - the content for the blob.

offset - offset

length - length

Blob

public Blob(boolean hasLocator,
            byte[] data,
            String encoding,
            OceanBaseConnection conn)

Create a BLOB with Locator

Parameters:

data -

Method Detail

getEmptyBLOB

public static Blob getEmptyBLOB()
                         throws SQLException

Throws:

SQLException

length

public long length()

Returns the number of bytes in the BLOB value designated by this Blob object.

Specified by:

length in interface Blob

Returns:

length of the BLOB in bytes

getCharacterStream

public Reader getCharacterStream()
                          throws SQLException

Throws:

SQLException

position

public long position(byte[] pattern,
                     long start)
              throws SQLException

Retrieves the byte position at which the specified byte array pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start.

Specified by:

position in interface Blob

Parameters:

pattern - the byte array for which to search

start - the position at which to begin searching; the first position is 1

Returns:

the position at which the pattern appears, else -1

Throws:

SQLException

position

public long position(Blob pattern,
                     long start)
              throws SQLException

Retrieves the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start.

Specified by:

position in interface Blob

Parameters:

pattern - the Blob object designating the BLOB value for which to search

start - the position in the BLOB value at which to begin searching; the first position is 1

Returns:

the position at which the pattern begins, else -1

Throws:

SQLException

setBytes

public int setBytes(long pos,
                    byte[] bytes)
             throws SQLException

Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accommodate the extra bytes.

Specified by:

setBytes in interface Blob

Overrides:

setBytes in class Lob

Parameters:

pos - the position in the BLOB object at which to start writing; the first position is 1

bytes - the array of bytes to be written to the BLOB value that this Blob object represents

Returns:

the number of bytes written

Throws:

SQLException

See Also:

Lob.getBytes(long, int)

setBytes

public int setBytes(long pos,
                    byte[] bytes,
                    int offset,
                    int len)
             throws SQLException

Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written. Writing starts at position pos in the BLOB value; len bytes from the given byte array are written. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accommodate the extra bytes.

Note: If the value specified for pos is greater then the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

Specified by:

setBytes in interface Blob

Parameters:

pos - the position in the BLOB object at which to start writing; the first position is 1

bytes - the array of bytes to be written to this BLOB object

offset - the offset into the array bytes at which to start reading the bytes to be set

len - the number of bytes to be written to the BLOB value from the array of bytes bytes

Returns:

the number of bytes written

Throws:

SQLException - if there is an error accessing the BLOB value or if pos is less than 1

See Also:

Lob.getBytes(long, int)

setBinaryStream

public OutputStream setBinaryStream(long pos)
                             throws SQLException

Retrieves a stream that can be used to write to the BLOB value that this Blob object represents. The stream begins at position pos. The bytes written to the stream will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing to the stream, then the length of the Blob value will be increased to accommodate the extra bytes.

Note: If the value specified for pos is greater then the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.

Specified by:

setBinaryStream in interface Blob

Overrides:

setBinaryStream in class Lob

Parameters:

pos - the position in the BLOB value at which to start writing; the first position is 1

Returns:

a java.io.OutputStream object to which data can be written

Throws:

SQLException - if there is an error accessing the BLOB value or if pos is less than 1

Since:

1.4

See Also:

Lob.getBinaryStream()

truncate

public void truncate(long len)
              throws SQLException

Truncates the BLOB value that this Blob object represents to be len bytes in length.

Specified by:

truncate in interface Blob

Parameters:

len - the length, in bytes, to which the BLOB value that this Blob object represents should be truncated

Throws:

SQLException

getLocator

public com.oceanbase.jdbc.ObLobLocator getLocator()

Specified by:

getLocator in interface ObBlob

Returns:

setLocator

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

Update ObLobLocator object which Bbob contains.

Specified by:

setLocator in interface ObBlob

Parameters:

locator - Source ObLobLocator object.

updateBlobToServer

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

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

Specified by:

updateBlobToServer in interface ObBlob

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

trimBlobToServer

public void trimBlobToServer(int len)
                      throws SQLException

Truncate Blob 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.

Specified by:

trimBlobToServer in interface ObBlob

Parameters:

len - truncate data from len

Throws:

SQLException - if database error occur