| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.hsqldb.jdbc.JDBCClobClient
public class JDBCClobClient
A wrapper for HSQLDB ClobData objects. Instances of this class are returned by calls to ResultSet methods.
| Constructor Summary | |
|---|---|
| JDBCClobClient(org.hsqldb.SessionInterface session,
               org.hsqldb.types.ClobDataID clob) | |
| Method Summary | |
|---|---|
|  void | clearUpdates() | 
|  void | free()This method frees the Clobobject and releases the resources the resources
 that it holds. | 
|  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)Returns a Readerobject that contains a partialClobvalue, starting
 with the character specified by pos, which is length characters in length. | 
|  org.hsqldb.types.ClobDataID | getClob() | 
|  String | getSubString(long pos,
             int length)Retrieves a copy of the specified substring in the CLOBvalue designated by thisClobobject. | 
|  boolean | isClosed() | 
|  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 | setWritable(JDBCResultSet result,
            int index) | 
|  void | truncate(long len)Truncates the CLOBvalue that thisClobdesignates to have a length oflencharacters. | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public JDBCClobClient(org.hsqldb.SessionInterface session,
                      org.hsqldb.types.ClobDataID clob)
| Method Detail | 
|---|
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 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 String getSubString(long pos,
                           int length)
                    throws SQLException
CLOB
 value designated by this Clob object.
getSubString in interface Clobpos - 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
String that is the specified substring in the
   CLOB value designated by this Clob object
SQLException - if there is an error accessing the
   CLOB value
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 long position(String searchstr,
                     long start)
              throws SQLException
searchstr appears in the SQL CLOB value
 represented by this Clob object.
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.
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 OutputStream setAsciiStream(long pos)
                            throws SQLException
CLOB value that this Clob object represents,
 starting at position pos.
setAsciiStream in interface Clobpos - the position at which to start writing to this
   CLOB object
SQLException - if there is an error accessing the
   CLOB value
public Writer setCharacterStream(long pos)
                          throws SQLException
CLOB value that this Clob object
 represents, at position pos.
setCharacterStream in interface Clobpos - the position at which to start writing to the
   CLOB value
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.
setString in interface Clobpos - 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 designates
SQLException - if there is an error accessing the
   CLOB value
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.
setString in interface Clobpos - 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 written
SQLException - if there is an error accessing the
   CLOB value
public void truncate(long len)
              throws SQLException
CLOB value that this Clob
 designates to have a length of len characters.
truncate in interface Cloblen - the length, in bytes, to which the CLOB value
   should be truncated
SQLException - if there is an error accessing the
   CLOB value
public void free()
          throws 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 ClobSQLException - if an error occurs releasing
 the Clob's resources
SQLFeatureNotSupportedException - if the JDBC driver does not support
 this method
public Reader getCharacterStream(long pos,
                                 long length)
                          throws 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 Clobpos - 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.
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
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()
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||