blob: 181e70c3ae1120961962ae9082c1267883cbf066 [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>Result</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="Result";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev&nbsp;Class</li>
<li><a href="../../../../../jakarta/servlet/jsp/jstl/sql/ResultSupport.html" title="class in jakarta.servlet.jsp.jstl.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?jakarta/servlet/jsp/jstl/sql/Result.html" target="_top">Frames</a></li>
<li><a href="Result.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>Constr&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>Constr&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">jakarta.servlet.jsp.jstl.sql</div>
<h2 title="Interface Result" class="title">Interface Result</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Result</span></pre>
<div class="block"><p>This interface represents the result of a &lt;sql:query&gt;
action. It provides access to the following information in the
query result:</p>
<ul>
<li> The result rows (<tt>getRows()</tt> and <tt>getRowsByIndex()</tt>)
<li> The column names (<tt>getColumnNames()</tt>)
<li> The number of rows in the result (<tt>getRowCount()</tt>)
<li> An indication whether the rows returned represent the complete result
or just a subset that is limited by a maximum row setting
(<tt>isLimitedByMaxRows()</tt>)
</ul>
<p>An implementation of the <tt>Result</tt> interface provides a
<i>disconnected</i> view into the result of a query.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="../../../../../jakarta/servlet/jsp/jstl/sql/Result.html#getColumnNames--">getColumnNames</a></span>()</code>
<div class="block">Returns the names of the columns in the result.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/sql/Result.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="../../../../../jakarta/servlet/jsp/jstl/sql/Result.html#getRows--">getRows</a></span>()</code>
<div class="block">Returns the result of the query as an array of <code>SortedMap</code> 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="../../../../../jakarta/servlet/jsp/jstl/sql/Result.html#getRowsByIndex--">getRowsByIndex</a></span>()</code>
<div class="block">Returns the result of the query as an array of arrays.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../jakarta/servlet/jsp/jstl/sql/Result.html#isLimitedByMaxRows--">isLimitedByMaxRows</a></span>()</code>
<div class="block">Returns true if the query was limited by a maximum row setting</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ 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>java.util.SortedMap[]&nbsp;getRows()</pre>
<div class="block"><p>Returns the result of the query as an array of <code>SortedMap</code> objects.
Each item of the array represents a specific row in the query result.</p>
<p>A row is structured as a <code>SortedMap</code> object where the key is the column name,
and where the value is the value associated with the column identified by
the key. The column value is an Object of the Java type corresponding
to the mapping between column types and Java types defined by the JDBC
specification when the <code>ResultSet.getObject()</code> method is used.</p>
<p>The <code>SortedMap</code> must use the <code>Comparator</code>
<code>java.util.String.CASE_INSENSITIVE_ORDER</code>.
This makes it possible to access the key as a case insensitive representation
of a column name. This method will therefore work regardless of the case of
the column name returned by the database.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The result rows as an array of <code>SortedMap</code> objects</dd>
</dl>
</li>
</ul>
<a name="getRowsByIndex--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowsByIndex</h4>
<pre>java.lang.Object[][]&nbsp;getRowsByIndex()</pre>
<div class="block">Returns the result of the query as an array of arrays.
The first array dimension represents a specific row in the query result.
The array elements for each row are Object instances of the Java type
corresponding to the mapping between column types and Java types defined
by the JDBC specification when the <code>ResultSet.getObject()</code> method is used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the result rows as an array of <code>Object[]</code> objects</dd>
</dl>
</li>
</ul>
<a name="getColumnNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNames</h4>
<pre>java.lang.String[]&nbsp;getColumnNames()</pre>
<div class="block">Returns the names of the columns in the result. The order of the names in the array
matches the order in which columns are returned in method getRowsByIndex().</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the column names as an array of <code>String</code> objects</dd>
</dl>
</li>
</ul>
<a name="getRowCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowCount</h4>
<pre>int&nbsp;getRowCount()</pre>
<div class="block">Returns the number of rows in the cached ResultSet</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of rows in the result</dd>
</dl>
</li>
</ul>
<a name="isLimitedByMaxRows--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isLimitedByMaxRows</h4>
<pre>boolean&nbsp;isLimitedByMaxRows()</pre>
<div class="block">Returns true if the query was limited by a maximum row setting</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><tt>true</tt> if the query was limited by a maximum
row setting</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>Prev&nbsp;Class</li>
<li><a href="../../../../../jakarta/servlet/jsp/jstl/sql/ResultSupport.html" title="class in jakarta.servlet.jsp.jstl.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?jakarta/servlet/jsp/jstl/sql/Result.html" target="_top">Frames</a></li>
<li><a href="Result.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>Constr&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>Constr&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>