cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
326 lines (325 loc) • 16.9 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>QueryPagers (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="QueryPagers (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/QueryPagers.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/QueryPager.html" title="interface in org.apache.cassandra.service.pager"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/service/pager/RangeNamesQueryPager.html" title="class 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/QueryPagers.html" target="_top">Frames</a></li>
<li><a href="QueryPagers.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 QueryPagers" class="title">Class QueryPagers</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.service.pager.QueryPagers</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">QueryPagers</span>
extends java.lang.Object</pre>
<div class="block">Static utility methods to create query pagers.</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>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/QueryPagers.html#countPaged(java.lang.String,%20java.lang.String,%20java.nio.ByteBuffer,%20org.apache.cassandra.db.filter.SliceQueryFilter,%20org.apache.cassandra.db.ConsistencyLevel,%20int,%20long)">countPaged</a></strong>(java.lang.String keyspace,
java.lang.String columnFamily,
java.nio.ByteBuffer key,
<a href="../../../../../org/apache/cassandra/db/filter/SliceQueryFilter.html" title="class in org.apache.cassandra.db.filter">SliceQueryFilter</a> filter,
<a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
int pageSize,
long now)</code>
<div class="block">Convenience method that count (live) cells/rows for a given slice of a row, but page underneath.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/QueryPagers.html#localPager(org.apache.cassandra.service.pager.Pageable)">localPager</a></strong>(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/QueryPagers.html#mayNeedPaging(org.apache.cassandra.service.pager.Pageable,%20int)">mayNeedPaging</a></strong>(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command,
int pageSize)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/QueryPagers.html#pager(org.apache.cassandra.service.pager.Pageable,%20org.apache.cassandra.db.ConsistencyLevel)">pager</a></strong>(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command,
<a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/QueryPagers.html#pager(org.apache.cassandra.service.pager.Pageable,%20org.apache.cassandra.db.ConsistencyLevel,%20org.apache.cassandra.service.pager.PagingState)">pager</a></strong>(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command,
<a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
<a href="../../../../../org/apache/cassandra/service/pager/PagingState.html" title="class in org.apache.cassandra.service.pager">PagingState</a> state)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator<<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/service/pager/QueryPagers.html#pageRowLocally(org.apache.cassandra.db.ColumnFamilyStore,%20java.nio.ByteBuffer,%20int)">pageRowLocally</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs,
java.nio.ByteBuffer key,
int pageSize)</code>
<div class="block">Convenience method to (locally) page an internal row.</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>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="mayNeedPaging(org.apache.cassandra.service.pager.Pageable, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mayNeedPaging</h4>
<pre>public static boolean mayNeedPaging(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command,
int pageSize)</pre>
</li>
</ul>
<a name="pager(org.apache.cassandra.service.pager.Pageable, org.apache.cassandra.db.ConsistencyLevel)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pager</h4>
<pre>public static <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a> pager(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command,
<a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel)</pre>
</li>
</ul>
<a name="pager(org.apache.cassandra.service.pager.Pageable, org.apache.cassandra.db.ConsistencyLevel, org.apache.cassandra.service.pager.PagingState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pager</h4>
<pre>public static <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a> pager(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command,
<a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
<a href="../../../../../org/apache/cassandra/service/pager/PagingState.html" title="class in org.apache.cassandra.service.pager">PagingState</a> state)</pre>
</li>
</ul>
<a name="localPager(org.apache.cassandra.service.pager.Pageable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>localPager</h4>
<pre>public static <a href="../../../../../org/apache/cassandra/service/pager/QueryPager.html" title="interface in org.apache.cassandra.service.pager">QueryPager</a> localPager(<a href="../../../../../org/apache/cassandra/service/pager/Pageable.html" title="interface in org.apache.cassandra.service.pager">Pageable</a> command)</pre>
</li>
</ul>
<a name="pageRowLocally(org.apache.cassandra.db.ColumnFamilyStore, java.nio.ByteBuffer, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pageRowLocally</h4>
<pre>public static java.util.Iterator<<a href="../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>> pageRowLocally(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs,
java.nio.ByteBuffer key,
int pageSize)</pre>
<div class="block">Convenience method to (locally) page an internal row.
Used to 2ndary index a wide row without dying.</div>
</li>
</ul>
<a name="countPaged(java.lang.String, java.lang.String, java.nio.ByteBuffer, org.apache.cassandra.db.filter.SliceQueryFilter, org.apache.cassandra.db.ConsistencyLevel, int, long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>countPaged</h4>
<pre>public static int countPaged(java.lang.String keyspace,
java.lang.String columnFamily,
java.nio.ByteBuffer key,
<a href="../../../../../org/apache/cassandra/db/filter/SliceQueryFilter.html" title="class in org.apache.cassandra.db.filter">SliceQueryFilter</a> filter,
<a href="../../../../../org/apache/cassandra/db/ConsistencyLevel.html" title="enum in org.apache.cassandra.db">ConsistencyLevel</a> consistencyLevel,
int pageSize,
long now)
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">Convenience method that count (live) cells/rows for a given slice of a row, but page underneath.</div>
<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>
</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/QueryPagers.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/QueryPager.html" title="interface in org.apache.cassandra.service.pager"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/service/pager/RangeNamesQueryPager.html" title="class 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/QueryPagers.html" target="_top">Frames</a></li>
<li><a href="QueryPagers.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>