public class JDBCClobClient
extends java.lang.Object
implements java.sql.Clob
Constructor and Description |
---|
JDBCClobClient(org.hsqldb.SessionInterface session,
org.hsqldb.types.ClobDataID clob) |
Modifier and Type | Method and Description |
---|---|
void |
clearUpdates() |
void |
free()
This method frees the
Clob object and releases the resources the resources
that it holds. |
java.io.InputStream |
getAsciiStream()
Retrieves the
CLOB value designated by this
Clob object as an ascii stream. |
java.io.Reader |
getCharacterStream()
Retrieves the
CLOB value designated by this
Clob object as a java.io.Reader object (or
as a stream of characters). |
java.io.Reader |
getCharacterStream(long pos,
long length)
Returns a
Reader object that contains a partial Clob value, starting
with the character specified by pos, which is length characters in length. |
org.hsqldb.types.ClobDataID |
getClob() |
java.lang.String |
getSubString(long pos,
int length)
Retrieves a copy of the specified substring in the
CLOB
value designated by this Clob object. |
boolean |
isClosed() |
long |
length()
Retrieves the number of characters in the
CLOB value
designated by this Clob object. |
long |
position(java.sql.Clob searchstr,
long start)
Retrieves the character position at which the specified
Clob object searchstr appears in this
Clob object. |
long |
position(java.lang.String searchstr,
long start)
Retrieves the character position at which the specified substring
searchstr appears in the SQL CLOB value
represented by this Clob object. |
java.io.OutputStream |
setAsciiStream(long pos)
Retrieves a stream to be used to write Ascii characters to the
CLOB value that this Clob object represents,
starting at position pos . |
java.io.Writer |
setCharacterStream(long pos)
Retrieves a stream to be used to write a stream of Unicode characters
to the
CLOB value that this Clob object
represents, at position pos . |
int |
setString(long pos,
java.lang.String str)
Writes the given Java
String to the CLOB
value that this Clob object designates at the position
pos . |
int |
setString(long pos,
java.lang.String str,
int offset,
int len)
Writes
len characters of str , starting at
character offset , to the CLOB value that
this Clob represents. |
void |
setWritable(JDBCResultSet result,
int index) |
void |
truncate(long len)
Truncates the
CLOB value that this Clob
designates to have a length of len characters. |
public JDBCClobClient(org.hsqldb.SessionInterface session, org.hsqldb.types.ClobDataID clob)
public java.io.InputStream getAsciiStream() throws java.sql.SQLException
CLOB
value designated by this
Clob
object as an ascii stream.getAsciiStream
in interface java.sql.Clob
java.io.InputStream
object containing the
CLOB
datajava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic java.io.Reader getCharacterStream() throws java.sql.SQLException
CLOB
value designated by this
Clob
object as a java.io.Reader
object (or
as a stream of characters).getCharacterStream
in interface java.sql.Clob
java.io.Reader
object containing the
CLOB
datajava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic java.lang.String getSubString(long pos, int length) throws java.sql.SQLException
CLOB
value designated by this Clob
object.getSubString
in interface java.sql.Clob
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 copiedString
that is the specified substring in the
CLOB
value designated by this Clob
objectjava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic long length() throws java.sql.SQLException
CLOB
value
designated by this Clob
object.length
in interface java.sql.Clob
CLOB
in charactersjava.sql.SQLException
- if there is an error accessing the length of the
CLOB
valuepublic long position(java.lang.String searchstr, long start) throws java.sql.SQLException
searchstr
appears in the SQL CLOB
value
represented by this Clob
object.position
in interface java.sql.Clob
searchstr
- the substring for which to searchstart
- the position at which to begin searching; the first
position is 1java.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic long position(java.sql.Clob searchstr, long start) throws java.sql.SQLException
Clob
object searchstr
appears in this
Clob
object.position
in interface java.sql.Clob
searchstr
- the Clob
object for which to searchstart
- the position at which to begin searching; the first
position is 1Clob
object appears or
-1 if it is not present; the first position is 1java.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic java.io.OutputStream setAsciiStream(long pos) throws java.sql.SQLException
CLOB
value that this Clob
object represents,
starting at position pos
.setAsciiStream
in interface java.sql.Clob
pos
- the position at which to start writing to this
CLOB
objectjava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic java.io.Writer setCharacterStream(long pos) throws java.sql.SQLException
CLOB
value that this Clob
object
represents, at position pos
.setCharacterStream
in interface java.sql.Clob
pos
- the position at which to start writing to the
CLOB
valuejava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic int setString(long pos, java.lang.String str) throws java.sql.SQLException
String
to the CLOB
value that this Clob
object designates at the position
pos
.setString
in interface java.sql.Clob
pos
- the position at which to start writing to the
CLOB
value that this Clob
object
representsstr
- the string to be written to the CLOB
value
that this Clob
designatesjava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic int setString(long pos, java.lang.String str, int offset, int len) throws java.sql.SQLException
len
characters of str
, starting at
character offset
, to the CLOB
value that
this Clob
represents.setString
in interface java.sql.Clob
pos
- the position at which to start writing to this
CLOB
objectstr
- the string to be written to the CLOB
value
that this Clob
object representsoffset
- the offset into str
to start reading the
characters to be writtenlen
- the number of characters to be writtenjava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic void truncate(long len) throws java.sql.SQLException
CLOB
value that this Clob
designates to have a length of len
characters.truncate
in interface java.sql.Clob
len
- the length, in bytes, to which the CLOB
value
should be truncatedjava.sql.SQLException
- if there is an error accessing the
CLOB
valuepublic void free() throws java.sql.SQLException
Clob
object and releases the resources the resources
that it holds. The object is invalid once the free
method
is called.
After free
has been called, any attempt to invoke a
method other than free
will result in a SQLException
being thrown. If free
is called multiple times, the subsequent
calls to free
are treated as a no-op.
free
in interface java.sql.Clob
java.sql.SQLException
- if an error occurs releasing
the Clob's resourcesjava.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic java.io.Reader getCharacterStream(long pos, long length) throws java.sql.SQLException
Reader
object that contains a partial Clob
value, starting
with the character specified by pos, which is length characters in length.getCharacterStream
in interface java.sql.Clob
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.Reader
through which the partial Clob
value can be read.java.sql.SQLException
- if pos is less than 1 or if pos is greater than the number of
characters in the Clob
or if pos + length is greater than the number of
characters in the Clob
java.sql.SQLFeatureNotSupportedException
- if the JDBC driver does not support
this methodpublic org.hsqldb.types.ClobDataID getClob()
public boolean isClosed()
public void setWritable(JDBCResultSet result, int index)
public void clearUpdates()
Copyright © 2001 - 2017 HSQL Development Group.