oracle.jbo.domain.generic

Class GenericBlob

java.lang.Object

oracle.jbo.domain.BaseLobDomain

oracle.jbo.domain.generic.GenericBlob

All Implemented Interfaces:

java.io.Serializable, java.sql.Blob, BlobDomainInterface, DomainInterface, LobInterface, LobStreamInterface, MarshalledDomain, MutableDomainInterface, XMLDomainInterface, oracle.jdbc.internal.ObjectData, oracle.jdbc.OracleData, oracle.sql.ORAData

public class GenericBlob
extends BaseLobDomain
implements LobStreamInterface, XMLDomainInterface, java.io.Serializable, java.sql.Blob

This class provides a lightweight wrapper for oracle.sql.BLOB, the Java representation of the BLOB database type. This wrapper allows an instance of the oracle.sql.BLOB to be used as a domain object.

Since:

JDeveloper 3.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jbo.domain.BaseLobDomain

BaseLobDomain.BlobOutputStream

Field Summary

Fields inherited from class oracle.jbo.domain.BaseLobDomain

lob, LOGGER_NAME, mClient, mData, mDataModified, mIndexString, mNeedsServerSync, mOwner, relIdx, xAct

Constructor Summary

Constructors

Constructor and Description
GenericBlob() Constructor for this object.
GenericBlob(java.sql.Blob blob) Constructor for this object.
GenericBlob(java.sql.Blob blob, byte[] blobData) Creates an instance of this class with data as described in blobData and using the transaction context from blob to use the blob-locator in the database.
GenericBlob(byte[] data) Constructor for this class.
GenericBlob(GenericBlob nblob, byte[] blobData) Creates an instance of this class with data as described in blobData and using the transaction context from blob to use the blob-locator in the database.
GenericBlob(ResponseValues respVals)

Method Summary

Modifier and Type	Method and Description
void	closeCharacterOutputStream() Closes and cleansup internal reference to writer.
boolean	equals(java.lang.Object obj) Tests for equality between this and obj.
void	free()
java.io.OutputStream	getBinaryOutputStream()
java.io.InputStream	getBinaryStream()
java.io.InputStream	getBinaryStream(long pos, long length)
int	getBufferSize()
byte[]	getBytes(long offset, int length)
int	getBytes(long pos, int length, byte[] buf)
java.io.Writer	getCharacterOutputStream() Returns a writer to be used to write chars into this CLOB.
protected java.io.InputStream	getInternalDataStream()
protected java.io.InputStream	getInternalDataStream(long pos, long length)
protected java.io.OutputStream	getInternalOutputStream(long pos)
protected java.io.InputStream	getInternalStream()
protected java.io.InputStream	getInternalStream(long pos, long length)
long	getLength()
org.w3c.dom.Node	getXMLContentNode(org.w3c.dom.Document xmlDoc) Creates the XML node in the given XML document for this domain's data.
static XMLDomainFactory	getXMLDomainFactory(java.lang.Class attrClass) Internal: Applications should not use this method.
protected java.lang.String	getXMLElementTag() Returns this class name as an XML-element tag for this Struct domain object.
long	length()
long	position(java.sql.Blob pattern, long start)
long	position(byte[] pattern, long start)
void	prepareForDML(java.lang.Object context) Internal: Applications should not use this method.
java.lang.String	printXMLDefinition(java.util.Hashtable allDefs, java.io.PrintWriter pw, boolean bContainees) Prints the DTD information for this domain in the given print writer.
protected byte[]	readBytesFromLob(long offset, int length)
java.io.OutputStream	setBinaryStream(long pos)
int	setBytes(long pos, byte[] bytes)
protected void	syncLob(java.lang.Object otherLob)
void	truncate(long len)
protected void	writeBytesToLob()

Methods inherited from class oracle.jbo.domain.BaseLobDomain

closeCharacterStream, closeInputStream, closeOutputStream, getCharacterStream, getData, getInputStream, getInputStream, getInvokeDomainMethod, getOutputStream, getOutputStream, getOwner, getOwnerAttributeIndex, getOwnerRow, getRemoteBufferSize, getRemoteIdString, getRemoteLength, getSize, getStorageByteArray, isCacheDataModified, loadFromDatabase, marshal, resetCachedData, saveToDatabase, saveToDatabase, setBytes, setBytes, setContext, syncClientLob, syncServerLob, toByteArray, toDatum, toJDBCObject, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.domain.LobStreamInterface

closeCharacterStream, closeInputStream, closeOutputStream, getCharacterStream, getInputStream, getOutputStream

Methods inherited from interface oracle.jbo.domain.LobInterface

getOwner, getOwnerAttributeIndex, getRemoteIdString, getSize, syncClientLob, syncServerLob

Methods inherited from interface oracle.jbo.domain.BlobDomainInterface

loadFromDatabase, saveToDatabase, saveToDatabase

Methods inherited from interface oracle.jbo.domain.DomainInterface

getData, setContext

Methods inherited from interface java.sql.Blob

setBytes

Constructor Detail

GenericBlob

public GenericBlob()

Constructor for this object.

GenericBlob

public GenericBlob(java.sql.Blob blob)

Constructor for this object. This is for use by JDBC. This constructor uses the transaction context from blob to use the blob-locator in the database.

Parameters:

blob - the BLOB from which to construct the GenericBlob.

GenericBlob

public GenericBlob(byte[] data)

Constructor for this class. Creates an instance of this class with data as described in blobData.

Parameters:

data - data for the BLOB.

GenericBlob

public GenericBlob(java.sql.Blob blob,
                   byte[] blobData)

Creates an instance of this class with data as described in blobData and using the transaction context from blob to use the blob-locator in the database.

