public class ClobDomain extends BaseLobDomain implements LobStreamInterface, java.io.Serializable, XMLDomainInterface
BaseLobDomain.BlobOutputStreamlob, LOGGER_NAME, mClient, mData, mDataModified, mIndexString, mNeedsServerSync, mOwner, relIdx, xAct| Constructor and Description | 
|---|
| 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  clobDataand using the transaction context fromclobto use the clob-locator
 in the database. | 
| ClobDomain(ResponseValues respVals) | 
| ClobDomain(java.lang.String str)Constructs an instance of this class, given a string. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | closeCharacterOutputStream()Closes and cleansup internal reference to writer. | 
| void | closeCharacterStream()Close the  Clobcontents as a Unicode reader. | 
| void | closeOutputStream()Closes the OutputStream object. | 
| static java.sql.Clob | createEmptyCLOB(java.lang.Object context)Deprecated. 
 since 11.1.1.6. Use standard  Connection.createClob()instead. | 
| boolean | equals(java.lang.Object obj)Converts all the data into a String and compares the two strings. | 
| java.io.OutputStream | getAsciiOutputStream()Deprecated. 
 since 9.0.3.5. Use getCharacterOutputStream() instead. | 
| java.io.InputStream | getAsciiStream()Deprecated. 
 since 11.1.2.0.0. Use getCharacterStream() instead. | 
| 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  Clobcontents 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. | 
| 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()Returns the number of characters
 in the  Clobvalue
 designated by thisClobobject. | 
| java.io.OutputStream | getOutputStream()Deprecated. 
 since 9.0.3.5. Use getCharacterOutputStream() 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  Clobvalue
 designated by thisClobobject. | 
| CLOB | getTempClobBindVarVal(java.sql.Connection conn) | 
| Node | getXMLContentNode(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. | 
| ResponseValues | marshal()Internal: Applications should not use this method. | 
| 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) | 
| 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. | 
| protected void | syncLob(java.lang.Object otherLob) | 
| 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. | 
| protected void | writeBytesToLob() | 
closeInputStream, getInputStream, getInvokeDomainMethod, getOutputStream, getOwner, getOwnerAttributeIndex, getOwnerRow, getRemoteBufferSize, getRemoteIdString, getRemoteLength, getSize, getStorageByteArray, isCacheDataModified, loadFromDatabase, setBytes, setContext, toByteArray, toDatum, toJDBCObjectclone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcloseInputStreamgetOwner, getOwnerAttributeIndex, getRemoteIdString, getSizeloadFromDatabasesetContextpublic ClobDomain()
public ClobDomain(java.lang.String str)
str - a string to be used for a ClobDomain.public ClobDomain(byte[] data)
data - a byte array to be used for a ClobDomain.public ClobDomain(char[] data)
data - a char array to be used for a ClobDomain.public ClobDomain(java.sql.Clob clob)
clob - a Clob to be used for a ClobDomain.public ClobDomain(CLOB clob)
public ClobDomain(java.sql.Clob clob,
          byte[] clobData)
 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.
 
clob - name of the Clob to use as a ClobDomain.clobData - data to fill the Clob.public ClobDomain(CLOB clob, byte[] clobData)
public ClobDomain(java.sql.Clob clob,
          char[] clobData)
 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.
 
clob - name of the Clob to use as a ClobDomain.clobData - data to fill the Clob.public ClobDomain(CLOB clob, char[] clobData)
public ClobDomain(ClobDomain nclob, byte[] clobData)
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.
nclob - name of the Clob to use as a ClobDomain.clobData - data to fill the Clob.public ClobDomain(ClobDomain nclob, char[] clobData, OracleConnection conn)
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.
nclob - name of the Clob to use as a ClobDomain.clobData - data to fill the Clob.conn - Oracle-specific JDBC connection.public ClobDomain(ClobDomain nclob, char[] clobData)
public ClobDomain(ResponseValues respVals)
public void useCLOB(java.sql.Clob newClob)
 If this object does not have a transaction context, shares the transaction
 and Clob locator from newClob.
newClob - name of the Clob with which this Clob will share its
 transaction and Clob locator information.public ResponseValues marshal()
marshal in interface MarshalledDomainmarshal in class BaseLobDomainpublic void prepareForDML(java.lang.Object context)
prepareForDML in interface BlobDomainInterfaceprepareForDML in class BaseLobDomainpublic void setIsBindVar(boolean isBindVar)
public void saveToDatabase(Transaction xAct) throws java.sql.SQLException
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.
saveToDatabase in interface BlobDomainInterfacesaveToDatabase in class BaseLobDomainxAct - name of the transaction context.java.sql.SQLExceptionpublic void saveToDatabase(Transaction xAct, java.lang.Object emptySQLObject) throws java.sql.SQLException
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.
saveToDatabase in interface BlobDomainInterfacesaveToDatabase in class BaseLobDomainjava.sql.SQLExceptionpublic boolean equals(java.lang.Object obj)
equals in class BaseLobDomainobj - the object to compare to this ClobDomain.public static XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)
public static java.sql.Clob createEmptyCLOB(java.lang.Object context)
Connection.createClob() instead.context - an internal framework context.public java.lang.String getSubString(long offset,
                            int length)
