Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.1.0)

E10653-02

oracle.jbo.domain
Class ClobDomain

java.lang.Object
  extended by oracle.jbo.domain.BaseLobDomain
      extended by oracle.jbo.domain.ClobDomain
All Implemented Interfaces:
java.io.Serializable, BlobDomainInterface, DomainInterface, LobInterface, LobStreamInterface, MarshalledDomain, MutableDomainInterface, oracle.jdbc.internal.ObjectData, ORAData
Direct Known Subclasses:
NClobDomain

public class ClobDomain
extends BaseLobDomain
implements LobStreamInterface, java.io.Serializable

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

Since:
JDeveloper 3.0
See Also:
Serialized Form

Constructor Summary
ClobDomain()
          Constructor for this class.
ClobDomain(byte[] data)
          Deprecated. since 9.0.3.5. Use ClobDomain(char[] data) Constructor instead.
ClobDomain(char[] data)
          Constructs an instance of this class, given a char array.
ClobDomain(java.sql.Clob clob)
          Constructs an instance of this class, given a Clob object.
ClobDomain(CLOB clob)
          Deprecated. use ClobDomain(Clob) instead.
ClobDomain(java.sql.Clob clob, byte[] clobData)
          Deprecated. since 9.0.3.5. Use ClobDomain(Clob clob, char[] clobData) Constructor instead.
ClobDomain(CLOB clob, byte[] clobData)
          Deprecated. use ClobDomain(Clob, byte[]) instead.
ClobDomain(java.sql.Clob clob, char[] clobData)
          Internal: Applications should not use this constructor.
ClobDomain(CLOB clob, char[] clobData)
          Deprecated. use ClobDomain(Clob, char[]) instead.
ClobDomain(ClobDomain nclob, byte[] clobData)
          Deprecated. since 9.0.3.5. Use ClobDomain(ClobDomain clob, char[] clobData) Constructor instead.
ClobDomain(ClobDomain nclob, char[] clobData)
          Deprecated. use ClobDomain(ClobDomain, char[], OracleConnection) instead.
ClobDomain(ClobDomain nclob, char[] clobData, OracleConnection conn)
          Creates an instance of this class with data as described in clobData and using the transaction context from clob to use the clob-locator in the database.
ClobDomain(ResponseValues respVals)
           
ClobDomain(java.lang.String str)
          Constructs an instance of this class, given a string.
 
Method Summary
 void closeCharacterOutputStream()
          Closes and cleansup internal reference to writer.
 void closeCharacterStream()
          Close the Clob contents as a Unicode reader.
 void closeOutputStream()
          Closes the OutputStream object.
static java.sql.Clob createEmptyCLOB(java.lang.Object context)
          Creates an empty Clob object.
 boolean equals(java.lang.Object obj)
          Converts all the data into a String and compares the two strings.
protected  void finalize()
           
 java.io.OutputStream getAsciiOutputStream()
          Deprecated. since 9.0.3.5. Use getCharacterOutputStream() instead.
 java.io.InputStream getAsciiStream()
          Gets the Clob value designated by this Clob object as a stream of Ascii bytes.
 int getBufferSize()
          Get ideal LOB db access buffer size.
 java.io.Writer getCharacterOutputStream()
          Returns a Writer for Unicode stream to the Clob that uses the default character encoding.
 java.io.Writer getCharacterOutputStream(java.lang.String enc)
          Deprecated. since 9.0.3.5. Use getCharacterOutputStream() instead.
 java.io.Reader getCharacterStream()
          Gets the Clob contents as a Unicode reader.
 java.io.Reader getCharacterStream(java.lang.String enc)
          Deprecated. since 9.0.3.5. Use getCharacterStream() instead.
 java.lang.Object getData()
          Internal: Applications should not use this method.
 java.io.InputStream getInputStream()
          Deprecated. since 9.0.3.5. Use getCharacterStream() instead.
 long getLength()
          Returns the number of characters in the Clob value designated by this Clob object.
 java.io.OutputStream getOutputStream()
          Deprecated. since 9.0.3.5. Use getCharacterOutputStream() instead.
 byte[] getStorageByteArray()
          Deprecated. since 9.0.3.5. Use getStorageCharArray() instead.
 byte[] getStorageByteArray(java.lang.String enc)
          Deprecated. since 9.0.3.5. Use getStorageCharArray() instead.
 char[] getStorageCharArray()
          Converts this Clob contents into a char array.
 java.lang.String getSubString(long offset, int length)
          Returns a copy of the specified substring in the Clob value designated by this Clob object.
static XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)
          Internal: Applications should not use this method.
 ResponseValues marshal()
          Internal: Applications should not use this method.
 void prepareForDML(java.lang.Object context)
          Internal: Applications should not use this method.
protected  void resetCachedData()
           
 void saveToDatabase(Transaction xAct)
          Internal: Applications should not use this method.
 void saveToDatabase(Transaction xAct, java.lang.Object emptySQLObject)
          Internal: Applications should not use this method.
 void setBytes(byte[] clobData)
          Deprecated. since 9.0.3.5. Use setChars(char[] clobData) instead.
 void setChars(char[] clobData)
          Sets the Clob data for this object.
 void setIsBindVar(boolean isBindVar)
          Internal: Applications should not use this method.
 void syncClientLob(LobInterface oldObj)
          Internal: Applications should not use this function.
 void syncServerLob(LobInterface oldObj)
          Internal: Applications should not use this function.
 char[] toCharArray()
          Converts this cLOB contents into a char array.
 java.lang.String toString()
          Converts this ClobDomain object to a string.
 void useCLOB(java.sql.Clob newClob)
          Internal: Applications should not use this method.
 
Methods inherited from class oracle.jbo.domain.BaseLobDomain
closeInputStream, getInvokeDomainMethod, getOwner, getOwnerAttributeIndex, getOwnerRow, getRemoteBufferSize, getRemoteIdString, getRemoteLength, getSize, isCacheDataModified, loadFromDatabase, setContext, toByteArray, toDatum
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.jbo.domain.LobStreamInterface
closeInputStream
 
Methods inherited from interface oracle.jbo.domain.LobInterface
getOwner, getOwnerAttributeIndex, getRemoteIdString, getSize
 
Methods inherited from interface oracle.jbo.domain.BlobDomainInterface
loadFromDatabase
 
Methods inherited from interface oracle.jbo.domain.DomainInterface
setContext
 

Constructor Detail

ClobDomain

public ClobDomain()
Constructor for this class.


ClobDomain

public ClobDomain(java.lang.String str)
Constructs an instance of this class, given a string.

Parameters:
str - a string to be used for a ClobDomain.

ClobDomain

public ClobDomain(byte[] data)
Deprecated. since 9.0.3.5. Use ClobDomain(char[] data) Constructor instead.

Constructs an instance of this class, given a byte array.

Parameters:
data - a byte array to be used for a ClobDomain.

ClobDomain

public ClobDomain(char[] data)
Constructs an instance of this class, given a char array.

Parameters:
data - a char array to be used for a ClobDomain.

ClobDomain

public ClobDomain(java.sql.Clob clob)
Constructs an instance of this class, given a Clob object.

Parameters:
clob - a Clob to be used for a ClobDomain.

ClobDomain

public ClobDomain(CLOB clob)
Deprecated. use ClobDomain(Clob) instead.


ClobDomain

public ClobDomain(java.sql.Clob clob,
                  byte[] clobData)
Deprecated. since 9.0.3.5. Use ClobDomain(Clob clob, char[] clobData) Constructor instead.

Internal: Applications should not use this constructor.

Creates an instance of this class with data as described in clobData and using the transaction context from clob to use the Clob locator in the database.

Parameters:
clob - name of the Clob to use as a ClobDomain.
clobData - data to fill the Clob.

ClobDomain

public ClobDomain(CLOB clob,
                  byte[] clobData)
Deprecated. use ClobDomain(Clob, byte[]) instead.


ClobDomain

public ClobDomain(java.sql.Clob clob,
                  char[] clobData)
Internal: Applications should not use this constructor.

Creates an instance of this class with char data as described in clobData and using the transaction context from clob to use the Clob locator in the database.

Parameters:
clob - name of the Clob to use as a ClobDomain.
clobData - data to fill the Clob.

ClobDomain

public ClobDomain(CLOB clob,
                  char[] clobData)
Deprecated. use ClobDomain(Clob, char[]) instead.


ClobDomain

public ClobDomain(ClobDomain nclob,
                  byte[] clobData)
Deprecated. since 9.0.3.5. Use ClobDomain(ClobDomain clob, char[] clobData) Constructor instead.

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

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

Parameters:
nclob - name of the Clob to use as a ClobDomain.
clobData - data to fill the Clob.

ClobDomain

public ClobDomain(ClobDomain nclob,
                  char[] clobData,
                  OracleConnection conn)
