java.sql
Interface Clob

All Known Implementing Classes:
SerialClob sample code for javax.sql.rowset.serial.SerialClob definition code for javax.sql.rowset.serial.SerialClob

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 sample code for java.sql.ResultSet definition code for java.sql.ResultSet , CallableStatement sample code for java.sql.CallableStatement definition code for java.sql.CallableStatement , and PreparedStatement sample code for java.sql.PreparedStatement definition code for java.sql.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.

Since:
1.2

Method Summary
 InputStream sample code for java.io.InputStream definition code for java.io.InputStream getAsciiStream sample code for java.sql.Clob.getAsciiStream() definition code for java.sql.Clob.getAsciiStream() ()
          Retrieves the CLOB value designated by this Clob object as an ascii stream.
 Reader sample code for java.io.Reader definition code for java.io.Reader getCharacterStream sample code for java.sql.Clob.getCharacterStream() definition code for java.sql.Clob.getCharacterStream() ()
          Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).
 String sample code for java.lang.String definition code for java.lang.String getSubString sample code for java.sql.Clob.getSubString(long, int) definition code for java.sql.Clob.getSubString(long, int) (long pos, int length)
          Retrieves a copy of the specified substring in the CLOB value designated by this Clob object.
 long length sample code for java.sql.Clob.length() definition code for java.sql.Clob.length() ()
          Retrieves the number of characters in the CLOB value designated by this Clob object.
 long position sample code for java.sql.Clob.position(java.sql.Clob, long) definition code for java.sql.Clob.position(java.sql.Clob, long) (Clob sample code for java.sql.Clob definition code for java.sql.Clob  searchstr, long start)
          Retrieves the character position at which the specified Clob object searchstr appears in this Clob object.
 long position sample code for java.sql.Clob.position(java.lang.String, long) definition code for java.sql.Clob.position(java.lang.String, long) (String sample code for java.lang.String definition code for 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.
 OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream setAsciiStream sample code for java.sql.Clob.setAsciiStream(long) definition code for java.sql.Clob.setAsciiStream(long) (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 sample code for java.io.Writer definition code for java.io.Writer setCharacterStream sample code for java.sql.Clob.setCharacterStream(long) definition code for java.sql.Clob.setCharacterStream(long) (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 sample code for java.sql.Clob.setString(long, java.lang.String) definition code for java.sql.Clob.setString(long, java.lang.String) (long pos, String sample code for java.lang.String definition code for java.lang.String  str)
          Writes the given Java String to the CLOB value that this Clob object designates at the position pos.
 int setString sample code for java.sql.Clob.setString(long, java.lang.String, int, int) definition code for java.sql.Clob.setString(long, java.lang.String, int, int) (long pos, String sample code for java.lang.String definition code for 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 truncate sample code for java.sql.Clob.truncate(long) definition code for java.sql.Clob.truncate(long) (long len)
          Truncates the CLOB value that this Clob designates to have a length of len characters.
 

Method Detail

length sample code for java.sql.Clob.length() definition code for java.sql.Clob.length()

long length()
            throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the number of characters in the CLOB value designated by this Clob object.

Returns:
length of the CLOB in characters
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the length of the CLOB value
Since:
1.2

getSubString sample code for java.sql.Clob.getSubString(long, int) definition code for java.sql.Clob.getSubString(long, int)

String sample code for java.lang.String definition code for java.lang.String  getSubString(long pos,
                    int length)
                    throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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.

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 the CLOB value designated by this Clob object
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2

getCharacterStream sample code for java.sql.Clob.getCharacterStream() definition code for java.sql.Clob.getCharacterStream()

Reader sample code for java.io.Reader definition code for java.io.Reader  getCharacterStream()
                          throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).

Returns:
a java.io.Reader object containing the CLOB data
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2
See Also:
setCharacterStream(long) sample code for java.sql.Clob.setCharacterStream(long) definition code for java.sql.Clob.setCharacterStream(long)

getAsciiStream sample code for java.sql.Clob.getAsciiStream() definition code for java.sql.Clob.getAsciiStream()

InputStream sample code for java.io.InputStream definition code for java.io.InputStream  getAsciiStream()
                           throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the CLOB value designated by this Clob object as an ascii stream.

Returns:
a java.io.InputStream object containing the CLOB data
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2
See Also:
setAsciiStream(long) sample code for java.sql.Clob.setAsciiStream(long) definition code for java.sql.Clob.setAsciiStream(long)

position sample code for java.sql.Clob.position(java.lang.String, long) definition code for java.sql.Clob.position(java.lang.String, long)

long position(String sample code for java.lang.String definition code for java.lang.String  searchstr,
              long start)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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
start - 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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2

position sample code for java.sql.Clob.position(java.sql.Clob, long) definition code for java.sql.Clob.position(java.sql.Clob, long)

long position(Clob sample code for java.sql.Clob definition code for java.sql.Clob  searchstr,
              long start)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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
start - 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 sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.2

setString sample code for java.sql.Clob.setString(long, java.lang.String) definition code for java.sql.Clob.setString(long, java.lang.String)

int setString(long pos,
              String sample code for java.lang.String definition code for java.lang.String  str)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Writes the given Java String to the CLOB value that this Clob object designates at the position pos.

Parameters:
pos - the position at which to start writing to the CLOB value that this Clob object represents
str - the string to be written to the CLOB value that this Clob designates
Returns:
the number of characters written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.4

setString sample code for java.sql.Clob.setString(long, java.lang.String, int, int) definition code for java.sql.Clob.setString(long, java.lang.String, int, int)

int setString(long pos,
              String sample code for java.lang.String definition code for java.lang.String  str,
              int offset,
              int len)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents.

Parameters:
pos - the position at which to start writing to this CLOB object
str - the string to be written to the CLOB value that this Clob object represents
offset - the offset into str to start reading the characters to be written
len - the number of characters to be written
Returns:
the number of characters written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.4

setAsciiStream sample code for java.sql.Clob.setAsciiStream(long) definition code for java.sql.Clob.setAsciiStream(long)

OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream  setAsciiStream(long pos)
                            throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves a stream to be used to write Ascii characters to the CLOB value that this Clob object represents, starting at position pos.

Parameters:
pos - the position at which to start writing to this CLOB object
Returns:
the stream to which ASCII encoded characters can be written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.4
See Also:
getAsciiStream() sample code for java.sql.Clob.getAsciiStream() definition code for java.sql.Clob.getAsciiStream()

setCharacterStream sample code for java.sql.Clob.setCharacterStream(long) definition code for java.sql.Clob.setCharacterStream(long)

Writer sample code for java.io.Writer definition code for java.io.Writer  setCharacterStream(long pos)
                          throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
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.

Parameters:
pos - the position at which to start writing to the CLOB value
Returns:
a stream to which Unicode encoded characters can be written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.4
See Also:
getCharacterStream() sample code for java.sql.Clob.getCharacterStream() definition code for java.sql.Clob.getCharacterStream()

truncate sample code for java.sql.Clob.truncate(long) definition code for java.sql.Clob.truncate(long)

void truncate(long len)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Truncates the CLOB value that this Clob designates to have a length of len characters.

Parameters:
len - the length, in bytes, to which the CLOB value should be truncated
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the CLOB value
Since:
1.4