com.metamatrix.jdbc
Class MMBlob

java.lang.Object
  com.metamatrix.jdbc.MMBlob

All Implemented Interfaces:

LobSearchUtil.StreamProvider, java.sql.Blob

public class MMBlob
extends java.lang.Object
implements java.sql.Blob, LobSearchUtil.StreamProvider

This object holds a chunk of binary data and implements the JDBC Blob interface. It presents a streaming interface and provides a way to access partial of the blob data. Connectors can use this object when dealing with large objects.

Constructor Summary

MMBlob(StreamingLobChunckProducer.Factory lobChunckFactory, BlobType blob)
Creates a MMBlob object with the valueID.

Method Summary

void	free()
java.io.InputStream	getBinaryStream() Retrieves the BLOB designated by this Blob instance as a stream.
java.io.InputStream	getBinaryStream(long arg0, long arg1)
byte[]	getBytes(long pos, int length) Returns as an array of bytes, part or all of the BLOB value that this Blob object designates.
long	length() Returns the number of bytes in the BLOB value designated by this Blob object.
static java.sql.Blob	newInstance(StreamingLobChunckProducer.Factory lobChunckFactory, BlobType blob) Factory Constructor
long	position(java.sql.Blob pattern, long start) Determines the byte position in the BLOB value designated by this Blob object at which pattern begins.
long	position(byte[] pattern, long start) Determines the byte position at which the specified byte pattern begins within the BLOB value that this Blob object represents.
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 java.lang.Object

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

Constructor Detail

MMBlob

public MMBlob(StreamingLobChunckProducer.Factory lobChunckFactory,
              BlobType blob)

Creates a MMBlob object with the valueID.

Parameters:

valueID - reference to value chunk in data source.

Method Detail

newInstance

public static java.sql.Blob newInstance(StreamingLobChunckProducer.Factory lobChunckFactory,
                                        BlobType blob)

Factory Constructor

Parameters:

statement -

valueID -

getBinaryStream

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

Retrieves the BLOB designated by this Blob instance as a stream.

Specified by:

getBinaryStream in interface LobSearchUtil.StreamProvider

Specified by:

getBinaryStream in interface java.sql.Blob

Returns:

a stream containing the whole or part of the BLOB data

Throws:

java.sql.SQLException - if there is an error accessing the BLOB

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.

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 - 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:

java.sql.SQLException - if there is an error accessing the BLOB

length

public long length()
            throws java.sql.SQLException

Returns the number of bytes in the BLOB value designated by this Blob object.

Specified by:

length in interface java.sql.Blob

Returns:

length of the BLOB in bytes

Throws:

java.sql.SQLException

position

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

Determines the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start.

Specified by:

position in interface java.sql.Blob

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:

java.sql.SQLException - if there is an error accessing the BLOB

position

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

Determines the byte position at which the specified byte pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start.

Specified by:

position in interface java.sql.Blob

Parameters:

pattern - the byte array for which to search

start - 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 the BLOB

free

public void free()
          throws java.sql.SQLException

Specified by:

free in interface java.sql.Blob

Throws:

java.sql.SQLException

getBinaryStream

public java.io.InputStream getBinaryStream(long arg0,
                                           long arg1)
                                    throws java.sql.SQLException

Specified by:

getBinaryStream 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

See Also:

Blob.setBytes(long, byte[])

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

See Also:

Blob.setBytes(long, byte[], int, int)

setBinaryStream

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

Specified by:

setBinaryStream in interface java.sql.Blob

Throws:

java.sql.SQLException

See Also:

Blob.setBinaryStream(long)

truncate

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

Specified by:

truncate in interface java.sql.Blob

Throws:

java.sql.SQLException

See Also:

Blob.truncate(long)