Creates an instance of this class with data as described in clobData and using the transaction context from clob to use the clob-locator in the database.

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

Parameters:
nclob - name of the Clob to use as a ClobDomain.
clobData - data to fill the Clob.

ClobDomain

public ClobDomain(ClobDomain nclob,
                  char[] clobData)
Deprecated. use ClobDomain(ClobDomain, char[], OracleConnection) instead.


ClobDomain

public ClobDomain(ResponseValues respVals)
Method Detail

useCLOB

public void useCLOB(java.sql.Clob newClob)
Internal: Applications should not use this method.

If this object does not have a transaction context, shares the transaction and Clob locator from newClob.

Parameters:
newClob - name of the Clob with which this Clob will share its transaction and Clob locator information.

marshal

public ResponseValues marshal()
Internal: Applications should not use this method.

Specified by:
marshal in interface MarshalledDomain
Overrides:
marshal in class BaseLobDomain

prepareForDML

public void prepareForDML(java.lang.Object context)
Internal: Applications should not use this method.

Specified by:
prepareForDML in interface BlobDomainInterface

setIsBindVar

public void setIsBindVar(boolean isBindVar)
Internal: Applications should not use this method.


saveToDatabase

public void saveToDatabase(Transaction xAct)
                    throws java.sql.SQLException
Internal: Applications should not use this method.

Uses the given transaction context to store data back into the database using the blob-locator which should be set before this method is invoked.

Specified by:
saveToDatabase in interface BlobDomainInterface
Overrides:
saveToDatabase in class BaseLobDomain
Parameters:
xAct - name of the transaction context.
Throws:
java.sql.SQLException

saveToDatabase

public void saveToDatabase(Transaction xAct,
                           java.lang.Object emptySQLObject)
                    throws java.sql.SQLException
Internal: Applications should not use this method.

Uses the given transaction context to store data back into the database using the blob-locator which should be set before this method is invoked.

Specified by:
saveToDatabase in interface BlobDomainInterface
Overrides:
saveToDatabase in class BaseLobDomain
Throws:
java.sql.SQLException

equals

public boolean equals(java.lang.Object 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 comparision.

Overrides:
equals in class BaseLobDomain
Parameters:
obj - the object to compare to this ClobDomain.

getXMLDomainFactory

public static XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)
Internal: Applications should not use this method.


createEmptyCLOB

public static java.sql.Clob createEmptyCLOB(java.lang.Object context)
Creates an empty Clob object.

Parameters:
context - an internal framework context.

getSubString

public java.lang.String getSubString(long offset,
                                     int length)
Returns a copy of the specified substring in the Clob value designated by this Clob object. The substring begins at position offset and has up to length consecutive characters.

Parameters:
offset - the first character of the substring to be extracted. The first character is at position 0.
length - the number of consecutive characters to be copied
Returns:
a String that is the specified substring in the Clob value designated by this Clob object
Throws:
java.sql.SQLException - if there is an error accessing the Clob

getAsciiOutputStream

public java.io.OutputStream getAsciiOutputStream()
Deprecated. since 9.0.3.5. Use getCharacterOutputStream() instead.

get ascii OutputStream of the Clob.

Returns:
a ascii output stream.

getInputStream

public java.io.InputStream getInputStream()
Deprecated. since 9.0.3.5. Use getCharacterStream() instead.

Gets the Clob value designated by this Clob object as a stream of Ascii bytes.

Specified by:
getInputStream in interface LobStreamInterface
Overrides:
getInputStream in class BaseLobDomain
Returns:
an InputStream containing the Clob data Clob value

getAsciiStream

public java.io.InputStream getAsciiStream()
Gets the Clob value designated by this Clob object as a stream of Ascii bytes.

Returns:
an ascii stream containing the Clob data Clob value

resetCachedData

protected void resetCachedData()
Overrides:
resetCachedData in class BaseLobDomain

getStorageCharArray

public char[] getStorageCharArray()
Converts this Clob contents into a char array.

Returns:
a Char array containing the contents of the Clob.

getStorageByteArray

public byte[] getStorageByteArray()
Deprecated. since 9.0.3.5. Use getStorageCharArray() instead.

Overrides:
getStorageByteArray in class BaseLobDomain

getStorageByteArray

public byte[] getStorageByteArray(java.lang.String enc)
Deprecated. since 9.0.3.5. Use getStorageCharArray() instead.


getOutputStream

public java.io.OutputStream getOutputStream()
Deprecated. since 9.0.3.5. Use getCharacterOutputStream() instead.

