Class MemoryClob
- All Implemented Interfaces:
Clob
This implementation is based on jdbcClob from HSQLDB (copyright HSQL Development Group).
- Since:
- 1.2
-
Constructor Summary
ConstructorsConstructorDescriptionMemoryClob(String data) Constructs a new jdbcClob object wrapping the given character sequence. -
Method Summary
Modifier and TypeMethodDescriptionvoidfree()Retrieves theCLOBvalue designated by thisClobobject as an ascii stream.Retrieves theCLOBvalue designated by thisClobobject as ajava.io.Readerobject (or as a stream of characters).getCharacterStream(long pos, long length) getSubString(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.longRetrieves the character position at which the specified substringsearchstrappears in the SQLCLOBvalue represented by thisClobobject.longRetrieves the character position at which the specifiedClobobjectsearchstrappears in thisClobobject.setAsciiStream(long pos) Retrieves a stream to be used to write Ascii characters to theCLOBvalue that thisClobobject represents, starting at positionpos.setCharacterStream(long pos) Retrieves a stream to be used to write a stream of Unicode characters to theCLOBvalue that thisClobobject represents, at positionpos.intWrites the given JavaStringto theCLOBvalue that thisClobobject designates at the positionpos.intWriteslencharacters ofstr, starting at characteroffset, to theCLOBvalue that thisClobrepresents.voidtruncate(long len) Truncates theCLOBvalue that thisClobdesignates to have a length oflencharacters.
-
Constructor Details
-
MemoryClob
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 Details
-
length
Retrieves the number of characters in theCLOBvalue designated by thisClobobject.- Specified by:
lengthin interfaceClob- Returns:
- length of the
CLOBin characters - Throws:
SQLException- if there is an error accessing the length of theCLOBvalue
-
getSubString
Retrieves a copy of the specified substring in theCLOBvalue designated by thisClobobject. The substring begins at positionposand has up tolengthconsecutive characters.- Specified by:
getSubStringin interfaceClob- Throws:
SQLException
-
getCharacterStream
Retrieves theCLOBvalue designated by thisClobobject as ajava.io.Readerobject (or as a stream of characters).- Specified by:
getCharacterStreamin interfaceClob- Returns:
- a
java.io.Readerobject containing theCLOBdata - Throws:
SQLException- if there is an error accessing theCLOBvalue
-
getAsciiStream
Retrieves theCLOBvalue designated by thisClobobject as an ascii stream.- Specified by:
getAsciiStreamin interfaceClob- Returns:
- a
java.io.InputStreamobject containing theCLOBdata - Throws:
SQLException- if there is an error accessing theCLOBvalue
-
position
Retrieves the character position at which the specified substringsearchstrappears in the SQLCLOBvalue represented by thisClobobject. The search begins at positionstart.- Specified by:
positionin 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 theCLOBvalue
-
position
Retrieves the character position at which the specifiedClobobjectsearchstrappears in thisClobobject. The search begins at positionstart.- Specified by:
positionin interfaceClob- Parameters:
searchstr- theClobobject for which to searchstart- 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 theCLOBvalue
-
setString
Writes the given JavaStringto theCLOBvalue that thisClobobject designates at the positionpos. Calling this method always throws anSQLException.- Specified by:
setStringin interfaceClob- Throws:
SQLException
-
setString
Writeslencharacters ofstr, starting at characteroffset, to theCLOBvalue that thisClobrepresents. Calling this method always throws anSQLException.- Specified by:
setStringin interfaceClob- Throws:
SQLException
-
setAsciiStream
Retrieves 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 interfaceClob- Throws:
SQLException
-
setCharacterStream
Retrieves 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 interfaceClob- Throws:
SQLException
-
truncate
Truncates theCLOBvalue that thisClobdesignates to have a length oflencharacters.- Specified by:
truncatein interfaceClob- Throws:
SQLException
-
free
- Specified by:
freein interfaceClob- Throws:
SQLException- Since:
- 3.0
-
getCharacterStream
- Specified by:
getCharacterStreamin interfaceClob- Throws:
SQLException- Since:
- 3.0
-