java.lang.Object
org.hsqldb.jdbc.JDBCClobClient
- All Implemented Interfaces:
Clob
A wrapper for HSQLDB ClobData objects.
Instances of this class are returned by calls to ResultSet methods.
- Since:
- HSQLDB 1.9.0
- Author:
- Fred Toussi (fredt@users dot sourceforge.net)
-
Constructor Summary
ConstructorsConstructorDescriptionJDBCClobClient
(org.hsqldb.SessionInterface session, org.hsqldb.types.ClobDataID clob) -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
free()
This method frees theClob
object and releases the resources that it holds.Retrieves theCLOB
value designated by thisClob
object as an ascii stream.Retrieves theCLOB
value designated by thisClob
object as ajava.io.Reader
object (or as a stream of characters).getCharacterStream
(long pos, long length) Returns aReader
object that contains a partialClob
value, starting with the character specified by pos, which is length characters in length.org.hsqldb.types.ClobDataID
getClob()
getSubString
(long pos, int length) Retrieves a copy of the specified substring in theCLOB
value designated by thisClob
object.boolean
isClosed()
long
length()
Retrieves the number of characters in theCLOB
value designated by thisClob
object.long
Retrieves the character position at which the specified substringsearchstr
appears in the SQLCLOB
value represented by thisClob
object.long
Retrieves the character position at which the specifiedClob
objectsearchstr
appears in thisClob
object.setAsciiStream
(long pos) Retrieves a stream to be used to write Ascii characters to theCLOB
value that thisClob
object represents, starting at positionpos
.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
Writes the given JavaString
to theCLOB
value that thisClob
object designates at the positionpos
.int
Writeslen
characters ofstr
, starting at characteroffset
, to theCLOB
value that thisClob
represents.void
setWritable
(JDBCResultSet result, int index) void
truncate
(long len) Truncates theCLOB
value that thisClob
designates to have a length oflen
characters.
-
Constructor Details
-
JDBCClobClient
public JDBCClobClient(org.hsqldb.SessionInterface session, org.hsqldb.types.ClobDataID clob)
-
-
Method Details
-
getAsciiStream
Retrieves theCLOB
value designated by thisClob
object as an ascii stream. The ascii stream consists of the low ordre bytes of UTF-16 characters in the clob. The question mark character is returnd for UTF-16 characters beyond the range of 8-bit ASCII.- Specified by:
getAsciiStream
in interfaceClob
- Returns:
- a
java.io.InputStream
object containing theCLOB
data - Throws:
SQLException
- if there is an error accessing theCLOB
value
-
getCharacterStream
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
-
getSubString
Retrieves a copy of the specified substring in theCLOB
value designated by thisClob
object.- Specified by:
getSubString
in interfaceClob
- Parameters:
pos
- the first character of the substring to be extracted. The first character is at position 1.length
- the number of consecutive characters to be copied- Returns:
- a
String
that is the specified substring in theCLOB
value designated by thisClob
object - Throws:
SQLException
- if there is an error accessing theCLOB
value
-
length
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
-
position
Retrieves the character position at which the specified substringsearchstr
appears in the SQLCLOB
value represented by thisClob
object.- 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
Retrieves the character position at which the specifiedClob
objectsearchstr
appears in thisClob
object.- 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
-
setAsciiStream
Retrieves a stream to be used to write Ascii characters to theCLOB
value that thisClob
object represents, starting at positionpos
. The bytes written to the OutputStream are stored verbatim in the clob as the low order bytes of UTF-16 characters.- Specified by:
setAsciiStream
in interfaceClob
- Parameters:
pos
- the position at which to start writing to thisCLOB
object- Returns:
- the stream to which ASCII encoded characters can be written
- Throws:
SQLException
- if there is an error accessing theCLOB
value
-
setCharacterStream
Retrieves a stream to be used to write a stream of Unicode characters to theCLOB
value that thisClob
object represents, at positionpos
.- Specified by:
setCharacterStream
in interfaceClob
- Parameters:
pos
- the position at which to start writing to theCLOB
value- Returns:
- a stream to which Unicode encoded characters can be written
- Throws:
SQLException
- if there is an error accessing theCLOB
value
-
setString
Writes the given JavaString
to theCLOB
value that thisClob
object designates at the positionpos
.- Specified by:
setString
in interfaceClob
- Parameters:
pos
- the position at which to start writing to theCLOB
value that thisClob
object representsstr
- the string to be written to theCLOB
value that thisClob
designates- Returns:
- the number of characters written
- Throws:
SQLException
- if there is an error accessing theCLOB
value
-
setString
Writeslen
characters ofstr
, starting at characteroffset
, to theCLOB
value that thisClob
represents.- Specified by:
setString
in interfaceClob
- Parameters:
pos
- the position at which to start writing to thisCLOB
objectstr
- the string to be written to theCLOB
value that thisClob
object representsoffset
- the offset intostr
to start reading the characters to be writtenlen
- the number of characters to be written- Returns:
- the number of characters written
- Throws:
SQLException
- if there is an error accessing theCLOB
value
-
truncate
Truncates theCLOB
value that thisClob
designates to have a length oflen
characters.- Specified by:
truncate
in interfaceClob
- Parameters:
len
- the length, in bytes, to which theCLOB
value should be truncated- Throws:
SQLException
- if there is an error accessing theCLOB
value
-
free
This method frees theClob
object and releases the resources that it holds. The object is invalid once thefree
method is called.After
free
has been called, any attempt to invoke a method other thanfree
will result in aSQLException
being thrown. Iffree
is called multiple times, the subsequent calls tofree
are treated as a no-op.- Specified by:
free
in interfaceClob
- Throws:
SQLException
- if an error occurs releasing the Clob's resourcesSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getCharacterStream
Returns aReader
object that contains a partialClob
value, starting with the character specified by pos, which is length characters in length.- Specified by:
getCharacterStream
in interfaceClob
- Parameters:
pos
- the offset to the first character of the partial value to be retrieved. The first character in the Clob is at position 1.length
- the length in characters of the partial value to be retrieved.- Returns:
Reader
through which the partialClob
value can be read.- Throws:
SQLException
- if pos is less than 1 or if pos is greater than the number of characters in theClob
or if pos + length is greater than the number of characters in theClob
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- JDK 1.6, HSQLDB 2.0
-
getClob
public org.hsqldb.types.ClobDataID getClob() -
isClosed
public boolean isClosed() -
setWritable
-
clearUpdates
public void clearUpdates()
-