UNPKG

cassandra-server

Version:

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

347 lines (346 loc) 17.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:30 CEST 2014 --> <title>CompactionIterable (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="CompactionIterable (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/CompactionIterable.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/db/compaction/CompactionInterruptedException.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.Reducer.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/compaction/CompactionIterable.html" target="_top">Frames</a></li> <li><a href="CompactionIterable.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="#fields_inherited_from_class_org.apache.cassandra.db.compaction.AbstractCompactionIterable">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>Field&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.db.compaction</div> <h2 title="Class CompactionIterable" class="title">Class CompactionIterable</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">org.apache.cassandra.db.compaction.CompactionInfo.Holder</a></li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html" title="class in org.apache.cassandra.db.compaction">org.apache.cassandra.db.compaction.AbstractCompactionIterable</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.compaction.CompactionIterable</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.lang.Iterable&lt;<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactedRow.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactedRow</a>&gt;</dd> </dl> <hr> <br> <pre>public class <span class="strong">CompactionIterable</span> extends <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionIterable</a></pre> </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 class&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.Reducer.html" title="class in org.apache.cassandra.db.compaction">CompactionIterable.Reducer</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.compaction.AbstractCompactionIterable"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.db.compaction.<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionIterable</a></h3> <code><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#bytesRead">bytesRead</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#controller">controller</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#mergeCounters">mergeCounters</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#scanners">scanners</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#totalBytes">totalBytes</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#type">type</a></code></li> </ul> </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="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.html#CompactionIterable(org.apache.cassandra.db.compaction.OperationType,%20java.util.List,%20org.apache.cassandra.db.compaction.CompactionController)">CompactionIterable</a></strong>(<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a>&nbsp;type, java.util.List&lt;<a href="../../../../../org/apache/cassandra/db/compaction/ICompactionScanner.html" title="interface in org.apache.cassandra.db.compaction">ICompactionScanner</a>&gt;&nbsp;scanners, <a href="../../../../../org/apache/cassandra/db/compaction/CompactionController.html" title="class in org.apache.cassandra.db.compaction">CompactionController</a>&nbsp;controller)</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><a href="../../../../../org/apache/cassandra/utils/CloseableIterator.html" title="interface in org.apache.cassandra.utils">CloseableIterator</a>&lt;<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactedRow.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactedRow</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.html#iterator()">iterator</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.html#toString()">toString</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.compaction.AbstractCompactionIterable"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.db.compaction.<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionIterable</a></h3> <code><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#getCompactionInfo()">getCompactionInfo</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#getMergedRowCounts()">getMergedRowCounts</a>, <a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#updateCounterFor(int)">updateCounterFor</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.compaction.CompactionInfo.Holder"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.db.compaction.<a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html" title="class in org.apache.cassandra.db.compaction">CompactionInfo.Holder</a></h3> <code><a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html#finished()">finished</a>, <a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html#isStopRequested()">isStopRequested</a>, <a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html#started()">started</a>, <a href="../../../../../org/apache/cassandra/db/compaction/CompactionInfo.Holder.html#stop()">stop</a></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, 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="CompactionIterable(org.apache.cassandra.db.compaction.OperationType, java.util.List, org.apache.cassandra.db.compaction.CompactionController)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CompactionIterable</h4> <pre>public&nbsp;CompactionIterable(<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a>&nbsp;type, java.util.List&lt;<a href="../../../../../org/apache/cassandra/db/compaction/ICompactionScanner.html" title="interface in org.apache.cassandra.db.compaction">ICompactionScanner</a>&gt;&nbsp;scanners, <a href="../../../../../org/apache/cassandra/db/compaction/CompactionController.html" title="class in org.apache.cassandra.db.compaction">CompactionController</a>&nbsp;controller)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="iterator()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>iterator</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/utils/CloseableIterator.html" title="interface in org.apache.cassandra.utils">CloseableIterator</a>&lt;<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactedRow.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactedRow</a>&gt;&nbsp;iterator()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>iterator</code>&nbsp;in interface&nbsp;<code>java.lang.Iterable&lt;<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactedRow.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactedRow</a>&gt;</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html#iterator()">iterator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionIterable.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionIterable</a></code></dd> </dl> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>public&nbsp;java.lang.String&nbsp;toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</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/CompactionIterable.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/db/compaction/CompactionInterruptedException.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/db/compaction/CompactionIterable.Reducer.html" title="class in org.apache.cassandra.db.compaction"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/compaction/CompactionIterable.html" target="_top">Frames</a></li> <li><a href="CompactionIterable.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="#fields_inherited_from_class_org.apache.cassandra.db.compaction.AbstractCompactionIterable">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>Field&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>