java.sql

Interface Blob

Known Implementing Classes:
BlobImpl, SerialBlob, SerializableBlob

public interface Blob

The representation (mapping) in the JavaTM programming language of an SQL BLOB value. An SQL BLOB is a built-in type that stores a Binary Large Object as a column value in a row of a database table. By default drivers implement Blob using an SQL locator(BLOB), which means that a Blob object contains a logical pointer to the SQL BLOB data rather than the data itself. A Blob object is valid for the duration of the transaction in which is was created.

Methods in the interfaces ResultSet, CallableStatement, and PreparedStatement, such as getBlob and setBlob allow a programmer to access an SQL BLOB value. The Blob interface provides methods for getting the length of an SQL BLOB (Binary Large Object) value, for materializing a BLOB value on the client, and for determining the position of a pattern of bytes within a BLOB value. In addition, this interface has methods for updating a BLOB value.

Since:
1.2

Method Summary

InputStream
getBinaryStream()
Retrieves the BLOB value designated by this Blob instance as a stream.
byte[]
getBytes(long pos, int length)
Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes.
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(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
truncate(long len)
Truncates the BLOB value that this Blob object represents to be len bytes in length.

Method Details

getBinaryStream

public InputStream getBinaryStream()
            throws SQLException
Retrieves the BLOB value designated by this Blob instance as a stream.
Returns:
a stream containing the BLOB data
Throws:
SQLException - if there is an error accessing the BLOB value
Since:
1.2
Usages and Demos :

View More Examples of getBinaryStream()
   1: import java.io.InputStream;
   2: import java.sql.Blob;
   3: import java.sql.SQLException;
   4:         ...
   5: 
   6:     private Blob content;
   7: 
   8:         ...
   9: 
  10:     public Blob getContent() {
  11:         return content;
  12:         ...
  13:     public InputStream getInputStream() throws SQLException {
  14:         return content.getBinaryStream();

View Full Code Here
   1: import java.io.*;
   2: import java.sql.Blob;
   3: 
   4:         ...
   5: 
   6:     public BLOBWrapper(Blob blob, ClassLoader classLoader, boolean load)
   7:     {
   8:         ...
   9:                 data=new byte[(int)length];
  10:                 blob.getBinaryStream().read(data);
  11:                 loaded=true;

View Full Code Here
   1: import java.io.Reader;
   2: import java.sql.Blob;
   3: import java.sql.SQLException;
   4:         ...
   5:     
   6:     private FBBlob blob;
   7: 
   8:         ...
   9:         try {
  10:             if (blob != null) 
  11:                 blob.close();
  12:         ...
  13: 
  14:         return blob.getBinaryStream();

View Full Code Here
   1: import java.sql.Array;
   2: import java.sql.Blob;
   3: import java.sql.Clob;
   4:         ...
   5:         try {
   6:             if (columnType == Types.BLOB) {
   7:         ...
   8:                 Blob blob = this.resultSet.getBlob(columnIndex);
   9:                 if (blob == null)
  10:         ...
  11:                     return null;
  12:                 return blob.getBinaryStream();

View Full Code Here
   1: import java.lang.reflect.Method;
   2: import java.sql.Blob;
   3: import java.sql.Clob;
   4:         ...
   5: 
   6:     private static final String BLOB_CLASS_NAME = "oracle.sql.BLOB";
   7: 
   8:         ...
   9:     public byte[] getBlobAsBytes(ResultSet rs, int columnIndex) throws SQLException {
  10:         logger.debug("Returning Oracle BLOB as bytes");
  11:         Blob blob = rs.getBlob(columnIndex);
  12:         ...
  13:         Blob blob = rs.getBlob(columnIndex);
  14:         return (blob != null ? blob.getBinaryStream() : null);

View Full Code Here

getBytes

public byte[] getBytes(long pos,
                       int length)
            throws SQLException
Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes. This byte array contains up to length consecutive bytes starting at position pos.
Parameters:
pos - the ordinal position of the first byte in the BLOB value to be extracted; the first byte is at position 1
length - 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 pos
Throws:
SQLException - if there is an error accessing the BLOB value
Since:
1.2
See Also:
setBytes
Usages and Demos :

View More Examples of getBytes(long pos,int length)
   1: public class DataConversion {
   2:     public final static byte[] toByteArray(Blob b) throws SQLException
   3:     {
   4:         ...
   5:         if( b==null ) return null;
   6:         return b.getBytes(1L, (int)b.length());
   7:     }
   8:     public final static byte[] toByteArray(byte[] b) throws SQLException
   9:     {

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5:     protected byte[] getBinaryData(ResultSet rs, int index) throws SQLException {
   6:         Blob aBlob = rs.getBlob(index);
   7:         ...
   8:         return aBlob.getBytes(1, (int) aBlob.length());
   9:     }

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5: 
   6:         Blob aBlob = rs.getBlob(1);
   7:         ...
   8:         return aBlob.getBytes(1, (int) aBlob.length());
   9:     }

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5:     protected byte[] getBinaryData(ResultSet rs, int index) throws SQLException {
   6:         Blob aBlob = rs.getBlob(index);
   7:         if (aBlob == null) {
   8:         ...
   9:         }
  10:         return aBlob.getBytes(1, (int) aBlob.length());
  11:     }

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5: 
   6:         Blob aBlob = rs.getBlob(1);
   7:         ...
   8:         return aBlob.getBytes(1, (int) aBlob.length());
   9:     }

View Full Code Here

length

public long length()
            throws SQLException
Returns the number of bytes in the BLOB value designated by this Blob object.
Returns:
length of the BLOB in bytes
Throws:
SQLException - if there is an error accessing the length of the BLOB
Since:
1.2
Usages and Demos :

View More Examples of length()
   1: public class DataConversion {
   2:     public final static byte[] toByteArray(Blob b) throws SQLException
   3:     {
   4:         ...
   5:         if( b==null ) return null;
   6:         return b.getBytes(1L, (int)b.length());
   7:     }
   8:     public final static byte[] toByteArray(byte[] b) throws SQLException
   9:     {

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5:     protected byte[] getBinaryData(ResultSet rs, int index) throws SQLException {
   6:         Blob aBlob = rs.getBlob(index);
   7:         ...
   8:         return aBlob.getBytes(1, (int) aBlob.length());
   9:     }

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5: 
   6:         Blob aBlob = rs.getBlob(1);
   7:         ...
   8:         return aBlob.getBytes(1, (int) aBlob.length());
   9:     }

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5:     protected byte[] getBinaryData(ResultSet rs, int index) throws SQLException {
   6:         Blob aBlob = rs.getBlob(index);
   7:         if (aBlob == null) {
   8:         ...
   9:         }
  10:         return aBlob.getBytes(1, (int) aBlob.length());
  11:     }

View Full Code Here
   1: 
   2: import java.sql.Blob;
   3: import java.sql.ResultSet;
   4:         ...
   5: 
   6:         Blob aBlob = rs.getBlob(1);
   7:         ...
   8:         return aBlob.getBytes(1, (int) aBlob.length());
   9:     }

View Full Code Here

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.
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 - if there is an error accessing the BLOB value
Since:
1.2

position

public long position(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.
Parameters:
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 - if there is an error accessing the BLOB
Since:
1.2

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.
Parameters:
pos - the position in the BLOB 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 the BLOB value
Since:
1.4
Usages and Demos :

View More Examples of setBinaryStream(long pos)
   1: import java.io.OutputStream;
   2: import java.sql.Blob;
   3: import java.sql.Connection;
   4:         ...
   5: 
   6:         Blob blob = res.getBlob(name);
   7:         try {
   8:         ...
   9:             blob.truncate(0);
  10:             return blob.setBinaryStream(0L);
  11:         } catch (SQLException e) {

View Full Code Here

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.
Parameters:
pos - the position in the BLOB object at which to start writing
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 - if there is an error accessing the BLOB value
Since:
1.4

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.
Parameters:
pos - the position in the BLOB object at which to start writing
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
Since:
1.4

truncate

public void truncate(long len)
            throws SQLException
Truncates the BLOB value that this Blob object represents to be len bytes in length.
Parameters:
len - the length, in bytes, to which the BLOB value that this Blob object represents should be truncated
Throws:
SQLException - if there is an error accessing the BLOB value
Since:
1.4
Usages and Demos :

View More Examples of truncate(long len)
   1: import java.io.OutputStream;
   2: import java.sql.Blob;
   3: import java.sql.Connection;
   4:         ...
   5: 
   6:         Blob blob = res.getBlob(name);
   7:         try {
   8:         ...
   9:             blob.truncate(0);
  10:             return blob.setBinaryStream(0L);

View Full Code Here
   1: import java.lang.reflect.Method;
   2: import java.sql.Blob;
   3: import java.sql.Clob;
   4:         ...
   5:     try {
   6:       classOracleBLOB = Class.forName("oracle.sql.BLOB");
   7:       classOracleCLOB = Class.forName("oracle.sql.CLOB");
   8:         ...
   9:     } catch (Exception e) {
  10:       log.log(Level.FINER, L.l("Unable to load LOB classes or methods for oracle.sql.BLOB and oracle.sql.CLOB."));
  11:     }
  12:         ...
  13:         Blob blob = (Blob) _lob;
  14:         blob.truncate(0);

View Full Code Here