Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: sdbc ::
interface XClob
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XClob
Description is the mapping for the SQL `CLOB` type. A SQL `CLOB` is a built-in type that stores a Character Large Object as a column value in a row of a database table. The driver implements a `Clob` object using a 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 a 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 XResultSet , and XPreparedStatement , such as `getClob` and `setClob` allow a programmer to access the SQL `CLOB` .

Methods' Summary
length | returns the number of characters in the `CLOB` value designated by this `Clob` object.
getSubString | returns a copy of the specified substring in the `Clob` value designated by this `Clob` object.
getCharacterStream | gets the `Clob` contents as a stream.
position | determines the character position at which the specified substring `searchstr` appears in the `Clob` . The search begins at position `start` .
positionOfClob | determines the position at which the specified `Clob` object `pattern` appears in this `Clob` object. The search begins at position `start` .

Methods' Details
length
hyper length() | raises( | SQLException );
Description returns the number of characters in the `CLOB` value designated by this `Clob` object. Returns the length of the CLOB object Throws SQLException if a database access error occurs.
getSubString
string getSubString( | [in] hyper [in] long raises( | pos, length ) SQLException );
Description returns 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. Parameter pos the starting position Parameter length the length of the substring Returns the substring Throws SQLException if a database access error occurs.
getCharacterStream
::com::sun::star::io::XInputStream getCharacterStream() | raises( | SQLException );
Description gets the `Clob` contents as a stream. Returns the stream Throws SQLException if a database access error occurs.
position
hyper position( | [in] string [in] long raises( | searchstr, start ) SQLException );
Description determines the character position at which the specified substring `searchstr` appears in the `Clob` . The search begins at position `start` . Parameter searchstr the string to search Parameter start the starting position Returns the length of the CLOB object Throws SQLException if a database access error occurs.
positionOfClob
hyper positionOfClob( | [in] XClob [in] hyper raises( | pattern, start ) SQLException );
Description determines the position at which the specified `Clob` object `pattern` appears in this `Clob` object. The search begins at position `start` . Parameter pattern the CLOB to search Parameter start the starting position Returns the position of the CLOB inside Throws SQLException if a database access error occurs.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.