cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
360 lines (359 loc) • 16.1 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:32 CEST 2014 -->
<title>NamesQueryPager (apache-cassandra API)</title>
<meta name="date" content="2014-09-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NamesQueryPager (apache-cassandra 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/NamesQueryPager.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>Prev Class</li>
<li><a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/service/pager/NamesQueryPager.html" target="_top">Frames</a></li>
<li><a href="NamesQueryPager.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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.cassandra.service.pager</div>
<h2 title="Class NamesQueryPager" class="title">Class NamesQueryPager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.service.pager.NamesQueryPager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a>, <a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager">SinglePartitionPager</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">NamesQueryPager</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager">SinglePartitionPager</a></pre>
<div class="block">Pager over a SliceByNamesReadCommand.</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="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><a href="../../../../../org/apache/cassandra/db/filter/ColumnCounter.html" title="class in org.apache.cassandra.db.filter">ColumnCounter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#columnCounter()">columnCounter</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#fetchPage(int)">fetchPage</a></strong>(int pageSize)</code>
<div class="block">Fetches the next page.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#isExhausted()">isExhausted</a></strong>()</code>
<div class="block">Whether or not this pager is exhausted, i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#key()">key</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#maxRemaining()">maxRemaining</a></strong>()</code>
<div class="block">The maximum number of cells/CQL3 row that we may still have to return.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/service/pager/PagingState.html" title="class in org.apache.cassandra.service.pager">PagingState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#state()">state</a></strong>()</code>
<div class="block">Get the current state of the pager.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/NamesQueryPager.html#timestamp()">timestamp</a></strong>()</code> </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>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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="key()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>key</h4>
<pre>public java.nio.ByteBuffer key()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html#key()">key</a></code> in interface <code><a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager">SinglePartitionPager</a></code></dd>
</dl>
</li>
</ul>
<a name="columnCounter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columnCounter</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/filter/ColumnCounter.html" title="class in org.apache.cassandra.db.filter">ColumnCounter</a> columnCounter()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html#columnCounter()">columnCounter</a></code> in interface <code><a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager">SinglePartitionPager</a></code></dd>
</dl>
</li>
</ul>
<a name="state()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>public <a href="../../../../../org/apache/cassandra/service/pager/PagingState.html" title="class in org.apache.cassandra.service.pager">PagingState</a> state()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#state()">QueryPager</a></code></strong></div>
<div class="block">Get the current state of the pager. The state can allow to restart the
paging on another host from where we are at this point.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#state()">state</a></code> in interface <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the current paging state. Will return null if paging is at the
beginning. If the pager is exhausted, the result is undefined.</dd></dl>
</li>
</ul>
<a name="isExhausted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isExhausted</h4>
<pre>public boolean isExhausted()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#isExhausted()">QueryPager</a></code></strong></div>
<div class="block">Whether or not this pager is exhausted, i.e. whether or not a call to
fetchPage may return more result.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#isExhausted()">isExhausted</a></code> in interface <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>whether the pager is exhausted.</dd></dl>
</li>
</ul>
<a name="fetchPage(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fetchPage</h4>
<pre>public java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>> fetchPage(int pageSize)
throws <a href="../../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a>,
<a href="../../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#fetchPage(int)">QueryPager</a></code></strong></div>
<div class="block">Fetches the next page.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#fetchPage(int)">fetchPage</a></code> in interface <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pageSize</code> - the maximum number of elements to return in the next page.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the page of result.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/cassandra/exceptions/RequestValidationException.html" title="class in org.apache.cassandra.exceptions">RequestValidationException</a></code></dd>
<dd><code><a href="../../../../../org/apache/cassandra/exceptions/RequestExecutionException.html" title="class in org.apache.cassandra.exceptions">RequestExecutionException</a></code></dd></dl>
</li>
</ul>
<a name="maxRemaining()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxRemaining</h4>
<pre>public int maxRemaining()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#maxRemaining()">QueryPager</a></code></strong></div>
<div class="block">The maximum number of cells/CQL3 row that we may still have to return.
In other words, that's the initial user limit minus what we've already
returned (note that it's not how many we *will* return, just the upper
limit on it).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#maxRemaining()">maxRemaining</a></code> in interface <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></dd>
</dl>
</li>
</ul>
<a name="timestamp()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timestamp</h4>
<pre>public long timestamp()</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/NamesQueryPager.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>Prev Class</li>
<li><a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/service/pager/NamesQueryPager.html" target="_top">Frames</a></li>
<li><a href="NamesQueryPager.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>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>