<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Mon Oct 21 11:07:38 UTC 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>JDBCClobClient (HSQLDB 2.2.9 API)</title>
<meta name="date" content="2013-10-21">
<link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JDBCClobClient (HSQLDB 2.2.9 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JDBCClobClient.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/hsqldb/jdbc/JDBCClob.html" title="class in org.hsqldb.jdbc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hsqldb/jdbc/JDBCClobFile.html" title="class in org.hsqldb.jdbc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hsqldb/jdbc/JDBCClobClient.html" target="_top">Frames</a></li>
<li><a href="JDBCClobClient.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.hsqldb.jdbc</div>
<h2 title="Class JDBCClobClient" class="title">Class JDBCClobClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.hsqldb.jdbc.JDBCClobClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.sql.Clob</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">JDBCClobClient</span>
extends java.lang.Object
implements java.sql.Clob</pre>
<div class="block">A wrapper for HSQLDB ClobData objects.
Instances of this class are returned by calls to ResultSet methods.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>JDK 1.2, HSQLDB 1.9.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Fred Toussi (fredt@users dot sourceforge.net)</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#JDBCClobClient(org.hsqldb.SessionInterface, org.hsqldb.types.ClobDataID)">JDBCClobClient</a></strong>(org.hsqldb.SessionInterface session,
org.hsqldb.types.ClobDataID clob)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#clearUpdates()">clearUpdates</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#free()">free</a></strong>()</code>
<div class="block">This method frees the <code>Clob</code> object and releases the resources the resources
that it holds.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.InputStream</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#getAsciiStream()">getAsciiStream</a></strong>()</code>
<div class="block">Retrieves the <code>CLOB</code> value designated by this
<code>Clob</code> object as an ascii stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.Reader</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#getCharacterStream()">getCharacterStream</a></strong>()</code>
<div class="block">Retrieves the <code>CLOB</code> value designated by this
<code>Clob</code> object as a <code>java.io.Reader</code> object (or
as a stream of characters).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.Reader</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#getCharacterStream(long, long)">getCharacterStream</a></strong>(long pos,
long length)</code>
<div class="block">Returns a <code>Reader</code> object that contains a partial <code>Clob</code> value, starting
with the character specified by pos, which is length characters in length.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.hsqldb.types.ClobDataID</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#getClob()">getClob</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#getSubString(long, int)">getSubString</a></strong>(long pos,
int length)</code>
<div class="block">Retrieves a copy of the specified substring in the <code>CLOB</code>
value designated by this <code>Clob</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#isClosed()">isClosed</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#length()">length</a></strong>()</code>
<div class="block">Retrieves the number of characters in the <code>CLOB</code> value
designated by this <code>Clob</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#position(java.sql.Clob, long)">position</a></strong>(java.sql.Clob searchstr,
long start)</code>
<div class="block">Retrieves the character position at which the specified
<code>Clob</code> object <code>searchstr</code> appears in this
<code>Clob</code> object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#position(java.lang.String, long)">position</a></strong>(java.lang.String searchstr,
long start)</code>
<div class="block">Retrieves the character position at which the specified substring
<code>searchstr</code> appears in the SQL <code>CLOB</code> value
represented by this <code>Clob</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.io.OutputStream</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#setAsciiStream(long)">setAsciiStream</a></strong>(long pos)</code>
<div class="block">Retrieves a stream to be used to write Ascii characters to the
<code>CLOB</code> value that this <code>Clob</code> object represents,
starting at position <code>pos</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.Writer</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#setCharacterStream(long)">setCharacterStream</a></strong>(long pos)</code>
<div class="block">Retrieves a stream to be used to write a stream of Unicode characters
to the <code>CLOB</code> value that this <code>Clob</code> object
represents, at position <code>pos</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#setString(long, java.lang.String)">setString</a></strong>(long pos,
java.lang.String str)</code>
<div class="block">Writes the given Java <code>String</code> to the <code>CLOB</code>
value that this <code>Clob</code> object designates at the position
<code>pos</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#setString(long, java.lang.String, int, int)">setString</a></strong>(long pos,
java.lang.String str,
int offset,
int len)</code>
<div class="block">Writes <code>len</code> characters of <code>str</code>, starting at
character <code>offset</code>, to the <code>CLOB</code> value that
this <code>Clob</code> represents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#setWritable(org.hsqldb.jdbc.JDBCResultSet, int)">setWritable</a></strong>(<a href="../../../org/hsqldb/jdbc/JDBCResultSet.html" title="class in org.hsqldb.jdbc">JDBCResultSet</a> result,
int index)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/hsqldb/jdbc/JDBCClobClient.html#truncate(long)">truncate</a></strong>(long len)</code>
<div class="block">Truncates the <code>CLOB</code> value that this <code>Clob</code>
designates to have a length of <code>len</code> characters.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JDBCClobClient(org.hsqldb.SessionInterface, org.hsqldb.types.ClobDataID)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JDBCClobClient</h4>
<pre>public JDBCClobClient(org.hsqldb.SessionInterface session,
org.hsqldb.types.ClobDataID clob)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAsciiStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAsciiStream</h4>
<pre>public java.io.InputStream getAsciiStream()
throws java.sql.SQLException</pre>
<div class="block">Retrieves the <code>CLOB</code> value designated by this
<code>Clob</code> object as an ascii stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getAsciiStream</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>java.io.InputStream</code> object containing the
<code>CLOB</code> data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="getCharacterStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharacterStream</h4>
<pre>public java.io.Reader getCharacterStream()
throws java.sql.SQLException</pre>
<div class="block">Retrieves the <code>CLOB</code> value designated by this
<code>Clob</code> object as a <code>java.io.Reader</code> object (or
as a stream of characters).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getCharacterStream</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>java.io.Reader</code> object containing the
<code>CLOB</code> data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="getSubString(long, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubString</h4>
<pre>public java.lang.String getSubString(long pos,
int length)
throws java.sql.SQLException</pre>
<div class="block">Retrieves a copy of the specified substring in the <code>CLOB</code>
value designated by this <code>Clob</code> object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getSubString</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the first character of the substring to be extracted. The
first character is at position 1.</dd><dd><code>length</code> - the number of consecutive characters to be copied</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> that is the specified substring in the
<code>CLOB</code> value designated by this <code>Clob</code> object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="length()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>length</h4>
<pre>public long length()
throws java.sql.SQLException</pre>
<div class="block">Retrieves the number of characters in the <code>CLOB</code> value
designated by this <code>Clob</code> object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>length</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>length of the <code>CLOB</code> in characters</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the length of the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="position(java.lang.String, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre>public long position(java.lang.String searchstr,
long start)
throws java.sql.SQLException</pre>
<div class="block">Retrieves the character position at which the specified substring
<code>searchstr</code> appears in the SQL <code>CLOB</code> value
represented by this <code>Clob</code> object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>position</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>searchstr</code> - the substring for which to search</dd><dd><code>start</code> - the position at which to begin searching; the first
position is 1</dd>
<dt><span class="strong">Returns:</span></dt><dd>the position at which the substring appears or -1 if it is
not present; the first position is 1</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="position(java.sql.Clob, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position</h4>
<pre>public long position(java.sql.Clob searchstr,
long start)
throws java.sql.SQLException</pre>
<div class="block">Retrieves the character position at which the specified
<code>Clob</code> object <code>searchstr</code> appears in this
<code>Clob</code> object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>position</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>searchstr</code> - the <code>Clob</code> object for which to search</dd><dd><code>start</code> - the position at which to begin searching; the first
position is 1</dd>
<dt><span class="strong">Returns:</span></dt><dd>the position at which the <code>Clob</code> object appears or
-1 if it is not present; the first position is 1</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="setAsciiStream(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAsciiStream</h4>
<pre>public java.io.OutputStream setAsciiStream(long pos)
throws java.sql.SQLException</pre>
<div class="block">Retrieves a stream to be used to write Ascii characters to the
<code>CLOB</code> value that this <code>Clob</code> object represents,
starting at position <code>pos</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>setAsciiStream</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the position at which to start writing to this
<code>CLOB</code> object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the stream to which ASCII encoded characters can be written</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="setCharacterStream(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCharacterStream</h4>
<pre>public java.io.Writer setCharacterStream(long pos)
throws java.sql.SQLException</pre>
<div class="block">Retrieves a stream to be used to write a stream of Unicode characters
to the <code>CLOB</code> value that this <code>Clob</code> object
represents, at position <code>pos</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>setCharacterStream</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the position at which to start writing to the
<code>CLOB</code> value</dd>
<dt><span class="strong">Returns:</span></dt><dd>a stream to which Unicode encoded characters can be written</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="setString(long, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setString</h4>
<pre>public int setString(long pos,
java.lang.String str)
throws java.sql.SQLException</pre>
<div class="block">Writes the given Java <code>String</code> to the <code>CLOB</code>
value that this <code>Clob</code> object designates at the position
<code>pos</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>setString</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the position at which to start writing to the
<code>CLOB</code> value that this <code>Clob</code> object
represents</dd><dd><code>str</code> - the string to be written to the <code>CLOB</code> value
that this <code>Clob</code> designates</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of characters written</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="setString(long, java.lang.String, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setString</h4>
<pre>public int setString(long pos,
java.lang.String str,
int offset,
int len)
throws java.sql.SQLException</pre>
<div class="block">Writes <code>len</code> characters of <code>str</code>, starting at
character <code>offset</code>, to the <code>CLOB</code> value that
this <code>Clob</code> represents.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>setString</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the position at which to start writing to this
<code>CLOB</code> object</dd><dd><code>str</code> - the string to be written to the <code>CLOB</code> value
that this <code>Clob</code> object represents</dd><dd><code>offset</code> - the offset into <code>str</code> to start reading the
characters to be written</dd><dd><code>len</code> - the number of characters to be written</dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of characters written</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="truncate(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truncate</h4>
<pre>public void truncate(long len)
throws java.sql.SQLException</pre>
<div class="block">Truncates the <code>CLOB</code> value that this <code>Clob</code>
designates to have a length of <code>len</code> characters.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>truncate</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>len</code> - the length, in bytes, to which the <code>CLOB</code> value
should be truncated</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if there is an error accessing the
<code>CLOB</code> value</dd></dl>
</li>
</ul>
<a name="free()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre>public void free()
throws java.sql.SQLException</pre>
<div class="block">This method frees the <code>Clob</code> object and releases the resources the resources
that it holds. The object is invalid once the <code>free</code> method
is called.
<p>
After <code>free</code> has been called, any attempt to invoke a
method other than <code>free</code> will result in a <code>SQLException</code>
being thrown. If <code>free</code> is called multiple times, the subsequent
calls to <code>free</code> are treated as a no-op.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>free</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if an error occurs releasing
the Clob's resources</dd>
<dd><code>SQLFeatureNotSupportedException</code> - if the JDBC driver does not support
this method</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK 1.6, HSQLDB 2.0</dd></dl>
</li>
</ul>
<a name="getCharacterStream(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharacterStream</h4>
<pre>public java.io.Reader getCharacterStream(long pos,
long length)
throws java.sql.SQLException</pre>
<div class="block">Returns a <code>Reader</code> object that contains a partial <code>Clob</code> value, starting
with the character specified by pos, which is length characters in length.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getCharacterStream</code> in interface <code>java.sql.Clob</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - the offset to the first character of the partial value to
be retrieved. The first character in the Clob is at position 1.</dd><dd><code>length</code> - the length in characters of the partial value to be retrieved.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>Reader</code> through which the partial <code>Clob</code> value can be read.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - if pos is less than 1 or if pos is greater than the number of
characters in the <code>Clob</code> or if pos + length is greater than the number of
characters in the <code>Clob</code></dd>
<dd><code>SQLFeatureNotSupportedException</code> - if the JDBC driver does not support
this method</dd><dt><span class="strong">Since:</span></dt>
<dd>JDK 1.6, HSQLDB 2.0</dd></dl>
</li>
</ul>
<a name="getClob()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClob</h4>
<pre>public org.hsqldb.types.ClobDataID getClob()</pre>
</li>
</ul>
<a name="isClosed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre>public boolean isClosed()</pre>
</li>
</ul>
<a name="setWritable(org.hsqldb.jdbc.JDBCResultSet, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWritable</h4>
<pre>public void setWritable(<a href="../../../org/hsqldb/jdbc/JDBCResultSet.html" title="class in org.hsqldb.jdbc">JDBCResultSet</a> result,
int index)</pre>
</li>
</ul>
<a name="clearUpdates()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clearUpdates</h4>
<pre>public void clearUpdates()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JDBCClobClient.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/hsqldb/jdbc/JDBCClob.html" title="class in org.hsqldb.jdbc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/hsqldb/jdbc/JDBCClobFile.html" title="class in org.hsqldb.jdbc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/hsqldb/jdbc/JDBCClobClient.html" target="_top">Frames</a></li>
<li><a href="JDBCClobClient.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright �� 2001 - 2010 HSQL Development Group.</i></small></p>
</body>
</html>
