cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>SliceQueryPager (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/SliceQueryPager.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/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/service/pager/SliceQueryPager.html" target="_top">Frames</a></li> <li><a href="SliceQueryPager.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top">  </a></div>   <div class="header"> <div class="subTitle">org.apache.cassandra.service.pager</div> <h2 title="Class SliceQueryPager" class="title">Class SliceQueryPager</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.service.pager.SliceQueryPager</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">SliceQueryPager</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 SliceFromReadCommand.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_summary">  </a> <h3>Field Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#cfm">cfm</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#columnFilter">columnFilter</a></strong></code> </td> </tr> </table> </li> </ul>  <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/SliceQueryPager.html#columnCounter()">columnCounter</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#containsPreviousLast(org.apache.cassandra.db.Row)">containsPreviousLast</a></strong>(<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> first)</code> </td> </tr> <tr class="altColor"> <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/SliceQueryPager.html#fetchPage(int)">fetchPage</a></strong>(int pageSize)</code> <div class="block">Fetches the next page.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected static <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#firstCell(org.apache.cassandra.db.ColumnFamily)">firstCell</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.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>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#isReversed()">isReversed</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#key()">key</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected static <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#lastCell(org.apache.cassandra.db.ColumnFamily)">lastCell</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</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/SliceQueryPager.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>protected 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/SliceQueryPager.html#queryNextPage(int,%20org.apache.cassandra.db.ConsistencyLevel,%20boolean)">queryNextPage</a></strong>(int pageSize, <a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel, boolean localQuery)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#recordLast(org.apache.cassandra.db.Row)">recordLast</a></strong>(<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> last)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.html#restoreState(int,%20boolean)">restoreState</a></strong>(int remaining, boolean lastWasRecorded)</code> </td> </tr> <tr class="altColor"> <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/SliceQueryPager.html#state()">state</a></strong>()</code> <div class="block">Get the current state of the pager.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/SliceQueryPager.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> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.service.pager.SinglePartitionPager">  </a> <h3>Methods inherited from interface org.apache.cassandra.service.pager.<a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager">SinglePartitionPager</a></h3> <code><a href="../../../../../org/apache/cassandra/service/pager/SinglePartitionPager.html#columnCounter()">columnCounter</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.service.pager.QueryPager">  </a> <h3>Methods inherited from interface org.apache.cassandra.service.pager.<a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></h3> <code><a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#fetchPage(int)">fetchPage</a>, <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#isExhausted()">isExhausted</a>, <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html#maxRemaining()">maxRemaining</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="cfm">  </a> <ul class="blockList"> <li class="blockList"> <h4>cfm</h4> <pre>protected final <a href="../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a> cfm</pre> </li> </ul> <a name="columnFilter">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>columnFilter</h4> <pre>protected final <a href="../../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a> columnFilter</pre> </li> </ul> </li> </ul>  <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="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="queryNextPage(int, org.apache.cassandra.db.ConsistencyLevel, boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>queryNextPage</h4> <pre>protected java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>> queryNextPage(int pageSize, <a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel, boolean localQuery) 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> <dl><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="containsPreviousLast(org.apache.cassandra.db.Row)">  </a> <ul class="blockList"> <li class="blockList"> <h4>containsPreviousLast</h4> <pre>protected boolean containsPreviousLast(<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> first)</pre> </li> </ul> <a name="recordLast(org.apache.cassandra.db.Row)">  </a> <ul class="blockList"> <li class="blockList"> <h4>recordLast</h4> <pre>protected boolean recordLast(<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a> last)</pre> </li> </ul> <a name="isReversed()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isReversed</h4> <pre>protected boolean isReversed()</pre> </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="restoreState(int, boolean)">  </a> <ul class="blockList"> <li class="blockList"> <h4>restoreState</h4> <pre>protected void restoreState(int remaining, boolean lastWasRecorded)</pre> </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="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="blockList"> <li class="blockList"> <h4>timestamp</h4> <pre>public long timestamp()</pre> </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> </li> </ul> <a name="firstCell(org.apache.cassandra.db.ColumnFamily)">  </a> <ul class="blockList"> <li class="blockList"> <h4>firstCell</h4> <pre>protected static <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> firstCell(<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</pre> </li> </ul> <a name="lastCell(org.apache.cassandra.db.ColumnFamily)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>lastCell</h4> <pre>protected static <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> lastCell(<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> cf)</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/SliceQueryPager.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/apache/cassandra/service/pager/SinglePartitionPager.html" title="interface in org.apache.cassandra.service.pager"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/service/pager/SliceQueryPager.html" target="_top">Frames</a></li> <li><a href="SliceQueryPager.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field_detail">Field</a> | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>