get OutputStream of the Domain.

Specified by:
getOutputStream in interface LobStreamInterface
Overrides:
getOutputStream in class BaseLobDomain
Returns:
an outputStream.

getCharacterOutputStream

public java.io.Writer getCharacterOutputStream()
Returns a Writer for Unicode stream to the Clob that uses the default character encoding.

Specified by:
getCharacterOutputStream in interface LobStreamInterface
Returns:
a Unicode character writer.

getCharacterOutputStream

public java.io.Writer getCharacterOutputStream(java.lang.String enc)
Deprecated. since 9.0.3.5. Use getCharacterOutputStream() instead.

Returns a Writer for Unicode stream to the Clob that uses the named character encoding

Returns:
a Unicode character writer.

closeCharacterStream

public void closeCharacterStream()
Close the Clob contents as a Unicode reader. Clob

Specified by:
closeCharacterStream in interface LobStreamInterface
Overrides:
closeCharacterStream in class BaseLobDomain

getCharacterStream

public java.io.Reader getCharacterStream()
Gets the Clob contents as a Unicode reader.

Specified by:
getCharacterStream in interface LobStreamInterface
Overrides:
getCharacterStream in class BaseLobDomain
Returns:
a Unicode reader containing the Clob data
Throws:
java.sql.SQLException - if there is an error accessing the Clob

getCharacterStream

public java.io.Reader getCharacterStream(java.lang.String enc)
Deprecated. since 9.0.3.5. Use getCharacterStream() instead.

Gets the Clob contents as a Unicode stream that uses the named character encoding.

Returns:
a Unicode stream containing the Clob data
Throws:
java.sql.SQLException - if there is an error accessing the Clob

setBytes

public void setBytes(byte[] clobData)
Deprecated. since 9.0.3.5. Use setChars(char[] clobData) instead.

Sets the Clob data for this object. On the client side, if there's a context available with this object, the bytes are streamed to the middle-tier object right-away. However if there's no context object, it's assumed that there will be a setAttribute call invoked on a containing row with this object as argument to stream the bytes via piggy-back.

Overrides:
setBytes in class BaseLobDomain
Parameters:
clobData - data to fill the Blob.

setChars

public void setChars(char[] clobData)
Sets the Clob data for this object. On the client side, if there's a context available with this object, the bytes are streamed to the middle-tier object right-away. However if there's no context object, it's assumed that there will be a setAttribute call invoked on a containing row with this object as argument to stream the bytes via piggy-back.

Parameters:
clobData - data to fill the Blob.

syncClientLob

public void syncClientLob(LobInterface oldObj)
Internal: Applications should not use this function.

Specified by:
syncClientLob in interface LobInterface
Overrides:
syncClientLob in class BaseLobDomain

syncServerLob

public void syncServerLob(LobInterface oldObj)
Internal: Applications should not use this function.

Specified by:
syncServerLob in interface LobInterface
Overrides:
syncServerLob in class BaseLobDomain

toString

public java.lang.String toString()
Converts this ClobDomain object to a string.

Overrides:
toString in class BaseLobDomain
Returns:
this ClobDomain as a string.

getData

public java.lang.Object getData()
Internal: Applications should not use this method.

Specified by:
getData in interface DomainInterface
Overrides:
getData in class BaseLobDomain
Returns:
a formatted value object.

toCharArray

public char[] toCharArray()
Converts this cLOB contents into a char array.

Returns:
a char array containing the contents of the BLOB.

getLength

public long getLength()
Returns the number of characters in the Clob value designated by this Clob object.

Returns:
length of the Clob in characters

getBufferSize

public int getBufferSize()
Get ideal LOB db access buffer size.

Returns:
the size in terms of characters.

closeOutputStream

public void closeOutputStream()
Description copied from interface: LobStreamInterface
Closes the OutputStream object. The OutputStream field is reset so that if getOutputStream() is called again, a new OutputStream is opened.

Specified by:
closeOutputStream in interface LobStreamInterface
Overrides:
closeOutputStream in class BaseLobDomain

closeCharacterOutputStream

public void closeCharacterOutputStream()
Description copied from interface: LobStreamInterface
Closes and cleansup internal reference to writer.

Specified by:
closeCharacterOutputStream in interface LobStreamInterface

finalize

protected void finalize()
Overrides:
finalize in class java.lang.Object

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.1.0)

E10653-02

Copyright © 1997, 2009, Oracle. All rights reserved.