|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.hsqldb.jdbc.JDBCBlobClient
public class JDBCBlobClient
A wrapper for HSQLDB BlobData objects. Instances of this class are returnd by calls to ResultSet methods.
| Constructor Summary | |
|---|---|
JDBCBlobClient(org.hsqldb.SessionInterface session,
org.hsqldb.types.BlobDataID blob)
|
|
| Method Summary | |
|---|---|
void |
clearUpdates()
|
void |
free()
This method frees the Blob object and releases the resources that
it holds. |
InputStream |
getBinaryStream()
Retrieves the BLOB value designated by this
Blob instance as a stream. |
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. |
org.hsqldb.types.BlobDataID |
getBlob()
|
byte[] |
getBytes(long pos,
int length)
Retrieves all or part of the BLOB value that this
Blob object represents, as an array of bytes. |
boolean |
isClosed()
|
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 |
setWritable(JDBCResultSet result,
int index)
|
void |
truncate(long len)
Truncates the BLOB value that this Blob
object represents to be len bytes in length. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public JDBCBlobClient(org.hsqldb.SessionInterface session,
org.hsqldb.types.BlobDataID blob)
| Method Detail |
|---|
public long length()
throws SQLException
BLOB value designated
by this Blob object.
length in interface BlobBLOB in bytes
SQLException - if there is an error accessing the length of the
BLOB
public byte[] getBytes(long pos,
int length)
throws SQLException
BLOB value that this
Blob object represents, as an array of bytes.
getBytes in interface Blobpos - the ordinal position of the first byte in the
BLOB value to be extracted; the first byte is at
position 1length - the number of consecutive bytes to be copied
length consecutive
bytes from the BLOB value designated by this
Blob object, starting with the byte at position
pos
SQLException - if there is an error accessing the
BLOB value
public InputStream getBinaryStream()
throws SQLException
BLOB value designated by this
Blob instance as a stream.
getBinaryStream in interface BlobBLOB data
SQLException - if there is an error accessing the
BLOB value
public long position(byte[] pattern,
long start)
throws SQLException
pattern begins within the BLOB value that
this Blob object represents.
position in interface Blobpattern - the byte array for which to searchstart - the position at which to begin searching; the first
position is 1
SQLException - if there is an error accessing the
BLOB
public long position(Blob pattern,
long start)
throws SQLException
BLOB value designated
by this Blob object at which pattern begins.
position in interface Blobpattern - the Blob object designating the
BLOB value for which to searchstart - the position in the BLOB value at which to
begin searching; the first position is 1
SQLException - if there is an error accessing the
BLOB value
public int setBytes(long pos,
byte[] bytes)
throws SQLException
BLOB value that
this Blob object represents, starting at position
pos, and returns the number of bytes written.
setBytes in interface Blobpos - the position in the BLOB object at which to
start writingbytes - the array of bytes to be written to the
BLOB value that this Blob object
represents
SQLException - if there is an error accessing the
BLOB value
public int setBytes(long pos,
byte[] bytes,
int offset,
int len)
throws SQLException
byte array to the
BLOB value that this Blob object represents
and returns the number of bytes written.
setBytes in interface Blobpos - the position in the BLOB object at which to
start writingbytes - the array of bytes to be written to this
BLOB objectoffset - the offset into the array bytes at which
to start reading the bytes to be setlen - the number of bytes to be written to the BLOB
value from the array of bytes bytes
SQLException - if there is an error accessing the
BLOB value
public OutputStream setBinaryStream(long pos)
throws SQLException
BLOB
value that this Blob object represents.
setBinaryStream in interface Blobpos - the position in the BLOB value at which to
start writing
java.io.OutputStream object to which data can
be written
SQLException - if there is an error accessing the
BLOB value
public void truncate(long len)
throws SQLException
BLOB value that this Blob
object represents to be len bytes in length.
truncate in interface Bloblen - the length, in bytes, to which the BLOB value
that this Blob object represents should be truncated
SQLException - if there is an error accessing the
BLOB value
public void free()
throws SQLException
Blob object and releases the resources that
it holds. The object is invalid once the free
method is called.
After free has been called, any attempt to invoke a
method other than free will result in a SQLException
being thrown. If free is called multiple times, the subsequent
calls to free are treated as a no-op.
free in interface BlobSQLException - if an error occurs releasing
the Blob's resources
SQLFeatureNotSupportedException - if the JDBC driver does not support
this method
public InputStream getBinaryStream(long pos,
long length)
throws SQLException
InputStream object that contains a partial Blob value,
starting with the byte specified by pos, which is length bytes in length.
getBinaryStream in interface Blobpos - the offset to the first byte of the partial value to be retrieved.
The first byte in the Blob is at position 1length - the length in bytes of the partial value to be retrieved
InputStream through which the partial Blob value can be read.
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 the number of bytes
in the Blob
SQLFeatureNotSupportedException - if the JDBC driver does not support
this methodpublic boolean isClosed()
public org.hsqldb.types.BlobDataID getBlob()
public void setWritable(JDBCResultSet result,
int index)
public void clearUpdates()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||