Parameters:

blob - transaction context for the BLOB locator, as a BLOB object.

blobData - data for the BLOB.

GenericBlob

public GenericBlob(GenericBlob nblob,
                   byte[] blobData)

Creates an instance of this class with data as described in blobData and using the transaction context from blob to use the blob-locator in the database.

This constructor should be used by applications using the framework to create GenericBlob objects.

Parameters:

nblob - transaction context for the BLOB locator as a GenericBlob object.

blobData - data for the BLOB.

GenericBlob

public GenericBlob(ResponseValues respVals)

Method Detail

prepareForDML

public void prepareForDML(java.lang.Object context)

Internal: Applications should not use this method.

Specified by:

prepareForDML in interface BlobDomainInterface

Specified by:

prepareForDML in class BaseLobDomain

Parameters:

context - an internal framework context.

equals

public boolean equals(java.lang.Object obj)

Tests for equality between this and obj. Converts all the data into a String and compares the two strings. This is a default implementation of equals which could be overridden to perform more scalable application-specific comparisons.

Overrides:

equals in class BaseLobDomain

Parameters:

obj - the data item to compare against.

getXMLElementTag

protected java.lang.String getXMLElementTag()

Returns this class name as an XML-element tag for this Struct domain object. Override this method to return a custom XML-element tag for this domain.

getXMLContentNode

public org.w3c.dom.Node getXMLContentNode(org.w3c.dom.Document xmlDoc)

Creates the XML node in the given XML document for this domain's data.

Specified by:

getXMLContentNode in interface XMLDomainInterface

Parameters:

xmlDoc - name of the XML document.

printXMLDefinition

public java.lang.String printXMLDefinition(java.util.Hashtable allDefs,
                                           java.io.PrintWriter pw,
                                           boolean bContainees)

Prints the DTD information for this domain in the given print writer. Returns the DTD string to be added to this domain's container entity/domain.

Specified by:

printXMLDefinition in interface XMLDomainInterface

Parameters:

allDefs - name of hashtable containing key-value pairs of XML tags and their values.

pw - printwriter on which the information should be printed.

bContainees - whether this domain container has containees.

getXMLDomainFactory

public static XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)

Internal: Applications should not use this method.

getBinaryOutputStream

public java.io.OutputStream getBinaryOutputStream()
                                           throws java.sql.SQLException

Throws:

java.sql.SQLException

getBinaryStream

public java.io.InputStream getBinaryStream()

Specified by:

getBinaryStream in interface java.sql.Blob

getBinaryStream

public java.io.InputStream getBinaryStream(long pos,
                                           long length)
                                    throws java.sql.SQLException

Specified by:

getBinaryStream in interface java.sql.Blob

Throws:

java.sql.SQLException

getBytes

public byte[] getBytes(long offset,
                       int length)

Specified by:

getBytes in interface java.sql.Blob

readBytesFromLob

protected byte[] readBytesFromLob(long offset,
                                  int length)

Specified by:

readBytesFromLob in class BaseLobDomain

writeBytesToLob

protected void writeBytesToLob()

Specified by:

writeBytesToLob in class BaseLobDomain

getInternalOutputStream

protected java.io.OutputStream getInternalOutputStream(long pos)

Specified by:

getInternalOutputStream in class BaseLobDomain

getInternalStream

protected java.io.InputStream getInternalStream()

Specified by:

getInternalStream in class BaseLobDomain

getInternalStream

protected java.io.InputStream getInternalStream(long pos,
                                                long length)

Specified by:

getInternalStream in class BaseLobDomain

getInternalDataStream

protected java.io.InputStream getInternalDataStream()

Specified by:

getInternalDataStream in class BaseLobDomain

getInternalDataStream

protected java.io.InputStream getInternalDataStream(long pos,
                                                    long length)

Specified by:

getInternalDataStream in class BaseLobDomain

getLength

public long getLength()

Specified by:

getLength in class BaseLobDomain

length

public long length()
            throws java.sql.SQLException

Specified by:

length in interface java.sql.Blob

Throws:

java.sql.SQLException

position

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

Specified by:

position in interface java.sql.Blob

Throws:

java.sql.SQLException

position

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

Specified by:

position in interface java.sql.Blob

Throws:

java.sql.SQLException

syncLob

protected void syncLob(java.lang.Object otherLob)

Specified by:

syncLob in class BaseLobDomain

getBufferSize

public int getBufferSize()

getBytes

public int getBytes(long pos,
                    int length,
                    byte[] buf)

setBytes

public int setBytes(long pos,
                    byte[] bytes)
             throws java.sql.SQLException

Specified by:

setBytes in interface java.sql.Blob

Throws:

java.sql.SQLException

setBinaryStream

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

Specified by:

setBinaryStream in interface java.sql.Blob

Throws:

java.sql.SQLException

truncate

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

Specified by:

truncate in interface java.sql.Blob

Throws:

java.sql.SQLException

free

public void free()
          throws java.sql.SQLException

Specified by:

free in interface java.sql.Blob

Throws:

java.sql.SQLException

getCharacterOutputStream

public java.io.Writer getCharacterOutputStream()

Description copied from interface: LobStreamInterface

Returns a writer to be used to write chars into this CLOB. This stream works in both 2/3 tiers. In 2-tier, this writer could be the same as the writer returned by the internal jdbc object. In 3-tier, this stream is a remote writer that streams data from the middle-tier LOB.

Specified by:

getCharacterOutputStream in interface LobStreamInterface

closeCharacterOutputStream

public void closeCharacterOutputStream()

Description copied from interface: LobStreamInterface

Closes and cleansup internal reference to writer.

Specified by:

closeCharacterOutputStream in interface LobStreamInterface