FileDocCategorySizeDatePackage
Clob.javaAPI DocJava SE 5 API8507Fri Aug 26 14:57:18 BST 2005java.sql

Clob

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 {@link ResultSet}, {@link CallableStatement}, and {@link 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

Fields Summary
Constructors Summary
Methods Summary
public java.io.InputStreamgetAsciiStream()
Retrieves the CLOB value designated by this Clob object as an ascii stream.

return
a java.io.InputStream object containing the CLOB data
exception
SQLException if there is an error accessing the CLOB value
see
#setAsciiStream
since
1.2

public java.io.ReadergetCharacterStream()
Retrieves the CLOB value designated by this Clob object as a java.io.Reader object (or as a stream of characters).

return
a java.io.Reader object containing the CLOB data
exception
SQLException if there is an error accessing the CLOB value
see
#setCharacterStream
since
1.2

public java.lang.StringgetSubString(long pos, int length)
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.

param
pos the first character of the substring to be extracted. The first character is at position 1.
param
length the number of consecutive characters to be copied
return
a String that is the specified substring in the CLOB value designated by this Clob object
exception
SQLException if there is an error accessing the CLOB value
since
1.2

public longlength()
Retrieves the number of characters in the CLOB value designated by this Clob object.

return
length of the CLOB in characters
exception
SQLException if there is an error accessing the length of the CLOB value
since
1.2

public longposition(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. The search begins at position start.

param
searchstr the substring for which to search
param
start the position at which to begin searching; the first position is 1
return
the position at which the substring appears or -1 if it is not present; the first position is 1
exception
SQLException if there is an error accessing the CLOB value
since
1.2

public longposition(java.sql.Clob searchstr, long start)
Retrieves the character position at which the specified Clob object searchstr appears in this Clob object. The search begins at position start.

param
searchstr the Clob object for which to search
param
start the position at which to begin searching; the first position is 1
return
the position at which the Clob object appears or -1 if it is not present; the first position is 1
exception
SQLException if there is an error accessing the CLOB value
since
1.2

public java.io.OutputStreamsetAsciiStream(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.

param
pos the position at which to start writing to this CLOB object
return
the stream to which ASCII encoded characters can be written
exception
SQLException if there is an error accessing the CLOB value
see
#getAsciiStream
since
1.4

public java.io.WritersetCharacterStream(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.

param
pos the position at which to start writing to the CLOB value
return
a stream to which Unicode encoded characters can be written
exception
SQLException if there is an error accessing the CLOB value
see
#getCharacterStream
since
1.4

public intsetString(long pos, java.lang.String str)
Writes the given Java String to the CLOB value that this Clob object designates at the position pos.

param
pos the position at which to start writing to the CLOB value that this Clob object represents
param
str the string to be written to the CLOB value that this Clob designates
return
the number of characters written
exception
SQLException if there is an error accessing the CLOB value
since
1.4

public intsetString(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.

param
pos the position at which to start writing to this CLOB object
param
str the string to be written to the CLOB value that this Clob object represents
param
offset the offset into str to start reading the characters to be written
param
len the number of characters to be written
return
the number of characters written
exception
SQLException if there is an error accessing the CLOB value
since
1.4

public voidtruncate(long len)
Truncates the CLOB value that this Clob designates to have a length of len characters.

param
len the length, in bytes, to which the CLOB value should be truncated
exception
SQLException if there is an error accessing the CLOB value
since
1.4