cassandra-server

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>DataRange (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"> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript>  <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/DataRange.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/CounterUpdateCell.html" title="interface in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/DataRange.Paging.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/DataRange.html" target="_top">Frames</a></li> <li><a href="DataRange.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>   <div class="header"> <div class="subTitle">org.apache.cassandra.db</div> <h2 title="Class DataRange" class="title">Class DataRange</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.DataRange</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/db/DataRange.Paging.html" title="class in org.apache.cassandra.db">DataRange.Paging</a></dd> </dl> <hr> <br> <pre>public class <span class="strong">DataRange</span> extends java.lang.Object</pre> <div class="block">Groups key range and column filter for range queries. The main "trick" of this class is that the column filter can only be obtained by providing the row key on which the column filter will be applied (which we always know before actually querying the columns). This allows the paging DataRange to return a filter for most rows but a potentially different ones for the starting and stopping key. Could allow more fancy stuff in the future too, like column filters that depend on the actual key value :)</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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"> </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>static class </code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.Paging.html" title="class in org.apache.cassandra.db">DataRange.Paging</a></strong></code> </td> </tr> </table> </li> </ul>  <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"> </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/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/DataRange.html#columnFilter">columnFilter</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#selectFullRow">selectFullRow</a></strong></code> </td> </tr> </table> </li> </ul>  <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/db/DataRange.html#DataRange(org.apache.cassandra.dht.AbstractBounds,%20org.apache.cassandra.db.filter.IDiskAtomFilter)">DataRange</a></strong>(<a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>> range, <a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a> columnFilter)</code> </td> </tr> </table> </li> </ul>  <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>static <a href="../../../../org/apache/cassandra/db/DataRange.html" title="class in org.apache.cassandra.db">DataRange</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#allData(org.apache.cassandra.dht.IPartitioner)">allData</a></strong>(<a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</code> </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/DataRange.html#columnFilter(java.nio.ByteBuffer)">columnFilter</a></strong>(java.nio.ByteBuffer rowKey)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#contains(org.apache.cassandra.db.RowPosition)">contains</a></strong>(<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> pos)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/db/DataRange.html" title="class in org.apache.cassandra.db">DataRange</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#forKeyRange(org.apache.cassandra.dht.Range)">forKeyRange</a></strong>(<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> keyRange)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#getLiveCount(org.apache.cassandra.db.ColumnFamily,%20long)">getLiveCount</a></strong>(<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> data, long now)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#isFullRowSlice(org.apache.cassandra.db.filter.SliceQueryFilter)">isFullRowSlice</a></strong>(<a href="../../../../org/apache/cassandra/db/filter/SliceQueryFilter.html" title="class in org.apache.cassandra.db.filter">SliceQueryFilter</a> filter)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#isWrapAround()">isWrapAround</a></strong>()</code> </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><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#keyRange()">keyRange</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#selectsFullRowFor(java.nio.ByteBuffer)">selectsFullRowFor</a></strong>(java.nio.ByteBuffer rowKey)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#startKey()">startKey</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DataRange.html#stopKey()">stopKey</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/db/DataRange.html#updateColumnsLimit(int)">updateColumnsLimit</a></strong>(int count)</code> </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">  <ul class="blockList"> <li class="blockList"><a name="field_detail">  </a> <h3>Field Detail</h3> <a name="columnFilter">  </a> <ul class="blockList"> <li class="blockList"> <h4>columnFilter</h4> <pre>protected <a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a> columnFilter</pre> </li> </ul> <a name="selectFullRow">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>selectFullRow</h4> <pre>protected final boolean selectFullRow</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="DataRange(org.apache.cassandra.dht.AbstractBounds, org.apache.cassandra.db.filter.IDiskAtomFilter)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>DataRange</h4> <pre>public DataRange(<a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>> range, <a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a> columnFilter)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="isFullRowSlice(org.apache.cassandra.db.filter.SliceQueryFilter)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isFullRowSlice</h4> <pre>public static boolean isFullRowSlice(<a href="../../../../org/apache/cassandra/db/filter/SliceQueryFilter.html" title="class in org.apache.cassandra.db.filter">SliceQueryFilter</a> filter)</pre> </li> </ul> <a name="allData(org.apache.cassandra.dht.IPartitioner)">  </a> <ul class="blockList"> <li class="blockList"> <h4>allData</h4> <pre>public static <a href="../../../../org/apache/cassandra/db/DataRange.html" title="class in org.apache.cassandra.db">DataRange</a> allData(<a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</pre> </li> </ul> <a name="forKeyRange(org.apache.cassandra.dht.Range)">  </a> <ul class="blockList"> <li class="blockList"> <h4>forKeyRange</h4> <pre>public static <a href="../../../../org/apache/cassandra/db/DataRange.html" title="class in org.apache.cassandra.db">DataRange</a> forKeyRange(<a href="../../../../org/apache/cassandra/dht/Range.html" title="class in org.apache.cassandra.dht">Range</a><<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> keyRange)</pre> </li> </ul> <a name="keyRange()">  </a> <ul class="blockList"> <li class="blockList"> <h4>keyRange</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/AbstractBounds.html" title="class in org.apache.cassandra.dht">AbstractBounds</a><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>> keyRange()</pre> </li> </ul> <a name="startKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>startKey</h4> <pre>public <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> startKey()</pre> </li> </ul> <a name="stopKey()">  </a> <ul class="blockList"> <li class="blockList"> <h4>stopKey</h4> <pre>public <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> stopKey()</pre> </li> </ul> <a name="isWrapAround()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isWrapAround</h4> <pre>public boolean isWrapAround()</pre> </li> </ul> <a name="contains(org.apache.cassandra.db.RowPosition)">  </a> <ul class="blockList"> <li class="blockList"> <h4>contains</h4> <pre>public boolean contains(<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> pos)</pre> </li> </ul> <a name="getLiveCount(org.apache.cassandra.db.ColumnFamily, long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getLiveCount</h4> <pre>public int getLiveCount(<a href="../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a> data, long now)</pre> </li> </ul> <a name="selectsFullRowFor(java.nio.ByteBuffer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>selectsFullRowFor</h4> <pre>public boolean selectsFullRowFor(java.nio.ByteBuffer rowKey)</pre> </li> </ul> <a name="columnFilter(java.nio.ByteBuffer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>columnFilter</h4> <pre>public <a href="../../../../org/apache/cassandra/db/filter/IDiskAtomFilter.html" title="interface in org.apache.cassandra.db.filter">IDiskAtomFilter</a> columnFilter(java.nio.ByteBuffer rowKey)</pre> </li> </ul> <a name="updateColumnsLimit(int)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>updateColumnsLimit</h4> <pre>public void updateColumnsLimit(int count)</pre> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/DataRange.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/CounterUpdateCell.html" title="interface in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/DataRange.Paging.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/DataRange.html" target="_top">Frames</a></li> <li><a href="DataRange.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>  <p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p> </body> </html>