UNPKG

cassandra-server

Version:

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

477 lines (476 loc) 21 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:27 CEST 2014 --> <title>AbstractRangeCommand (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="AbstractRangeCommand (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/AbstractRangeCommand.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/AbstractNativeCell.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/ArrayBackedSortedColumns.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/AbstractRangeCommand.html" target="_top">Frames</a></li> <li><a href="AbstractRangeCommand.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</div> <h2 title="Class AbstractRangeCommand" class="title">Class AbstractRangeCommand</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.AbstractRangeCommand</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/db/PagedRangeCommand.html" title="class in org.apache.cassandra.db">PagedRangeCommand</a>, <a href="../../../../org/apache/cassandra/db/RangeSliceCommand.html" title="class in org.apache.cassandra.db">RangeSliceCommand</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">AbstractRangeCommand</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</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>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#columnFamily">columnFamily</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a>&lt;<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#keyRange">keyRange</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#keyspace">keyspace</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#predicate">predicate</a></strong></code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.List&lt;<a href="../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#rowFilter">rowFilter</a></strong></code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#timestamp">timestamp</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/AbstractRangeCommand.html#AbstractRangeCommand(java.lang.String,%20java.lang.String,%20long,%20org.apache.cassandra.dht.AbstractBounds,%20org.apache.cassandra.db.filter.IDiskAtomFilter,%20java.util.List)">AbstractRangeCommand</a></strong>(java.lang.String&nbsp;keyspace, java.lang.String&nbsp;columnFamily, long&nbsp;timestamp, <a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a>&lt;<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&gt;&nbsp;keyRange, <a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a>&nbsp;predicate, java.util.List&lt;<a href="../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>&gt;&nbsp;rowFilter)</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>abstract boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#countCQL3Rows()">countCQL3Rows</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <a href="../../../../org/apache/cassandra/net/MessageOut.html" title="class in org.apache.cassandra.net">MessageOut</a>&lt;? extends <a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html" title="class in org.apache.cassandra.db">AbstractRangeCommand</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#createMessage()">createMessage</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract java.util.List&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#executeLocally()">executeLocally</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html" title="class in org.apache.cassandra.db">AbstractRangeCommand</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#forSubRange(org.apache.cassandra.dht.AbstractBounds)">forSubRange</a></strong>(<a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a>&lt;<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&gt;&nbsp;range)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#getKeyspace()">getKeyspace</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#getTimeout()">getTimeout</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#limit()">limit</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract <a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html" title="class in org.apache.cassandra.db">AbstractRangeCommand</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html#withUpdatedLimit(int)">withUpdatedLimit</a></strong>(int&nbsp;newLimit)</code>&nbsp;</td> </tr> </table> <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> </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="keyspace"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>keyspace</h4> <pre>public final&nbsp;java.lang.String keyspace</pre> </li> </ul> <a name="columnFamily"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>columnFamily</h4> <pre>public final&nbsp;java.lang.String columnFamily</pre> </li> </ul> <a name="timestamp"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>timestamp</h4> <pre>public final&nbsp;long timestamp</pre> </li> </ul> <a name="keyRange"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>keyRange</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a>&lt;<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&gt; keyRange</pre> </li> </ul> <a name="predicate"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>predicate</h4> <pre>public final&nbsp;<a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a> predicate</pre> </li> </ul> <a name="rowFilter"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>rowFilter</h4> <pre>public final&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>&gt; rowFilter</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="AbstractRangeCommand(java.lang.String, java.lang.String, long, org.apache.cassandra.dht.AbstractBounds, org.apache.cassandra.db.filter.IDiskAtomFilter, java.util.List)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>AbstractRangeCommand</h4> <pre>public&nbsp;AbstractRangeCommand(java.lang.String&nbsp;keyspace, java.lang.String&nbsp;columnFamily, long&nbsp;timestamp, <a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a>&lt;<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&gt;&nbsp;keyRange, <a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a>&nbsp;predicate, java.util.List&lt;<a href="../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>&gt;&nbsp;rowFilter)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getKeyspace()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getKeyspace</h4> <pre>public&nbsp;java.lang.String&nbsp;getKeyspace()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IReadCommand.html#getKeyspace()">getKeyspace</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</a></code></dd> </dl> </li> </ul> <a name="createMessage()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>createMessage</h4> <pre>public abstract&nbsp;<a href="../../../../org/apache/cassandra/net/MessageOut.html" title="class in org.apache.cassandra.net">MessageOut</a>&lt;? extends <a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html" title="class in org.apache.cassandra.db">AbstractRangeCommand</a>&gt;&nbsp;createMessage()</pre> </li> </ul> <a name="forSubRange(org.apache.cassandra.dht.AbstractBounds)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>forSubRange</h4> <pre>public abstract&nbsp;<a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html" title="class in org.apache.cassandra.db">AbstractRangeCommand</a>&nbsp;forSubRange(<a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a>&lt;<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>&gt;&nbsp;range)</pre> </li> </ul> <a name="withUpdatedLimit(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>withUpdatedLimit</h4> <pre>public abstract&nbsp;<a href="../../../../org/apache/cassandra/db/AbstractRangeCommand.html" title="class in org.apache.cassandra.db">AbstractRangeCommand</a>&nbsp;withUpdatedLimit(int&nbsp;newLimit)</pre> </li> </ul> <a name="limit()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>limit</h4> <pre>public abstract&nbsp;int&nbsp;limit()</pre> </li> </ul> <a name="countCQL3Rows()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>countCQL3Rows</h4> <pre>public abstract&nbsp;boolean&nbsp;countCQL3Rows()</pre> </li> </ul> <a name="executeLocally()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>executeLocally</h4> <pre>public abstract&nbsp;java.util.List&lt;<a href="../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>&gt;&nbsp;executeLocally()</pre> </li> </ul> <a name="getTimeout()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getTimeout</h4> <pre>public&nbsp;long&nbsp;getTimeout()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/service/IReadCommand.html#getTimeout()">getTimeout</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/service/IReadCommand.html" title="interface in org.apache.cassandra.service">IReadCommand</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/AbstractRangeCommand.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/AbstractNativeCell.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/ArrayBackedSortedColumns.html" title="class in org.apache.cassandra.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/db/AbstractRangeCommand.html" target="_top">Frames</a></li> <li><a href="AbstractRangeCommand.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>