| java.lang.Object
 org.hsqldb.jdbc.jdbcClob
| jdbcClob | | final public class jdbcClob implements Clob(Code) | | The mapping in the JavaTM programming
language for the SQL CLOB type.
Provides methods for getting the length of an SQL CLOB (Character Large
Object) value, for materializing a CLOB value on the client, and for
searching for a substring or CLOB object within a CLOB value.
HSQLDB-Specific Information:
Including 1.8.x, the HSQLDB driver does not implement Clob using an SQL
locator(CLOB). That is, an HSQLDB Clob object does not contain a logical
pointer to SQL CLOB data; rather it directly contains an immutable
representation of the data (a String object). As a result, an HSQLDB
Clob object itself is valid beyond the duration of the transaction in which
is was created, although it does not necessarily represent a corresponding
value on the database.
Currently, the interface methods for updating a CLOB value are
unsupported. However, the truncate method is supported for local use.
author:
boucherb@users
version:
1.7.2
since:
JDK 1.2, HSQLDB 1.7.2 |
| Constructor Summary | |
| public | jdbcClob(String data)
Constructs a new jdbcClob object wrapping the given character
sequence. |
| Method Summary | |
| public java.io.InputStream | getAsciiStream()
Retrieves the CLOB value designated by this
Clob object as an ascii stream. | | public 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). | | public String | getSubString(long pos, int length)
Retrieves a copy of the specified substring in the CLOB
value designated by this Clob object. | | public long | length()
Retrieves the number of characters in the CLOB value
designated by this Clob object. | | public long | position(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. | | public long | position(Clob searchstr, long start)
Retrieves the character position at which the specified
Clob object searchstr appears in this
Clob object. | | public 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. | | public 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. | | public int | setString(long pos, String str)
Writes the given Java String to the CLOB
value that this Clob object designates at the position
pos. | | public int | setString(long pos, String str, int offset, int len)
Writes len characters of str, starting
at character offset, to the CLOB value
that this Clob represents. | | public void | truncate(long len)
Truncates the CLOB value that this Clob
designates to have a length of len
characters. |
| jdbcClob | | public jdbcClob(String data) throws SQLException(Code) | | 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:
SQLException - if the argument is null |
| getCharacterStream | | public java.io.Reader getCharacterStream() throws SQLException(Code) | | Retrieves the CLOB value designated by this
Clob object as a java.io.Reader object
(or as a stream of characters).
a java.io.Reader object containing theCLOB data
exception:
SQLException - if there is an error accessing theCLOB value
See Also: jdbcClob.setCharacterStream
since:
JDK 1.2, HSQLDB 1.7.2 |
| getSubString | | public String getSubString(long pos, int length) throws SQLException(Code) | | Retrieves a copy of the specified substring in the CLOB
value designated by this Clob object. The substring begins
at position pos and has up to length
consecutive characters.
HSQLDB-Specific Information:
The official specification above is ambiguous in that it does not
precisely indicate the policy to be observed when
pos > this.length() - length. One policy would be to retrieve the
characters from pos to this.length(). Another would be to throw
an exception. HSQLDB observes the later policy.
Parameters:
pos - the first character of the substring to be extracted.The first character is at position 1.
Parameters:
length - the number of consecutive characters to be copied a String that is the specified substring inthe CLOB value designated by thisClob object
exception:
SQLException - if there is an error accessing theCLOB value
since:
JDK 1.2, HSQLDB 1.7.2 |
| length | | public long length() throws SQLException(Code) | | Retrieves the number of characters in the CLOB value
designated by this Clob object.
length of the CLOB in characters
exception:
SQLException - if there is an error accessing thelength of the CLOB value
since:
JDK 1.2, HSQLDB 1.7.2 |
| position | | public long position(String searchstr, long start) throws SQLException(Code) | | Retrieves the character position at which the specified substring
searchstr appears in the SQL CLOB value
represented by this Clob object. The search
begins at position start.
Parameters:
searchstr - the substring for which to search
Parameters:
start - the position at which to begin searching; thefirst position is 1 the position at which the substring appears or -1 if it is notpresent; the first position is 1
exception:
SQLException - if there is an error accessing theCLOB value
since:
JDK 1.2, HSQLDB 1.7.2 |
| position | | public long position(Clob searchstr, long start) throws SQLException(Code) | | Retrieves the character position at which the specified
Clob object searchstr appears in this
Clob object. The search begins at position
start.
Parameters:
searchstr - the Clob object for which to search
Parameters:
start - the position at which to begin searching; the firstposition is 1 the position at which the Clob object appearsor -1 if it is not present; the first position is 1
exception:
SQLException - if there is an error accessing theCLOB value
since:
JDK 1.2, HSQLDB 1.7.2 |
| setAsciiStream | | public java.io.OutputStream setAsciiStream(long pos) throws SQLException(Code) | | Retrieves a stream to be used to write Ascii characters to the
CLOB value that this Clob object represents,
starting at position pos.
HSQLDB-Specific Information:
HSLQDB 1.7.2 does not support this feature.
Calling this method always throws an SQLException.
Parameters:
pos - the position at which to start writing to thisCLOB object the stream to which ASCII encoded characters can be written
exception:
SQLException - if there is an error accessing theCLOB value
See Also: jdbcClob.getAsciiStream
since:
JDK 1.4, HSQLDB 1.7.2 |
| setCharacterStream | | public java.io.Writer setCharacterStream(long pos) throws SQLException(Code) | | 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.
HSQLDB-Specific Information:
HSLQDB 1.7.2 does not support this feature.
Calling this method always throws an SQLException.
Parameters:
pos - the position at which to start writing to theCLOB value a stream to which Unicode encoded characters can be written
exception:
SQLException - if there is an error accessing theCLOB value
See Also: jdbcClob.getCharacterStream
since:
JDK 1.4, HSQLDB 1.7.2 |
| setString | | public int setString(long pos, String str) throws SQLException(Code) | | Writes the given Java String to the CLOB
value that this Clob object designates at the position
pos.
HSQLDB-Specific Information:
HSLQDB 1.7.2 does not support this feature.
Calling this method always throws an SQLException.
Parameters:
pos - the position at which to start writing to theCLOB value that this Clob objectrepresents
Parameters:
str - the string to be written to the CLOBvalue that this Clob designates the number of characters written
exception:
SQLException - if there is an error accessing theCLOB value
since:
JDK 1.4, HSQLDB 1.7.2 |
| setString | | public int setString(long pos, String str, int offset, int len) throws SQLException(Code) | | Writes len characters of str, starting
at character offset, to the CLOB value
that this Clob represents.
HSQLDB-Specific Information:
HSLQDB 1.7.2 does not support this feature.
Calling this method always throws an SQLException.
Parameters:
pos - the position at which to start writing to thisCLOB object
Parameters:
str - the string to be written to the CLOBvalue that this Clob object represents
Parameters:
offset - the offset into str to start readingthe characters to be written
Parameters:
len - the number of characters to be written the number of characters written
exception:
SQLException - if there is an error accessing theCLOB value
since:
JDK 1.4, HSQLDB 1.7.2 |
| truncate | | public void truncate(long len) throws SQLException(Code) | | Truncates the CLOB value that this Clob
designates to have a length of len
characters.
HSQLDB-Specific Information:
This operation affects only the client-side value; it has no effect upon
the value as it is stored in the database.
Parameters:
len - the length, in bytes, to which the CLOB valueshould be truncated
exception:
SQLException - if there is an error accessing theCLOB value
since:
JDK 1.4, HSQLDB 1.7.2 |
|
|