Clob value
 designated by this Clob object.
 The substring begins at position
 offset and has up to length consecutive
 characters.offset - the first character of the substring to be extracted.
            The first character is at position 1.length - the number of consecutive characters to be copiedString that is the specified substring in
         the Clob value designated by this Clob objectjava.sql.SQLException - if there is an error accessing the
 Clobpublic java.io.OutputStream getAsciiOutputStream()
public java.io.InputStream getInputStream()
Clob value designated by this Clob
 object as a stream of Ascii bytes.getInputStream in interface LobStreamInterfacegetInputStream in class BaseLobDomainClob data 
 Clob valuepublic java.io.InputStream getAsciiStream()
Clob value designated by this Clob
 object as a stream of Ascii bytes.Clob data
 Clob valueprotected void resetCachedData()
resetCachedData in class BaseLobDomainpublic char[] getStorageCharArray()
public byte[] getStorageByteArray(java.lang.String enc)
public java.io.OutputStream getOutputStream()
getOutputStream in interface LobStreamInterfacegetOutputStream in class BaseLobDomainpublic java.io.Writer getCharacterOutputStream()
getCharacterOutputStream in interface LobStreamInterfacepublic java.io.Writer getCharacterOutputStream(java.lang.String enc)
public void closeCharacterStream()
Clob contents as a Unicode reader.
 ClobcloseCharacterStream in interface LobStreamInterfacecloseCharacterStream in class BaseLobDomainpublic java.io.Reader getCharacterStream()
Clob contents as a Unicode reader.getCharacterStream in interface LobStreamInterfacegetCharacterStream in class BaseLobDomainClob datajava.sql.SQLException - if there is an error accessing the
 Clobpublic java.io.Reader getCharacterStream(java.lang.String enc)
Clob contents as a Unicode stream that uses the named character encoding.Clob datajava.sql.SQLException - if there is an error accessing the
 Clobpublic void setBytes(byte[] clobData)
setBytes in class BaseLobDomainclobData - data to fill the Blob.public void setChars(char[] clobData)
clobData - data to fill the Blob.public void syncClientLob(LobInterface oldObj)
syncClientLob in interface LobInterfacesyncClientLob in class BaseLobDomainpublic void syncServerLob(LobInterface oldObj)
syncServerLob in interface LobInterfacesyncServerLob in class BaseLobDomainpublic java.lang.String toString()
toString in class BaseLobDomainpublic java.lang.Object getData()
getData in interface DomainInterfacegetData in class BaseLobDomainpublic char[] toCharArray()
protected byte[] readBytesFromLob(long offset,
                      int length)
readBytesFromLob in class BaseLobDomainprotected void writeBytesToLob()
writeBytesToLob in class BaseLobDomainprotected java.io.OutputStream getInternalOutputStream(long pos)
getInternalOutputStream in class BaseLobDomainprotected java.io.InputStream getInternalStream()
getInternalStream in class BaseLobDomainprotected java.io.InputStream getInternalStream(long pos,
                                    long length)
getInternalStream in class BaseLobDomainprotected java.io.InputStream getInternalDataStream()
getInternalDataStream in class BaseLobDomainprotected java.io.InputStream getInternalDataStream(long pos,
                                        long length)
getInternalDataStream in class BaseLobDomainprotected void syncLob(java.lang.Object otherLob)
syncLob in class BaseLobDomainpublic long getLength()
Clob value
 designated by this Clob object.getLength in class BaseLobDomainClob in characterspublic int getBufferSize()
public void closeOutputStream()
LobStreamInterfacecloseOutputStream in interface LobStreamInterfacecloseOutputStream in class BaseLobDomainpublic void closeCharacterOutputStream()
LobStreamInterfacecloseCharacterOutputStream in interface LobStreamInterfacepublic Node getXMLContentNode(Document xmlDoc)
getXMLContentNode in interface XMLDomainInterfacexmlDoc - name of the XML document.public java.lang.String printXMLDefinition(java.util.Hashtable allDefs,
                                  java.io.PrintWriter pw,
                                  boolean bContainees)
printXMLDefinition in interface XMLDomainInterfaceallDefs - 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.public CLOB getTempClobBindVarVal(java.sql.Connection conn)