cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
393 lines (392 loc) • 17.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>Cursor (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="Cursor (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/Cursor.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/utils/btree/BTreeSet.BTreeRange.html" title="class in org.apache.cassandra.utils.btree"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/utils/btree/UpdateFunction.html" title="interface in org.apache.cassandra.utils.btree"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/utils/btree/Cursor.html" target="_top">Frames</a></li>
<li><a href="Cursor.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.utils.btree</div>
<h2 title="Class Cursor" class="title">Class Cursor<K,V extends K></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.utils.btree.Cursor<K,V></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>V</code> - </dd></dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.Iterator<V></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">Cursor<K,V extends K></span>
extends java.lang.Object
implements java.util.Iterator<V></pre>
<div class="block">An extension of Path which provides a public interface for iterating over or counting a subrange of the tree</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#Cursor()">Cursor</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#count()">count</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#hasNext()">hasNext</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#next()">next</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#remove()">remove</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#reset(java.lang.Object[],%20boolean)">reset</a></strong>(java.lang.Object[] btree,
boolean forwards)</code>
<div class="block">Reset this cursor for the provided tree, to iterate over its entire range</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#reset(java.lang.Object[],%20java.util.Comparator,%20K,%20boolean,%20K,%20boolean,%20boolean)">reset</a></strong>(java.lang.Object[] btree,
java.util.Comparator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a>> comparator,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> lowerBound,
boolean inclusiveLowerBound,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> upperBound,
boolean inclusiveUpperBound,
boolean forwards)</code>
<div class="block">Reset this cursor for the provided tree, to iterate between the provided start and end</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html#reset(java.lang.Object[],%20java.util.Comparator,%20K,%20K,%20boolean)">reset</a></strong>(java.lang.Object[] btree,
java.util.Comparator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a>> comparator,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> lowerBound,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> upperBound,
boolean forwards)</code>
<div class="block">Reset this cursor for the provided tree, to iterate between the provided start and end</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Cursor()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Cursor</h4>
<pre>public Cursor()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="reset(java.lang.Object[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public void reset(java.lang.Object[] btree,
boolean forwards)</pre>
<div class="block">Reset this cursor for the provided tree, to iterate over its entire range</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>btree</code> - the tree to iterate over</dd><dd><code>forwards</code> - if false, the cursor will start at the end and move backwards</dd></dl>
</li>
</ul>
<a name="reset(java.lang.Object[],java.util.Comparator,java.lang.Object,java.lang.Object,boolean)">
<!-- -->
</a><a name="reset(java.lang.Object[], java.util.Comparator, K, K, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public void reset(java.lang.Object[] btree,
java.util.Comparator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a>> comparator,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> lowerBound,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> upperBound,
boolean forwards)</pre>
<div class="block">Reset this cursor for the provided tree, to iterate between the provided start and end</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>btree</code> - the tree to iterate over</dd><dd><code>comparator</code> - the comparator that defines the ordering over the items in the tree</dd><dd><code>lowerBound</code> - the first item to include, inclusive</dd><dd><code>upperBound</code> - the last item to include, exclusive</dd><dd><code>forwards</code> - if false, the cursor will start at the end and move backwards</dd></dl>
</li>
</ul>
<a name="reset(java.lang.Object[],java.util.Comparator,java.lang.Object,boolean,java.lang.Object,boolean,boolean)">
<!-- -->
</a><a name="reset(java.lang.Object[], java.util.Comparator, K, boolean, K, boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public void reset(java.lang.Object[] btree,
java.util.Comparator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a>> comparator,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> lowerBound,
boolean inclusiveLowerBound,
<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a> upperBound,
boolean inclusiveUpperBound,
boolean forwards)</pre>
<div class="block">Reset this cursor for the provided tree, to iterate between the provided start and end</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>btree</code> - the tree to iterate over</dd><dd><code>comparator</code> - the comparator that defines the ordering over the items in the tree</dd><dd><code>lowerBound</code> - the first item to include</dd><dd><code>inclusiveLowerBound</code> - should include start in the iterator, if present in the tree</dd><dd><code>upperBound</code> - the last item to include</dd><dd><code>inclusiveUpperBound</code> - should include end in the iterator, if present in the tree</dd><dd><code>forwards</code> - if false, the cursor will start at the end and move backwards</dd></dl>
</li>
</ul>
<a name="hasNext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public boolean hasNext()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>hasNext</code> in interface <code>java.util.Iterator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">V</a> extends <a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a>></code></dd>
</dl>
</li>
</ul>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public <a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">V</a> next()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>next</code> in interface <code>java.util.Iterator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">V</a> extends <a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</a>></code></dd>
</dl>
</li>
</ul>
<a name="count()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>count</h4>
<pre>public int count()</pre>
</li>
</ul>
<a name="remove()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>remove</h4>
<pre>public void remove()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code> in interface <code>java.util.Iterator<<a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">V</a> extends <a href="../../../../../org/apache/cassandra/utils/btree/Cursor.html" title="type parameter in Cursor">K</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/Cursor.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/utils/btree/BTreeSet.BTreeRange.html" title="class in org.apache.cassandra.utils.btree"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/utils/btree/UpdateFunction.html" title="interface in org.apache.cassandra.utils.btree"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/utils/btree/Cursor.html" target="_top">Frames</a></li>
<li><a href="Cursor.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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>