Class MemoryClob
- All Implemented Interfaces:
- Clob
public class MemoryClob extends Object implements Clob
This implementation is based on jdbcClob from HSQLDB (copyright HSQL Development Group).
- Since:
- 1.2
- 
Constructor SummaryConstructors Constructor Description MemoryClob(String data)Constructs a new jdbcClob object wrapping the given character sequence.
- 
Method SummaryModifier and Type Method Description voidfree()InputStreamgetAsciiStream()Retrieves theCLOBvalue designated by thisClobobject as an ascii stream.ReadergetCharacterStream()Retrieves theCLOBvalue designated by thisClobobject as ajava.io.Readerobject (or as a stream of characters).ReadergetCharacterStream(long pos, long length)StringgetSubString(long pos, int length)Retrieves a copy of the specified substring in theCLOBvalue designated by thisClobobject.longlength()Retrieves the number of characters in theCLOBvalue designated by thisClobobject.longposition(String searchstr, long start)Retrieves the character position at which the specified substringsearchstrappears in the SQLCLOBvalue represented by thisClobobject.longposition(Clob searchstr, long start)Retrieves the character position at which the specifiedClobobjectsearchstrappears in thisClobobject.OutputStreamsetAsciiStream(long pos)Retrieves a stream to be used to write Ascii characters to theCLOBvalue that thisClobobject represents, starting at positionpos.WritersetCharacterStream(long pos)Retrieves a stream to be used to write a stream of Unicode characters to theCLOBvalue that thisClobobject represents, at positionpos.intsetString(long pos, String str)Writes the given JavaStringto theCLOBvalue that thisClobobject designates at the positionpos.intsetString(long pos, String str, int offset, int len)Writeslencharacters ofstr, starting at characteroffset, to theCLOBvalue that thisClobrepresents.voidtruncate(long len)Truncates theCLOBvalue that thisClobdesignates to have a length oflencharacters.
- 
Constructor Details- 
MemoryClobConstructs a new jdbcClob object wrapping the given character sequence.This constructor is used internally to retrieve result set values as Clob objects, yet it must be public to allow access from other packages. As such (in the interest of efficiency) this object maintains a reference to the given String object rather than making a copy and so it is gently suggested (in the interest of effective memory management) that extenal clients using this constructor either take pause to consider the implications or at least take care to provide a String object whose internal character buffer is not much larger than required to represent the value. - Parameters:
- data- the character sequence representing the Clob value
- Throws:
- CayenneRuntimeException- if the argument is null
 
 
- 
- 
Method Details- 
lengthRetrieves the number of characters in theCLOBvalue designated by thisClobobject.- Specified by:
- lengthin interface- Clob
- Returns:
- length of the CLOBin characters
- Throws:
- SQLException- if there is an error accessing the length of the- CLOBvalue
 
- 
getSubStringRetrieves a copy of the specified substring in theCLOBvalue designated by thisClobobject. The substring begins at positionposand has up tolengthconsecutive characters.- Specified by:
- getSubStringin interface- Clob
- Throws:
- SQLException
 
- 
getCharacterStreamRetrieves theCLOBvalue designated by thisClobobject as ajava.io.Readerobject (or as a stream of characters).- Specified by:
- getCharacterStreamin interface- Clob
- Returns:
- a java.io.Readerobject containing theCLOBdata
- Throws:
- SQLException- if there is an error accessing the- CLOBvalue
 
- 
getAsciiStreamRetrieves theCLOBvalue designated by thisClobobject as an ascii stream.- Specified by:
- getAsciiStreamin interface- Clob
- Returns:
- a java.io.InputStreamobject containing theCLOBdata
- Throws:
- SQLException- if there is an error accessing the- CLOBvalue
 
- 
positionRetrieves the character position at which the specified substringsearchstrappears in the SQLCLOBvalue represented by thisClobobject. The search begins at positionstart.- Specified by:
- positionin interface- Clob
- Parameters:
- searchstr- the substring for which to search
- start- the position at which to begin searching; the first position is 1
- Returns:
- the position at which the substring appears or -1 if it is not present; the first position is 1
- Throws:
- SQLException- if there is an error accessing the- CLOBvalue
 
- 
positionRetrieves the character position at which the specifiedClobobjectsearchstrappears in thisClobobject. The search begins at positionstart.- Specified by:
- positionin interface- Clob
- Parameters:
- searchstr- the- Clobobject for which to search
- start- the position at which to begin searching; the first position is 1
- Returns:
- the position at which the Clobobject appears or -1 if it is not present; the first position is 1
- Throws:
- SQLException- if there is an error accessing the- CLOBvalue
 
- 
setStringWrites the given JavaStringto theCLOBvalue that thisClobobject designates at the positionpos. Calling this method always throws anSQLException.- Specified by:
- setStringin interface- Clob
- Throws:
- SQLException
 
- 
setStringWriteslencharacters ofstr, starting at characteroffset, to theCLOBvalue that thisClobrepresents. Calling this method always throws anSQLException.- Specified by:
- setStringin interface- Clob
- Throws:
- SQLException
 
- 
setAsciiStreamRetrieves a stream to be used to write Ascii characters to theCLOBvalue that thisClobobject represents, starting at positionpos.Calling this method always throws an SQLException.- Specified by:
- setAsciiStreamin interface- Clob
- Throws:
- SQLException
 
- 
setCharacterStreamRetrieves a stream to be used to write a stream of Unicode characters to theCLOBvalue that thisClobobject represents, at positionpos.Calling this method always throws an SQLException.- Specified by:
- setCharacterStreamin interface- Clob
- Throws:
- SQLException
 
- 
truncateTruncates theCLOBvalue that thisClobdesignates to have a length oflencharacters.- Specified by:
- truncatein interface- Clob
- Throws:
- SQLException
 
- 
free- Specified by:
- freein interface- Clob
- Throws:
- SQLException
- Since:
- 3.0
 
- 
getCharacterStream- Specified by:
- getCharacterStreamin interface- Clob
- Throws:
- SQLException
- Since:
- 3.0
 
 
-