Package org.apache.cayenne.util
Class MemoryClob
- java.lang.Object
-
- org.apache.cayenne.util.MemoryClob
-
-
Constructor Summary
Constructors Constructor Description MemoryClob(String data)
Constructs a new jdbcClob object wrapping the given character sequence.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
free()
InputStream
getAsciiStream()
Retrieves theCLOB
value designated by thisClob
object as an ascii stream.Reader
getCharacterStream()
Retrieves theCLOB
value designated by thisClob
object as ajava.io.Reader
object (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 theCLOB
value designated by thisClob
object.long
length()
Retrieves the number of characters in theCLOB
value designated by thisClob
object.long
position(String searchstr, long start)
Retrieves the character position at which the specified substringsearchstr
appears in the SQLCLOB
value represented by thisClob
object.long
position(Clob searchstr, long start)
Retrieves the character position at which the specifiedClob
objectsearchstr
appears in thisClob
object.OutputStream
setAsciiStream(long pos)
Retrieves a stream to be used to write Ascii characters to theCLOB
value that thisClob
object represents, starting at positionpos
.Writer
setCharacterStream(long pos)
Retrieves a stream to be used to write a stream of Unicode characters to theCLOB
value that thisClob
object represents, at positionpos
.int
setString(long pos, String str)
Writes the given JavaString
to theCLOB
value that thisClob
object designates at the positionpos
.int
setString(long pos, String str, int offset, int len)
Writeslen
characters ofstr
, starting at characteroffset
, to theCLOB
value that thisClob
represents.void
truncate(long len)
Truncates theCLOB
value that thisClob
designates to have a length oflen
characters.
-
-
-
Constructor Detail
-
MemoryClob
public MemoryClob(String data)
Constructs 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 Detail
-
length
public long length() throws SQLException
Retrieves the number of characters in theCLOB
value designated by thisClob
object.- Specified by:
length
in interfaceClob
- Returns:
- length of the
CLOB
in characters - Throws:
SQLException
- if there is an error accessing the length of theCLOB
value
-
getSubString
public String getSubString(long pos, int length) throws SQLException
Retrieves a copy of the specified substring in theCLOB
value designated by thisClob
object. The substring begins at positionpos
and has up tolength
consecutive characters.- Specified by:
getSubString
in interfaceClob
- Throws:
SQLException
-
getCharacterStream
public Reader getCharacterStream() throws SQLException
Retrieves theCLOB
value designated by thisClob
object as ajava.io.Reader
object (or as a stream of characters).- Specified by:
getCharacterStream
in interfaceClob
- Returns:
- a
java.io.Reader
object containing theCLOB
data - Throws:
SQLException
- if there is an error accessing theCLOB
value
-
getAsciiStream
public InputStream getAsciiStream() throws SQLException
Retrieves theCLOB
value designated by thisClob
object as an ascii stream.- Specified by:
getAsciiStream
in interfaceClob
- Returns:
- a
java.io.InputStream
object containing theCLOB
data - Throws:
SQLException
- if there is an error accessing theCLOB
value
-
position
public long position(String searchstr, long start) throws SQLException
Retrieves the character position at which the specified substringsearchstr
appears in the SQLCLOB
value represented by thisClob
object. The search begins at positionstart
.- Specified by:
position
in interfaceClob
- Parameters:
searchstr
- the substring for which to searchstart
- 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 theCLOB
value
-
position
public long position(Clob searchstr, long start) throws SQLException
Retrieves the character position at which the specifiedClob
objectsearchstr
appears in thisClob
object. The search begins at positionstart
.- Specified by:
position
in interfaceClob
- Parameters:
searchstr
- theClob
object for which to searchstart
- the position at which to begin searching; the first position is 1- Returns:
- the position at which the
Clob
object appears or -1 if it is not present; the first position is 1 - Throws:
SQLException
- if there is an error accessing theCLOB
value
-
setString
public int setString(long pos, String str) throws SQLException
Writes the given JavaString
to theCLOB
value that thisClob
object designates at the positionpos
. Calling this method always throws anSQLException
.- Specified by:
setString
in interfaceClob
- Throws:
SQLException
-
setString
public int setString(long pos, String str, int offset, int len) throws SQLException
Writeslen
characters ofstr
, starting at characteroffset
, to theCLOB
value that thisClob
represents. Calling this method always throws anSQLException
.- Specified by:
setString
in interfaceClob
- Throws:
SQLException
-
setAsciiStream
public OutputStream setAsciiStream(long pos) throws SQLException
Retrieves a stream to be used to write Ascii characters to theCLOB
value that thisClob
object represents, starting at positionpos
.Calling this method always throws an
SQLException
.- Specified by:
setAsciiStream
in interfaceClob
- Throws:
SQLException
-
setCharacterStream
public Writer setCharacterStream(long pos) throws SQLException
Retrieves a stream to be used to write a stream of Unicode characters to theCLOB
value that thisClob
object represents, at positionpos
.Calling this method always throws an
SQLException
.- Specified by:
setCharacterStream
in interfaceClob
- Throws:
SQLException
-
truncate
public void truncate(long len) throws SQLException
Truncates theCLOB
value that thisClob
designates to have a length oflen
characters.- Specified by:
truncate
in interfaceClob
- Throws:
SQLException
-
free
public void free() throws SQLException
- Specified by:
free
in interfaceClob
- Throws:
SQLException
- Since:
- 3.0
-
getCharacterStream
public Reader getCharacterStream(long pos, long length) throws SQLException
- Specified by:
getCharacterStream
in interfaceClob
- Throws:
SQLException
- Since:
- 3.0
-
-