|
Oracle ADF Business Components Domains API Reference 10.1.2 B14023-02 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.jbo.domain.BaseLobDomain
oracle.jbo.domain.ClobDomain
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.
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(CLOB clob, byte[] clobData) Deprecated. since 9.0.3.5. Use ClobDomain(CLOB clob, char[] clobData) Constructor instead. |
|
ClobDomain(CLOB clob, char[] clobData) Internal: Applications should not use this constructor. |
|
ClobDomain(java.lang.String str) Constructs an instance of this class, given a string. |
Method Summary | |
void |
closeCharacterOutputStream() |
void |
closeCharacterStream() Close the Clob contents as a Unicode reader. |
void |
closeOutputStream() |
static 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. |
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 |
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. |
Datum |
toDatum(OracleConnection c) |
java.lang.String |
toString() Converts this ClobDomain object to a string. |
void |
useCLOB(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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ClobDomain()
public ClobDomain(java.lang.String str)
public ClobDomain(byte[] data)
public ClobDomain(char[] data)
public ClobDomain(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, 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.Method Detail |
public void useCLOB(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 class BaseLobDomain
public void prepareForDML(java.lang.Object context)
public Datum toDatum(OracleConnection c) throws java.sql.SQLException
toDatum
in class BaseLobDomain
java.sql.SQLException
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 class BaseLobDomain
xAct
- name of the transaction context.java.sql.SQLException
public 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 class BaseLobDomain
java.sql.SQLException
public boolean equals(java.lang.Object obj)
equals
in class BaseLobDomain
obj
- the object to compare to this ClobDomain.public static XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)
public static CLOB createEmptyCLOB(java.lang.Object context)
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 0.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 CLOB
public java.io.OutputStream getAsciiOutputStream()
public java.io.InputStream getInputStream()
CLOB
value designated by this Clob
object as a stream of Ascii bytes.getInputStream
in class BaseLobDomain
CLOB
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 BaseLobDomain
public char[] getStorageCharArray()
public byte[] getStorageByteArray()
getStorageByteArray
in class BaseLobDomain
public byte[] getStorageByteArray(java.lang.String enc)
public java.io.OutputStream getOutputStream()
getOutputStream
in class BaseLobDomain
public java.io.Writer getCharacterOutputStream()
public java.io.Writer getCharacterOutputStream(java.lang.String enc)
public void closeCharacterStream()
Clob
contents as a Unicode reader. CLOB
closeCharacterStream
in class BaseLobDomain
public java.io.Reader getCharacterStream()
Clob
contents as a Unicode reader.getCharacterStream
in class BaseLobDomain
CLOB
datajava.sql.SQLException
- if there is an error accessing the CLOB
public 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 CLOB
public void setBytes(byte[] clobData)
setBytes
in class BaseLobDomain
clobData
- data to fill the Blob.public void setChars(char[] clobData)
clobData
- data to fill the Blob.public void syncClientLob(LobInterface oldObj)
syncClientLob
in class BaseLobDomain
public void syncServerLob(LobInterface oldObj)
syncServerLob
in class BaseLobDomain
public java.lang.String toString()
toString
in class BaseLobDomain
public java.lang.Object getData()
getData
in class BaseLobDomain
public char[] toCharArray()
public long getLength()
CLOB
value designated by this Clob
object.CLOB
in characterspublic int getBufferSize()
public void closeOutputStream()
closeOutputStream
in class BaseLobDomain
public void closeCharacterOutputStream()
|
Oracle ADF Business Components Domains API Reference 10.1.2 B14023-02 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2005, Oracle. All rights reserved.