blob: ba6c11997795c136d5091b77f27d201c1a262c6b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>ResultImpl</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ResultImpl";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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/apache/taglibs/standard/tag/common/sql/QueryTagSupport.html" title="class in org.apache.taglibs.standard.tag.common.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/SetDataSourceTagSupport.html" title="class in org.apache.taglibs.standard.tag.common.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/taglibs/standard/tag/common/sql/ResultImpl.html" target="_top">Frames</a></li>
<li><a href="ResultImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.apache.taglibs.standard.tag.common.sql</div>
<h2 title="Class ResultImpl" class="title">Class ResultImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.taglibs.standard.tag.common.sql.ResultImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ResultImpl</span>
extends java.lang.Object
implements <a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></pre>
<div class="block"><p>This class creates a cached version of a <tt>ResultSet</tt>.
It's represented as a <tt>Result</tt> implementation, capable of
returing an array of <tt>Row</tt> objects containing a <tt>Column</tt>
instance for each column in the row.</p>
<p>Note -- this is a private copy for the RI to avoid making the
corresponding class in javax.servlet.* public.</p></div>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/ResultImpl.html#ResultImpl-java.sql.ResultSet-int-int-">ResultImpl</a></span>(java.sql.ResultSet&nbsp;rs,
int&nbsp;startRow,
int&nbsp;maxRows)</code>
<div class="block">This constructor reads the ResultSet and saves a cached
copy.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/ResultImpl.html#getColumnNames--">getColumnNames</a></span>()</code>
<div class="block">Returns an array of String objects.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/ResultImpl.html#getRowCount--">getRowCount</a></span>()</code>
<div class="block">Returns the number of rows in the cached ResultSet</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.SortedMap[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/ResultImpl.html#getRows--">getRows</a></span>()</code>
<div class="block">Returns an array of SortedMap objects.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Object[][]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/ResultImpl.html#getRowsByIndex--">getRowsByIndex</a></span>()</code>
<div class="block">Returns an array of Object[] objects.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/ResultImpl.html#isLimitedByMaxRows--">isLimitedByMaxRows</a></span>()</code>
<div class="block">Returns true of the query was limited by a maximum row setting</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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="ResultImpl-java.sql.ResultSet-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ResultImpl</h4>
<pre>public&nbsp;ResultImpl(java.sql.ResultSet&nbsp;rs,
int&nbsp;startRow,
int&nbsp;maxRows)
throws java.sql.SQLException</pre>
<div class="block">This constructor reads the ResultSet and saves a cached
copy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rs</code> - an open <tt>ResultSet</tt>, positioned before the first
row</dd>
<dd><code>startRow,</code> - beginning row to be cached</dd>
<dd><code>maxRows,</code> - query maximum rows limit</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>if</code> - a database error occurs</dd>
<dd><code>java.sql.SQLException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRows--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRows</h4>
<pre>public&nbsp;java.util.SortedMap[]&nbsp;getRows()</pre>
<div class="block">Returns an array of SortedMap objects. The SortedMap
object key is the ColumnName and the value is the ColumnValue.
SortedMap was created using the CASE_INSENSITIVE_ORDER
Comparator so the key is the case insensitive representation
of the ColumnName.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html#getRows--">getRows</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of Map, or null if there are no rows</dd>
</dl>
</li>
</ul>
<a name="getRowsByIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowsByIndex</h4>
<pre>public&nbsp;java.lang.Object[][]&nbsp;getRowsByIndex()</pre>
<div class="block">Returns an array of Object[] objects. The first index
designates the Row, the second the Column. The array
stores the value at the specified row and column.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html#getRowsByIndex--">getRowsByIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of Object[], or null if there are no rows</dd>
</dl>
</li>
</ul>
<a name="getColumnNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNames</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getColumnNames()</pre>
<div class="block">Returns an array of String objects. The array represents
the names of the columns arranged in the same order as in
the getRowsByIndex() method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html#getColumnNames--">getColumnNames</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of String[]</dd>
</dl>
</li>
</ul>
<a name="getRowCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowCount</h4>
<pre>public&nbsp;int&nbsp;getRowCount()</pre>
<div class="block">Returns the number of rows in the cached ResultSet</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html#getRowCount--">getRowCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of cached rows, or -1 if the Result could
not be initialized due to SQLExceptions</dd>
</dl>
</li>
</ul>
<a name="isLimitedByMaxRows--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isLimitedByMaxRows</h4>
<pre>public&nbsp;boolean&nbsp;isLimitedByMaxRows()</pre>
<div class="block">Returns true of the query was limited by a maximum row setting</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html#isLimitedByMaxRows--">isLimitedByMaxRows</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../javax/servlet/jsp/jstl/sql/Result.html" title="interface in javax.servlet.jsp.jstl.sql">Result</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the query was limited by a MaxRows attribute</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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/apache/taglibs/standard/tag/common/sql/QueryTagSupport.html" title="class in org.apache.taglibs.standard.tag.common.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/taglibs/standard/tag/common/sql/SetDataSourceTagSupport.html" title="class in org.apache.taglibs.standard.tag.common.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/taglibs/standard/tag/common/sql/ResultImpl.html" target="_top">Frames</a></li>
<li><a href="ResultImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>