java.lang.Object
org.hsqldb.jdbc.JDBCBlobClient
- All Implemented Interfaces:
Blob
A wrapper for HSQLDB BlobData objects.
Instances of this class are returned by calls to ResultSet methods.
- Since:
- 1.9.0
- Author:
- Fred Toussi (fredt@users dot sourceforge.net)
-
Constructor Summary
ConstructorsConstructorDescriptionJDBCBlobClient
(org.hsqldb.SessionInterface session, org.hsqldb.types.BlobDataID blob) -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
free()
This method frees theBlob
object and releases the resources that it holds.Retrieves theBLOB
value designated by thisBlob
instance as a stream.getBinaryStream
(long pos, long length) Returns anInputStream
object that contains a partialBlob
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 theBLOB
value that thisBlob
object represents, as an array of bytes.boolean
isClosed()
long
length()
Returns the number of bytes in theBLOB
value designated by thisBlob
object.long
position
(byte[] pattern, long start) Retrieves the byte position at which the specified byte arraypattern
begins within theBLOB
value that thisBlob
object represents.long
Retrieves the byte position in theBLOB
value designated by thisBlob
object at whichpattern
begins.setBinaryStream
(long pos) Retrieves a stream that can be used to write to theBLOB
value that thisBlob
object represents.int
setBytes
(long pos, byte[] bytes) Writes the given array of bytes to theBLOB
value that thisBlob
object represents, starting at positionpos
, and returns the number of bytes written.int
setBytes
(long pos, byte[] bytes, int offset, int len) Writes all or part of the givenbyte
array to theBLOB
value that thisBlob
object represents and returns the number of bytes written.void
setWritable
(JDBCResultSet result, int index) void
truncate
(long len) Truncates theBLOB
value that thisBlob
object represents to belen
bytes in length.
-
Constructor Details
-
JDBCBlobClient
public JDBCBlobClient(org.hsqldb.SessionInterface session, org.hsqldb.types.BlobDataID blob)
-
-
Method Details
-
length
Returns the number of bytes in theBLOB
value designated by thisBlob
object.- Specified by:
length
in interfaceBlob
- Returns:
- length of the
BLOB
in bytes - Throws:
SQLException
- if there is an error accessing the length of theBLOB
-
getBytes
Retrieves all or part of theBLOB
value that thisBlob
object represents, as an array of bytes.- Specified by:
getBytes
in interfaceBlob
- Parameters:
pos
- the ordinal position of the first byte in theBLOB
value to be extracted; the first byte is at position 1length
- the number of consecutive bytes to be copied- Returns:
- a byte array containing up to
length
consecutive bytes from theBLOB
value designated by thisBlob
object, starting with the byte at positionpos
- Throws:
SQLException
- if there is an error accessing theBLOB
value
-
getBinaryStream
Retrieves theBLOB
value designated by thisBlob
instance as a stream.- Specified by:
getBinaryStream
in interfaceBlob
- Returns:
- a stream containing the
BLOB
data - Throws:
SQLException
- if there is an error accessing theBLOB
value
-
position
Retrieves the byte position at which the specified byte arraypattern
begins within theBLOB
value that thisBlob
object represents.- Specified by:
position
in interfaceBlob
- Parameters:
pattern
- the byte array for which to searchstart
- the position at which to begin searching; the first position is 1- Returns:
- the position at which the pattern appears, else -1
- Throws:
SQLException
- if there is an error accessing theBLOB
-
position
Retrieves the byte position in theBLOB
value designated by thisBlob
object at whichpattern
begins.- Specified by:
position
in interfaceBlob
- Parameters:
pattern
- theBlob
object designating theBLOB
value for which to searchstart
- the position in theBLOB
value at which to begin searching; the first position is 1- Returns:
- the position at which the pattern begins, else -1
- Throws:
SQLException
- if there is an error accessing theBLOB
value
-
setBytes
Writes the given array of bytes to theBLOB
value that thisBlob
object represents, starting at positionpos
, and returns the number of bytes written.- Specified by:
setBytes
in interfaceBlob
- Parameters:
pos
- the position in theBLOB
object at which to start writingbytes
- the array of bytes to be written to theBLOB
value that thisBlob
object represents- Returns:
- the number of bytes written
- Throws:
SQLException
- if there is an error accessing theBLOB
value
-
setBytes
Writes all or part of the givenbyte
array to theBLOB
value that thisBlob
object represents and returns the number of bytes written.- Specified by:
setBytes
in interfaceBlob
- Parameters:
pos
- the position in theBLOB
object at which to start writingbytes
- the array of bytes to be written to thisBLOB
objectoffset
- the offset into the arraybytes
at which to start reading the bytes to be setlen
- the number of bytes to be written to theBLOB
value from the array of bytesbytes
- Returns:
- the number of bytes written
- Throws:
SQLException
- if there is an error accessing theBLOB
value
-
setBinaryStream
Retrieves a stream that can be used to write to theBLOB
value that thisBlob
object represents.- Specified by:
setBinaryStream
in interfaceBlob
- Parameters:
pos
- the position in theBLOB
value at which to start writing- Returns:
- a
java.io.OutputStream
object to which data can be written - Throws:
SQLException
- if there is an error accessing theBLOB
value
-
truncate
Truncates theBLOB
value that thisBlob
object represents to belen
bytes in length.- Specified by:
truncate
in interfaceBlob
- Parameters:
len
- the length, in bytes, to which theBLOB
value that thisBlob
object represents should be truncated- Throws:
SQLException
- if there is an error accessing theBLOB
value
-
free
This method frees theBlob
object and releases the resources that it holds. The object is invalid once thefree
method is called.After
free
has been called, any attempt to invoke a method other thanfree
will result in aSQLException
being thrown. Iffree
is called multiple times, the subsequent calls tofree
are treated as a no-op.- Specified by:
free
in interfaceBlob
- Throws:
SQLException
- if an error occurs releasing the Blob's resources- Since:
- JDK 1.6, HSQLDB 2.0
-
getBinaryStream
Returns anInputStream
object that contains a partialBlob
value, starting with the byte specified by pos, which is length bytes in length.- Specified by:
getBinaryStream
in interfaceBlob
- Parameters:
pos
- the offset to the first byte of the partial value to be retrieved. The first byte in theBlob
is at position 1length
- the length in bytes of the partial value to be retrieved- Returns:
InputStream
through which the partialBlob
value can be read.- Throws:
SQLException
- if pos is less than 1 or if pos is greater than the number of bytes in theBlob
or if pos + length is greater than the number of bytes in theBlob
- Since:
- JDK 1.6, HSQLDB 2.0
-
isClosed
public boolean isClosed() -
getBlob
public org.hsqldb.types.BlobDataID getBlob() -
setWritable
-
clearUpdates
public void clearUpdates()
-