- java.lang.Object
-
- org.hsqldb.jdbc.JDBCBlobClient
-
- All Implemented Interfaces:
java.sql.Blob
public class JDBCBlobClient extends java.lang.Object implements java.sql.BlobA wrapper for HSQLDB BlobData objects. Instances of this class are returned by calls to ResultSet methods.- Since:
- JDK 1.2, HSQLDB 2.0
- Author:
- Fred Toussi (fredt@users dot sourceforge.net)
-
-
Constructor Summary
Constructors Constructor Description JDBCBlobClient(org.hsqldb.SessionInterface session, org.hsqldb.types.BlobDataID blob)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearUpdates()voidfree()This method frees theBlobobject and releases the resources that it holds.java.io.InputStreamgetBinaryStream()Retrieves theBLOBvalue designated by thisBlobinstance as a stream.java.io.InputStreamgetBinaryStream(long pos, long length)Returns anInputStreamobject that contains a partialBlobvalue, starting with the byte specified by pos, which is length bytes in length.org.hsqldb.types.BlobDataIDgetBlob()byte[]getBytes(long pos, int length)Retrieves all or part of theBLOBvalue that thisBlobobject represents, as an array of bytes.booleanisClosed()longlength()Returns the number of bytes in theBLOBvalue designated by thisBlobobject.longposition(byte[] pattern, long start)Retrieves the byte position at which the specified byte arraypatternbegins within theBLOBvalue that thisBlobobject represents.longposition(java.sql.Blob pattern, long start)Retrieves the byte position in theBLOBvalue designated by thisBlobobject at whichpatternbegins.java.io.OutputStreamsetBinaryStream(long pos)Retrieves a stream that can be used to write to theBLOBvalue that thisBlobobject represents.intsetBytes(long pos, byte[] bytes)Writes the given array of bytes to theBLOBvalue that thisBlobobject represents, starting at positionpos, and returns the number of bytes written.intsetBytes(long pos, byte[] bytes, int offset, int len)Writes all or part of the givenbytearray to theBLOBvalue that thisBlobobject represents and returns the number of bytes written.voidsetWritable(JDBCResultSet result, int index)voidtruncate(long len)Truncates theBLOBvalue that thisBlobobject represents to belenbytes in length.
-
-
-
Method Detail
-
length
public long length() throws java.sql.SQLExceptionReturns the number of bytes in theBLOBvalue designated by thisBlobobject.- Specified by:
lengthin interfacejava.sql.Blob- Returns:
- length of the
BLOBin bytes - Throws:
java.sql.SQLException- if there is an error accessing the length of theBLOB
-
getBytes
public byte[] getBytes(long pos, int length) throws java.sql.SQLExceptionRetrieves all or part of theBLOBvalue that thisBlobobject represents, as an array of bytes.- Specified by:
getBytesin interfacejava.sql.Blob- Parameters:
pos- the ordinal position of the first byte in theBLOBvalue 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
lengthconsecutive bytes from theBLOBvalue designated by thisBlobobject, starting with the byte at positionpos - Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
getBinaryStream
public java.io.InputStream getBinaryStream() throws java.sql.SQLExceptionRetrieves theBLOBvalue designated by thisBlobinstance as a stream.- Specified by:
getBinaryStreamin interfacejava.sql.Blob- Returns:
- a stream containing the
BLOBdata - Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
position
public long position(byte[] pattern, long start) throws java.sql.SQLExceptionRetrieves the byte position at which the specified byte arraypatternbegins within theBLOBvalue that thisBlobobject represents.- Specified by:
positionin interfacejava.sql.Blob- 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:
java.sql.SQLException- if there is an error accessing theBLOB
-
position
public long position(java.sql.Blob pattern, long start) throws java.sql.SQLExceptionRetrieves the byte position in theBLOBvalue designated by thisBlobobject at whichpatternbegins.- Specified by:
positionin interfacejava.sql.Blob- Parameters:
pattern- theBlobobject designating theBLOBvalue for which to searchstart- the position in theBLOBvalue at which to begin searching; the first position is 1- Returns:
- the position at which the pattern begins, else -1
- Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
setBytes
public int setBytes(long pos, byte[] bytes) throws java.sql.SQLExceptionWrites the given array of bytes to theBLOBvalue that thisBlobobject represents, starting at positionpos, and returns the number of bytes written.- Specified by:
setBytesin interfacejava.sql.Blob- Parameters:
pos- the position in theBLOBobject at which to start writingbytes- the array of bytes to be written to theBLOBvalue that thisBlobobject represents- Returns:
- the number of bytes written
- Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
setBytes
public int setBytes(long pos, byte[] bytes, int offset, int len) throws java.sql.SQLExceptionWrites all or part of the givenbytearray to theBLOBvalue that thisBlobobject represents and returns the number of bytes written.- Specified by:
setBytesin interfacejava.sql.Blob- Parameters:
pos- the position in theBLOBobject at which to start writingbytes- the array of bytes to be written to thisBLOBobjectoffset- the offset into the arraybytesat which to start reading the bytes to be setlen- the number of bytes to be written to theBLOBvalue from the array of bytesbytes- Returns:
- the number of bytes written
- Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
setBinaryStream
public java.io.OutputStream setBinaryStream(long pos) throws java.sql.SQLExceptionRetrieves a stream that can be used to write to theBLOBvalue that thisBlobobject represents.- Specified by:
setBinaryStreamin interfacejava.sql.Blob- Parameters:
pos- the position in theBLOBvalue at which to start writing- Returns:
- a
java.io.OutputStreamobject to which data can be written - Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
truncate
public void truncate(long len) throws java.sql.SQLExceptionTruncates theBLOBvalue that thisBlobobject represents to belenbytes in length.- Specified by:
truncatein interfacejava.sql.Blob- Parameters:
len- the length, in bytes, to which theBLOBvalue that thisBlobobject represents should be truncated- Throws:
java.sql.SQLException- if there is an error accessing theBLOBvalue
-
free
public void free() throws java.sql.SQLExceptionThis method frees theBlobobject and releases the resources that it holds. The object is invalid once thefreemethod is called.After
freehas been called, any attempt to invoke a method other thanfreewill result in aSQLExceptionbeing thrown. Iffreeis called multiple times, the subsequent calls tofreeare treated as a no-op.- Specified by:
freein interfacejava.sql.Blob- Throws:
java.sql.SQLException- if an error occurs releasing the Blob's resources- Since:
- JDK 1.6, HSQLDB 2.0
-
getBinaryStream
public java.io.InputStream getBinaryStream(long pos, long length) throws java.sql.SQLExceptionReturns anInputStreamobject that contains a partialBlobvalue, starting with the byte specified by pos, which is length bytes in length.- Specified by:
getBinaryStreamin interfacejava.sql.Blob- Parameters:
pos- the offset to the first byte of the partial value to be retrieved. The first byte in theBlobis at position 1length- the length in bytes of the partial value to be retrieved- Returns:
InputStreamthrough which the partialBlobvalue can be read.- Throws:
java.sql.SQLException- if pos is less than 1 or if pos is greater than the number of bytes in theBlobor 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
public void setWritable(JDBCResultSet result, int index)
-
clearUpdates
public void clearUpdates()
-
-