com.metamatrix.common.types
Class BlobImpl

java.lang.Object
  com.metamatrix.common.types.BlobImpl

All Implemented Interfaces:

java.io.Serializable, java.sql.Blob

public class BlobImpl
extends java.lang.Object
implements java.sql.Blob, java.io.Serializable

This object holds a chunk of binary data and implements the JDBC Blob interface. This object presents a streaming interface but actually encapsulates the entire blob object. Connectors can construct this object when dealing with large objects.

See Also:

Serialized Form

Field Summary

static int

DEFAULT_MAX_SIZE

Constructor Summary

BlobImpl(java.sql.Blob blob)
Creates a MMBlob object by calling getBytes on the Blob argument.

BlobImpl(byte[] originalData)
Creates a MMBlob object by copying the data in originalData

BlobImpl(java.io.InputStream in, int length)

Method Summary

boolean	equals(java.lang.Object obj) Compares two MMBlob objects for equality.
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.
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)
java.lang.String	toString() Returns a String that is a comma delimited list of up to the first 5 and last 5 bytes of the Blob in Hexadecimal.
void	truncate(long len)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SIZE

public static final int DEFAULT_MAX_SIZE

See Also:

Constant Field Values

Constructor Detail

BlobImpl

public BlobImpl(java.sql.Blob blob)
         throws java.sql.SQLException

Creates a MMBlob object by calling getBytes on the Blob argument.

Parameters:

blob - the Blob object to get the data from.

Throws:

java.sql.SQLException

BlobImpl

public BlobImpl(byte[] originalData)

Creates a MMBlob object by copying the data in originalData

Parameters:

originalData - the array of bytes to copy into this MMBlob object.

BlobImpl

public BlobImpl(java.io.InputStream in,
                int length)
         throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

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 java.sql.Blob

Returns:

a stream containing 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 - if there is an error accessing the length of the BLOB

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

equals

public boolean equals(java.lang.Object obj)

Compares two MMBlob objects for equality.

Overrides:

equals in class java.lang.Object

Returns:

True if equal

See Also:

Object.equals(Object)

toString

public java.lang.String toString()

Returns a String that is a comma delimited list of up to the first 5 and last 5 bytes of the Blob in Hexadecimal.

Overrides:

toString in class java.lang.Object

Returns:

the String object convenient for displaying this Blob object

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)

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