Added in API level 9

NClob

interface NClob : Clob

java.sql.NClob

The mapping in the JavaTM programming language for the SQL NCLOB type. An SQL NCLOB is a built-in type that stores a Character Large Object using the National Character Set as a column value in a row of a database table.

The NClob interface extends the Clob interface which provides provides methods for getting the length of an SQL NCLOB value, for materializing a NCLOB value on the client, and for searching for a substring or NCLOB object within a NCLOB value. A NClob object, just like a Clob object, is valid for the duration of the transaction in which it was created. Methods in the interfaces ResultSet, CallableStatement, and PreparedStatement, such as getNClob and setNClob allow a programmer to access an SQL NCLOB value. In addition, this interface has methods for updating a NCLOB value.

All methods on the NClob interface must be fully implemented if the JDBC driver supports the data type.

Summary

Inherited functions

From class Clob Unit free() This method frees the 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. 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). Reader! getCharacterStream(pos: Long, length: Long) Returns a Reader object that contains a partial Clob value, starting with the character specified by pos, which is length characters in length. String! getSubString(pos: Long, length: Int) 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. Long length() Retrieves the number of characters in the CLOB value designated by this Clob object. Long position(searchstr: String!, start: Long) 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. Long position(searchstr: Clob!, start: Long) Retrieves the character position at which the specified Clob object searchstr appears in this Clob object. The search begins at position start. OutputStream! setAsciiStream(pos: Long) Retrieves a stream to be used to write Ascii characters to the CLOB value that this Clob object represents, starting at position pos. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accomodate the extra characters. Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. Writer! setCharacterStream(pos: Long) 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. Characters written to the stream will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing characters to the stream, then the length of the Clob value will be increased to accomodate the extra characters. Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. Int setString(pos: Long, str: String!) Writes the given Java String to the CLOB value that this Clob object designates at the position pos. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accomodate the extra characters. Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. Int setString(pos: Long, str: String!, offset: Int, len: Int) Writes len characters of str, starting at character offset, to the CLOB value that this Clob represents. The string will overwrite the existing characters in the Clob object starting at the position pos. If the end of the Clob value is reached while writing the given string, then the length of the Clob value will be increased to accomodate the extra characters. Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. Unit truncate(len: Long) Truncates the CLOB value that this Clob designates to have a length of len characters. Note: If the value specified for pos is greater then the length+1 of the CLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation.