<html> <head> <title>Interface XClob</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XClob-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdbc</a> :: </p> </td> </tr> <tr> <td class="title">interface XClob</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is the mapping for the SQL <code>CLOB</code> type. </dd> <dd><p> A SQL <code>CLOB</code> 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 <code>Clob</code> object using a SQL <code>locator(CLOB)</code> , which means that a <code>Clob</code> object contains a logical pointer to the SQL <code>CLOB</code> data rather than the data itself. A <code>Clob</code> object is valid for the duration of the transaction in which it was created. </p> <p> The <code>Clob</code> interface provides methods for getting the length of a SQL <code>CLOB</code> (Character Large Object) value, for materializing a <code>CLOB</code> value on the client, and for searching for a substring or <code>CLOB</code> object within a <code>CLOB</code> value. </p> <p> Methods in the interfaces <a href="XResultSet.html">XResultSet</a> , and <a href="XPreparedStatement.html">XPreparedStatement</a> , such as <code>getClob</code> and <code>setClob</code> allow a programmer to access the SQL <code>CLOB</code> . </p> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#length">length</a></td> <td class="imsum_right">returns the number of characters in the <code>CLOB</code> value designated by this <code>Clob</code> object. </td> </tr> <tr> <td class="imsum_left"><a href="#getSubString">getSubString</a></td> <td class="imsum_right">returns a copy of the specified substring in the <code>Clob</code> value designated by this <code>Clob</code> object. </td> </tr> <tr> <td class="imsum_left"><a href="#getCharacterStream">getCharacterStream</a></td> <td class="imsum_right">gets the <code>Clob</code> contents as a stream. </td> </tr> <tr> <td class="imsum_left"><a href="#position">position</a></td> <td class="imsum_right">determines the character position at which the specified substring <code>searchstr</code> appears in the <code>Clob</code> . The search begins at position <code>start</code> . </td> </tr> <tr> <td class="imsum_left"><a href="#positionOfClob">positionOfClob</a></td> <td class="imsum_right">determines the position at which the specified <code>Clob</code> object <code>pattern</code> appears in this <code>Clob</code> object. The search begins at position <code>start</code> . </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="length" class="membertitle">length</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">hyper</td> </tr> <tr> <td valign="top"><b>length</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the number of characters in the <code>CLOB</code> value designated by this <code>Clob</code> object. </dd> <dt><b>Returns</b></dt> <dd>the length of the CLOB object </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSubString" class="membertitle">getSubString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getSubString</b>(</td> <td valign="top">[in] hyper</td> <td valign="bottom"> pos,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> length )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a copy of the specified substring in the <code>Clob</code> value designated by this <code>Clob</code> object. </dd> <dd><p> The substring begins at position <code>pos</code> and has up to <code>length</code> consecutive characters. </p> </dd> <dt><b>Parameter pos</b></dt> <dd>the starting position </dd> <dt><b>Parameter length</b></dt> <dd>the length of the substring </dd> <dt><b>Returns</b></dt> <dd>the substring </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCharacterStream" class="membertitle">getCharacterStream</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td> </tr> <tr> <td valign="top"><b>getCharacterStream</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the <code>Clob</code> contents as a stream. </dd> <dt><b>Returns</b></dt> <dd>the stream </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="position" class="membertitle">position</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">hyper</td> </tr> <tr> <td valign="top"><b>position</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> searchstr,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> start )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines the character position at which the specified substring <code>searchstr</code> appears in the <code>Clob</code> . The search begins at position <code>start</code> . </dd> <dt><b>Parameter searchstr</b></dt> <dd>the string to search </dd> <dt><b>Parameter start</b></dt> <dd>the starting position </dd> <dt><b>Returns</b></dt> <dd>the length of the CLOB object </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="positionOfClob" class="membertitle">positionOfClob</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">hyper</td> </tr> <tr> <td valign="top"><b>positionOfClob</b>(</td> <td valign="top">[in] <a href="XClob.html">XClob</a></td> <td valign="bottom"> pattern,</td> </tr> <tr> <td/><td valign="top">[in] hyper</td> <td valign="bottom"> start )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="SQLException.html">SQLException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines the position at which the specified <code>Clob</code> object <code>pattern</code> appears in this <code>Clob</code> object. The search begins at position <code>start</code> . </dd> <dt><b>Parameter pattern</b></dt> <dd>the CLOB to search </dd> <dt><b>Parameter start</b></dt> <dd>the starting position </dd> <dt><b>Returns</b></dt> <dd>the position of the CLOB inside </dd> <dt><b>Throws</b></dt> <dd>SQLException if a database access error occurs. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
