org.apache.derby.client.am

Class ClientBlob

java.lang.Object

org.apache.derby.client.am.Lob

org.apache.derby.client.am.ClientBlob

All Implemented Interfaces:

java.sql.Blob, UnitOfWorkListener

public class ClientBlob
extends Lob
implements java.sql.Blob

Field Summary

Fields inherited from class org.apache.derby.client.am.Lob

INVALID_LOCATOR

Constructor Summary

Constructors

Constructor and Description
ClientBlob(Agent agent, int locator) Create a Blob object for a Blob value stored on the server and indentified by locator.
ClientBlob(byte[] binaryString, Agent agent, int dataOffset)

Method Summary

Modifier and Type	Method and Description
void	free() This method frees the Blob object and releases the resources that it holds.
java.io.InputStream	getBinaryStream()
java.io.InputStream	getBinaryStream(long pos, long length) Returns an InputStream object that contains a partial Blob value, starting with the byte specified by pos, which is length bytes in length.
byte[]	getBytes(long pos, int length) Returns as an array of bytes part or all of the BLOB value that this Blob object designates.
boolean	isBinaryStream()
boolean	isBinaryString()
long	length()
long	position(java.sql.Blob pattern, long start)
long	position(byte[] pattern, long start)
java.io.OutputStream	setBinaryStream(long pos)
int	setBytes(long pos, byte[] bytes)
int	setBytes(long pos, byte[] bytes, int offset, int len)
void	truncate(long len)

Methods inherited from class org.apache.derby.client.am.Lob

completeLocalCommit, completeLocalRollback, getAgent, getLocator, isLocator, listenToUnitOfWork, willBeLayerBStreamed

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientBlob

public ClientBlob(byte[] binaryString,
                  Agent agent,
                  int dataOffset)

ClientBlob

public ClientBlob(Agent agent,
                  int locator)

Create a Blob object for a Blob value stored on the server and indentified by locator.

Parameters:

agent - context for this Blob object (incl. connection)

locator - reference id to Blob value on server

Method Detail

length

public long length()
            throws java.sql.SQLException

Specified by:

length in interface java.sql.Blob

Specified by:

length in class Lob

Throws:

java.sql.SQLException

getBytes

public byte[] getBytes(long pos,
                       int length)
                throws java.sql.SQLException

Returns as an array of bytes part or all of the BLOB value that this Blob object designates. The byte array contains up to length consecutive bytes starting at position pos. The starting position must be between 1 and the length of the BLOB plus 1. This allows for zero-length BLOB values, from which only zero-length byte arrays can be returned. If a larger length is requested than there are bytes available, characters from the start position to the end of the BLOB are returned.

Specified by:

getBytes in interface java.sql.Blob

Parameters:

pos - the ordinal position of the first byte in the BLOB value to be extracted; the first byte is at position 1

length - is the number of consecutive bytes to be copied

Returns:

a byte array containing up to length consecutive bytes from the BLOB value designated by this Blob object, starting with the byte at position startPos.

Throws:

java.sql.SQLException - if there is an error accessing the BLOB NOTE: If the starting position is the length of the BLOB plus 1, zero bytess are returned regardless of the length requested.

getBinaryStream

public java.io.InputStream getBinaryStream()
                                    throws java.sql.SQLException

Specified by:

getBinaryStream in interface java.sql.Blob

Throws:

java.sql.SQLException

position

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

Specified by:

position in interface java.sql.Blob

Throws:

java.sql.SQLException

position

public long position(java.sql.Blob pattern,
                     long start)
              throws java.sql.SQLException

Specified by:

position in interface java.sql.Blob

Throws:

java.sql.SQLException

setBytes

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

Specified by:

setBytes in interface java.sql.Blob

Throws:

java.sql.SQLException

setBytes

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

Specified by:

setBytes in interface java.sql.Blob

Throws:

java.sql.SQLException

setBinaryStream

public java.io.OutputStream setBinaryStream(long pos)
                                     throws java.sql.SQLException

Specified by:

setBinaryStream in interface java.sql.Blob

Throws:

java.sql.SQLException

truncate

public void truncate(long len)
              throws java.sql.SQLException

Specified by:

truncate in interface java.sql.Blob

Throws:

java.sql.SQLException

free

public void free()
          throws java.sql.SQLException

This method frees the Blob object and releases the resources that it holds. The object is invalid once the free method is called. If free is called multiple times, the subsequent calls to free are treated as a no-op.

Specified by:

free in interface java.sql.Blob

Throws:

java.sql.SQLException - if an error occurs releasing the Blob's resources

getBinaryStream

public java.io.InputStream getBinaryStream(long pos,
                                           long length)
                                    throws java.sql.SQLException

Returns an InputStream object that contains a partial Blob value, starting with the byte specified by pos, which is length bytes in length.

Specified by:

getBinaryStream in interface java.sql.Blob

Parameters:

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

length - the length in bytes of the partial value to be retrieved

Returns:

InputStream through which the partial Blob value can be read.

Throws:

java.sql.SQLException - if pos is less than 1 or if pos is greater than the number of bytes in the Blob or if pos + length is greater than Blob.length() +1

isBinaryString

public boolean isBinaryString()

isBinaryStream

public boolean isBinaryStream()