UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

413 lines (412 loc) 19.1 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:29 CEST 2014 --> <title>MergeIterator (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="MergeIterator (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/MergeIterator.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/MD5Digest.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/utils/MergeIterator.Candidate.html" title="class in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/utils/MergeIterator.html" target="_top">Frames</a></li> <li><a href="MergeIterator.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:&nbsp;</li> <li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&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">org.apache.cassandra.utils</div> <h2 title="Class MergeIterator" class="title">Class MergeIterator&lt;In,Out&gt;</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.google.common.collect.UnmodifiableIterator&lt;T&gt;</li> <li> <ul class="inheritance"> <li>com.google.common.collect.AbstractIterator&lt;Out&gt;</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.utils.MergeIterator&lt;In,Out&gt;</li> </ul> </li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator&lt;Out&gt;, <a href="../../../../org/apache/cassandra/utils/CloseableIterator.html" title="interface in org.apache.cassandra.utils">CloseableIterator</a>&lt;Out&gt;, <a href="../../../../org/apache/cassandra/utils/IMergeIterator.html" title="interface in org.apache.cassandra.utils">IMergeIterator</a>&lt;In,Out&gt;</dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">MergeIterator&lt;In,Out&gt;</span> extends com.google.common.collect.AbstractIterator&lt;Out&gt; implements <a href="../../../../org/apache/cassandra/utils/IMergeIterator.html" title="interface in org.apache.cassandra.utils">IMergeIterator</a>&lt;In,Out&gt;</pre> <div class="block">Merges sorted input iterators which individually contain unique items.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected static class&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.Candidate.html" title="class in org.apache.cassandra.utils">MergeIterator.Candidate</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.Candidate.html" title="type parameter in MergeIterator.Candidate">In</a>&gt;</strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static class&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="type parameter in MergeIterator.Reducer">In</a>,<a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="type parameter in MergeIterator.Reducer">Out</a>&gt;</strong></code> <div class="block">Accumulator that collects values of type A, and outputs a value of type B.</div> </td> </tr> </table> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <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">&nbsp;</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 java.util.List&lt;? extends java.util.Iterator&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.html#iterators">iterators</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>,<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">Out</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.html#reducer">reducer</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- ======== 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">&nbsp;</span></caption> <tr> <th class="colFirst" scope="col">Modifier</th> <th class="colLast" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.html#MergeIterator(java.util.List,%20org.apache.cassandra.utils.MergeIterator.Reducer)">MergeIterator</a></strong>(java.util.List&lt;? extends java.util.Iterator&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>&gt;&gt;&nbsp;iters, <a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>,<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">Out</a>&gt;&nbsp;reducer)</code>&nbsp;</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">&nbsp;</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.html#close()">close</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static &lt;In,Out&gt;&nbsp;<a href="../../../../org/apache/cassandra/utils/IMergeIterator.html" title="interface in org.apache.cassandra.utils">IMergeIterator</a>&lt;In,Out&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.html#get(java.util.List,%20java.util.Comparator,%20org.apache.cassandra.utils.MergeIterator.Reducer)">get</a></strong>(java.util.List&lt;? extends java.util.Iterator&lt;In&gt;&gt;&nbsp;sources, java.util.Comparator&lt;In&gt;&nbsp;comparator, <a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;In,Out&gt;&nbsp;reducer)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.Iterable&lt;? extends java.util.Iterator&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>&gt;&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/utils/MergeIterator.html#iterators()">iterators</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.google.common.collect.AbstractIterator"> <!-- --> </a> <h3>Methods inherited from class&nbsp;com.google.common.collect.AbstractIterator</h3> <code>computeNext, endOfData, hasNext, next, peek</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.google.common.collect.UnmodifiableIterator"> <!-- --> </a> <h3>Methods inherited from class&nbsp;com.google.common.collect.UnmodifiableIterator</h3> <code>remove</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class&nbsp;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_java.util.Iterator"> <!-- --> </a> <h3>Methods inherited from interface&nbsp;java.util.Iterator</h3> <code>hasNext, next, remove</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="reducer"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>reducer</h4> <pre>protected final&nbsp;<a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>,<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">Out</a>&gt; reducer</pre> </li> </ul> <a name="iterators"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>iterators</h4> <pre>protected final&nbsp;java.util.List&lt;? extends java.util.Iterator&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>&gt;&gt; iterators</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="MergeIterator(java.util.List, org.apache.cassandra.utils.MergeIterator.Reducer)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>MergeIterator</h4> <pre>protected&nbsp;MergeIterator(java.util.List&lt;? extends java.util.Iterator&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>&gt;&gt;&nbsp;iters, <a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>,<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">Out</a>&gt;&nbsp;reducer)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="get(java.util.List, java.util.Comparator, org.apache.cassandra.utils.MergeIterator.Reducer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> <pre>public static&nbsp;&lt;In,Out&gt;&nbsp;<a href="../../../../org/apache/cassandra/utils/IMergeIterator.html" title="interface in org.apache.cassandra.utils">IMergeIterator</a>&lt;In,Out&gt;&nbsp;get(java.util.List&lt;? extends java.util.Iterator&lt;In&gt;&gt;&nbsp;sources, java.util.Comparator&lt;In&gt;&nbsp;comparator, <a href="../../../../org/apache/cassandra/utils/MergeIterator.Reducer.html" title="class in org.apache.cassandra.utils">MergeIterator.Reducer</a>&lt;In,Out&gt;&nbsp;reducer)</pre> </li> </ul> <a name="iterators()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>iterators</h4> <pre>public&nbsp;java.lang.Iterable&lt;? extends java.util.Iterator&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>&gt;&gt;&nbsp;iterators()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/utils/IMergeIterator.html#iterators()">iterators</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/utils/IMergeIterator.html" title="interface in org.apache.cassandra.utils">IMergeIterator</a>&lt;<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">In</a>,<a href="../../../../org/apache/cassandra/utils/MergeIterator.html" title="type parameter in MergeIterator">Out</a>&gt;</code></dd> </dl> </li> </ul> <a name="close()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</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/MergeIterator.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/MD5Digest.html" title="class in org.apache.cassandra.utils"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/utils/MergeIterator.Candidate.html" title="class in org.apache.cassandra.utils"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/utils/MergeIterator.html" target="_top">Frames</a></li> <li><a href="MergeIterator.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:&nbsp;</li> <li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>