| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.cayenne.util.MemoryClob
public class MemoryClob
A Clob implementation that stores contents in memory.
This implementation is based on jdbcClob from HSQLDB (copyright HSQL Development Group).
| Constructor Summary | |
|---|---|
| MemoryClob(String data)Constructs a new jdbcClob object wrapping the given character sequence. | |
| Method Summary | |
|---|---|
|  void | free() | 
|  InputStream | getAsciiStream()Retrieves the CLOBvalue designated by thisClobobject as an ascii stream. | 
|  Reader | getCharacterStream()Retrieves the CLOBvalue designated by thisClobobject as ajava.io.Readerobject (or as a stream of characters). | 
|  Reader | getCharacterStream(long pos,
                   long length) | 
|  String | getSubString(long pos,
             int length)Retrieves a copy of the specified substring in the CLOBvalue
 designated by thisClobobject. | 
|  long | length()Retrieves the number of characters in the CLOBvalue designated by
 thisClobobject. | 
|  long | position(Clob searchstr,
         long start)Retrieves the character position at which the specified Clobobjectsearchstrappears in thisClobobject. | 
|  long | position(String searchstr,
         long start)Retrieves the character position at which the specified substring searchstrappears in the SQLCLOBvalue represented
 by thisClobobject. | 
|  OutputStream | setAsciiStream(long pos)Retrieves a stream to be used to write Ascii characters to the CLOBvalue that thisClobobject represents, starting at positionpos. | 
|  Writer | setCharacterStream(long pos)Retrieves a stream to be used to write a stream of Unicode characters to the CLOBvalue that thisClobobject represents, at
 positionpos. | 
|  int | setString(long pos,
          String str)Writes the given Java Stringto theCLOBvalue that
 thisClobobject designates at the positionpos. | 
|  int | setString(long pos,
          String str,
          int offset,
          int len)Writes lencharacters ofstr, starting at characteroffset, to theCLOBvalue that thisClobrepresents. | 
|  void | truncate(long len)Truncates the CLOBvalue that thisClobdesignates to
 have a length oflencharacters. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public MemoryClob(String data)
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.
data - the character sequence representing the Clob value
SQLException - if the argument is null| Method Detail | 
|---|
public long length()
            throws SQLException
CLOB value designated by
 this Clob object.
length in interface ClobCLOB in characters
SQLException - if there is an error accessing the length of the
                CLOB value
public String getSubString(long pos,
                           int length)
                    throws SQLException
CLOB value
 designated by this Clob object. The substring begins at position
 pos and has up to length consecutive characters.
getSubString in interface ClobSQLException
public Reader getCharacterStream()
                          throws SQLException
CLOB value designated by this Clob
 object as a java.io.Reader object (or as a stream of characters).
getCharacterStream in interface Clobjava.io.Reader object containing the CLOB
         data
SQLException - if there is an error accessing the CLOB
                value
public InputStream getAsciiStream()
                           throws SQLException
CLOB value designated by this Clob
 object as an ascii stream.
getAsciiStream in interface Clobjava.io.InputStream object containing the
         CLOB data
SQLException - if there is an error accessing the CLOB
                value
public long position(String searchstr,
                     long start)
              throws SQLException
searchstr appears in the SQL CLOB value represented
 by this Clob object. The search begins at position
 start.
position in interface Clobsearchstr - the substring for which to searchstart - the position at which to begin searching; the first position is 1
SQLException - if there is an error accessing the CLOB
                value
public long position(Clob searchstr,
                     long start)
              throws SQLException
Clob object
 searchstr appears in this Clob object. The search
 begins at position start.
position in interface Clobsearchstr - the Clob object for which to searchstart - the position at which to begin searching; the first position is 1
Clob object appears or -1 if it is
         not present; the first position is 1
SQLException - if there is an error accessing the CLOB
                value
public int setString(long pos,
                     String str)
              throws SQLException
String to the CLOB value that
 this Clob object designates at the position pos.
 Calling this method always throws an SQLException.
setString in interface ClobSQLException
public int setString(long pos,
                     String str,
                     int offset,
                     int len)
              throws SQLException
len characters of str, starting at character
 offset, to the CLOB value that this
 Clob represents. Calling this method always throws an
 SQLException.
setString in interface ClobSQLException
public OutputStream setAsciiStream(long pos)
                            throws SQLException
CLOB
 value that this Clob object represents, starting at position
 pos.
 
 Calling this method always throws an SQLException.
setAsciiStream in interface ClobSQLException
public Writer setCharacterStream(long pos)
                          throws SQLException
CLOB value that this Clob object represents, at
 position pos.
 
 Calling this method always throws an SQLException.
setCharacterStream in interface ClobSQLException
public void truncate(long len)
              throws SQLException
CLOB value that this Clob designates to
 have a length of len characters.
 
truncate in interface ClobSQLException
public void free()
          throws SQLException
free in interface ClobSQLException
public Reader getCharacterStream(long pos,
                                 long length)
                          throws SQLException
getCharacterStream in interface ClobSQLException| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||