UNPKG

cassandra-server

Version:

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

448 lines (447 loc) 21.2 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>AbstractCompactionTask (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="AbstractCompactionTask (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/AbstractCompactionTask.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/AbstractCompactionStrategy.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/CompactionController.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/AbstractCompactionTask.html" target="_top">Frames</a></li> <li><a href="AbstractCompactionTask.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>Nested&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.db.compaction</div> <h2 title="Class AbstractCompactionTask" class="title">Class AbstractCompactionTask</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/utils/WrappedRunnable.html" title="class in org.apache.cassandra.utils">org.apache.cassandra.utils.WrappedRunnable</a></li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html" title="class in org.apache.cassandra.io.util">org.apache.cassandra.io.util.DiskAwareRunnable</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.compaction.AbstractCompactionTask</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.Runnable</dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../../org/apache/cassandra/db/compaction/CompactionTask.html" title="class in org.apache.cassandra.db.compaction">CompactionTask</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">AbstractCompactionTask</span> extends <a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html" title="class in org.apache.cassandra.io.util">DiskAwareRunnable</a></pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== 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 <a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#cfs">cfs</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#compactionType">compactionType</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#isUserDefined">isUserDefined</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected java.util.Set&lt;<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#sstables">sstables</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="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#AbstractCompactionTask(org.apache.cassandra.db.ColumnFamilyStore,%20java.util.Set)">AbstractCompactionTask</a></strong>(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>&nbsp;cfs, java.util.Set&lt;<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>&gt;&nbsp;sstables)</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>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#execute(org.apache.cassandra.db.compaction.CompactionManager.CompactionExecutorStatsCollector)">execute</a></strong>(<a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a>&nbsp;collector)</code> <div class="block">executes the task and unmarks sstables compacting</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected abstract int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#executeInternal(org.apache.cassandra.db.compaction.CompactionManager.CompactionExecutorStatsCollector)">executeInternal</a></strong>(<a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a>&nbsp;collector)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/Directories.html" title="class in org.apache.cassandra.db">Directories</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#getDirectories()">getDirectories</a></strong>()</code> <div class="block">Get sstable directories for the CF.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionTask</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#setCompactionType(org.apache.cassandra.db.compaction.OperationType)">setCompactionType</a></strong>(<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a>&nbsp;compactionType)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionTask</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html#setUserDefined(boolean)">setUserDefined</a></strong>(boolean&nbsp;isUserDefined)</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/AbstractCompactionTask.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.io.util.DiskAwareRunnable"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.io.util.<a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html" title="class in org.apache.cassandra.io.util">DiskAwareRunnable</a></h3> <code><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html#getExpectedWriteSize()">getExpectedWriteSize</a>, <a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html#reduceScopeForLimitedSpace()">reduceScopeForLimitedSpace</a>, <a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html#runMayThrow()">runMayThrow</a>, <a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html#runWith(java.io.File)">runWith</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.utils.WrappedRunnable"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.utils.<a href="../../../../../org/apache/cassandra/utils/WrappedRunnable.html" title="class in org.apache.cassandra.utils">WrappedRunnable</a></h3> <code><a href="../../../../../org/apache/cassandra/utils/WrappedRunnable.html#run()">run</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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field_detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="cfs"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>cfs</h4> <pre>protected final&nbsp;<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs</pre> </li> </ul> <a name="sstables"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>sstables</h4> <pre>protected&nbsp;java.util.Set&lt;<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>&gt; sstables</pre> </li> </ul> <a name="isUserDefined"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isUserDefined</h4> <pre>protected&nbsp;boolean isUserDefined</pre> </li> </ul> <a name="compactionType"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>compactionType</h4> <pre>protected&nbsp;<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a> compactionType</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="AbstractCompactionTask(org.apache.cassandra.db.ColumnFamilyStore, java.util.Set)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>AbstractCompactionTask</h4> <pre>public&nbsp;AbstractCompactionTask(<a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a>&nbsp;cfs, java.util.Set&lt;<a href="../../../../../org/apache/cassandra/io/sstable/SSTableReader.html" title="class in org.apache.cassandra.io.sstable">SSTableReader</a>&gt;&nbsp;sstables)</pre> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cfs</code> - </dd><dd><code>sstables</code> - must be marked compacting</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="execute(org.apache.cassandra.db.compaction.CompactionManager.CompactionExecutorStatsCollector)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>execute</h4> <pre>public&nbsp;int&nbsp;execute(<a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a>&nbsp;collector)</pre> <div class="block">executes the task and unmarks sstables compacting</div> </li> </ul> <a name="executeInternal(org.apache.cassandra.db.compaction.CompactionManager.CompactionExecutorStatsCollector)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>executeInternal</h4> <pre>protected abstract&nbsp;int&nbsp;executeInternal(<a href="../../../../../org/apache/cassandra/db/compaction/CompactionManager.CompactionExecutorStatsCollector.html" title="interface in org.apache.cassandra.db.compaction">CompactionManager.CompactionExecutorStatsCollector</a>&nbsp;collector)</pre> </li> </ul> <a name="getDirectories()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDirectories</h4> <pre>protected&nbsp;<a href="../../../../../org/apache/cassandra/db/Directories.html" title="class in org.apache.cassandra.db">Directories</a>&nbsp;getDirectories()</pre> <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html#getDirectories()">DiskAwareRunnable</a></code></strong></div> <div class="block">Get sstable directories for the CF.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html#getDirectories()">getDirectories</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/io/util/DiskAwareRunnable.html" title="class in org.apache.cassandra.io.util">DiskAwareRunnable</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>Directories instance for the CF.</dd></dl> </li> </ul> <a name="setUserDefined(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setUserDefined</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionTask</a>&nbsp;setUserDefined(boolean&nbsp;isUserDefined)</pre> </li> </ul> <a name="setCompactionType(org.apache.cassandra.db.compaction.OperationType)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setCompactionType</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/db/compaction/AbstractCompactionTask.html" title="class in org.apache.cassandra.db.compaction">AbstractCompactionTask</a>&nbsp;setCompactionType(<a href="../../../../../org/apache/cassandra/db/compaction/OperationType.html" title="enum in org.apache.cassandra.db.compaction">OperationType</a>&nbsp;compactionType)</pre> </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/AbstractCompactionTask.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/AbstractCompactionStrategy.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/CompactionController.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/AbstractCompactionTask.html" target="_top">Frames</a></li> <li><a href="AbstractCompactionTask.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>Nested&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>