|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Clob
The mapping in the JavaTM programming language
for the SQL CLOB type.
An SQL CLOB is a built-in type
that stores a Character Large Object as a column value in a row of
a database table.
By default drivers implement a Clob object using an SQL
locator(CLOB), which means that a Clob object
contains a logical pointer to the SQL CLOB data rather than
the data itself. A Clob object is valid for the duration
of the transaction in which it was created.
The Clob interface 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.
Methods in the interfaces ResultSet,
CallableStatement, and PreparedStatement, such as
getClob and setClob allow a programmer to
access an SQL CLOB value. In addition, this interface
has methods for updating a CLOB value.
| Method Summary | |
|---|---|
InputStream |
getAsciiStream()
Retrieves the CLOB value designated by this Clob
object as an ascii stream. |
Reader |
getCharacterStream()
Retrieves the CLOB value designated by this Clob
object as a java.io.Reader object (or as a stream of
characters). |
String |
getSubString(long pos,
int length)
Retrieves a copy of the specified substring in the CLOB value
designated by this Clob object. |
long |
length()
Retrieves the number of characters in the CLOB value
designated by this Clob object. |
long |
position(Clob searchstr,
long start)
Retrieves the character position at which the specified Clob object searchstr appears in this
Clob object. |
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. |
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. |
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,
String str)
Writes the given Java String to the CLOB
value that this Clob object designates at the position
pos. |
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. |
void |
truncate(long len)
Truncates the CLOB value that this Clob
designates to have a length of len
characters. |
| Method Detail |
|---|
long length()
throws SQLException
CLOB value
designated by this Clob object.
CLOB in characters
SQLException - if there is an error accessing the
length of the CLOB value
String getSubString(long pos,
int length)
throws SQLException
CLOB value
designated by this Clob object.
The substring begins at position
pos and has up to length consecutive
characters.
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
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
Reader getCharacterStream()
throws SQLException
CLOB value designated by this Clob
object as a java.io.Reader object (or as a stream of
characters).
java.io.Reader object containing the
CLOB data
SQLException - if there is an error accessing the
CLOB valuesetCharacterStream(long)
InputStream getAsciiStream()
throws SQLException
CLOB value designated by this Clob
object as an ascii stream.
java.io.InputStream object containing the
CLOB data
SQLException - if there is an error accessing the
CLOB valuesetAsciiStream(long)
long position(String searchstr,
long start)
throws SQLException
searchstr appears in the SQL CLOB value
represented by this Clob object. The search
begins at position start.
searchstr - 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
long position(Clob searchstr,
long start)
throws SQLException
Clob object searchstr appears in this
Clob object. The search begins at position
start.
searchstr - 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
int setString(long pos,
String str)
throws SQLException
String to the CLOB
value that this Clob object designates at the position
pos.
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 designates
SQLException - if there is an error accessing the
CLOB value
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.
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 written
SQLException - if there is an error accessing the
CLOB value
OutputStream setAsciiStream(long pos)
throws SQLException
CLOB value that this Clob object represents,
starting at position pos.
pos - the position at which to start writing to this
CLOB object
SQLException - if there is an error accessing the
CLOB valuegetAsciiStream()
Writer setCharacterStream(long pos)
throws SQLException
CLOB value that this Clob object
represents, at position pos.
pos - the position at which to start writing to the
CLOB value
SQLException - if there is an error accessing the
CLOB valuegetCharacterStream()
void truncate(long len)
throws SQLException
CLOB value that this Clob
designates to have a length of len
characters.
len - the length, in bytes, to which the CLOB value
should be truncated
SQLException - if there is an error accessing the
CLOB value
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.