UNPKG

cassandra-server

Version:

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

323 lines (322 loc) 14.7 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:31 CEST 2014 --> <title>ByteOrderedPartitioner (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="ByteOrderedPartitioner (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/ByteOrderedPartitioner.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/dht/Bounds.html" title="class in org.apache.cassandra.dht"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/dht/ByteOrderedPartitioner.html" target="_top">Frames</a></li> <li><a href="ByteOrderedPartitioner.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="#fields_inherited_from_class_org.apache.cassandra.dht.AbstractByteOrderedPartitioner">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.dht</div> <h2 title="Class ByteOrderedPartitioner" class="title">Class ByteOrderedPartitioner</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../org/apache/cassandra/dht/AbstractPartitioner.html" title="class in org.apache.cassandra.dht">org.apache.cassandra.dht.AbstractPartitioner</a>&lt;<a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a>&gt;</li> <li> <ul class="inheritance"> <li><a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html" title="class in org.apache.cassandra.dht">org.apache.cassandra.dht.AbstractByteOrderedPartitioner</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.dht.ByteOrderedPartitioner</li> </ul> </li> </ul> </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/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a>&lt;<a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a>&gt;</dd> </dl> <hr> <br> <pre>public class <span class="strong">ByteOrderedPartitioner</span> extends <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html" title="class in org.apache.cassandra.dht">AbstractByteOrderedPartitioner</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> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.dht.AbstractByteOrderedPartitioner"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.dht.<a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html" title="class in org.apache.cassandra.dht">AbstractByteOrderedPartitioner</a></h3> <code><a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#BYTE_MASK">BYTE_MASK</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#MINIMUM">MINIMUM</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/dht/ByteOrderedPartitioner.html#ByteOrderedPartitioner()">ByteOrderedPartitioner</a></strong>()</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>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/ByteOrderedPartitioner.html#getHeapSizeOf(org.apache.cassandra.dht.BytesToken)">getHeapSizeOf</a></strong>(<a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a>&nbsp;token)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/ByteOrderedPartitioner.html#getToken(java.nio.ByteBuffer)">getToken</a></strong>(java.nio.ByteBuffer&nbsp;key)</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.dht.AbstractByteOrderedPartitioner"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.dht.<a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html" title="class in org.apache.cassandra.dht">AbstractByteOrderedPartitioner</a></h3> <code><a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#decorateKey(java.nio.ByteBuffer)">decorateKey</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#describeOwnership(java.util.List)">describeOwnership</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#getMinimumToken()">getMinimumToken</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#getRandomToken()">getRandomToken</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#getTokenFactory()">getTokenFactory</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#getTokenValidator()">getTokenValidator</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#midpoint(org.apache.cassandra.dht.Token,%20org.apache.cassandra.dht.Token)">midpoint</a>, <a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#preservesOrder()">preservesOrder</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.dht.AbstractPartitioner"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.dht.<a href="../../../../org/apache/cassandra/dht/AbstractPartitioner.html" title="class in org.apache.cassandra.dht">AbstractPartitioner</a></h3> <code><a href="../../../../org/apache/cassandra/dht/AbstractPartitioner.html#minValue(java.lang.Class)">minValue</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, toString, 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="ByteOrderedPartitioner()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ByteOrderedPartitioner</h4> <pre>public&nbsp;ByteOrderedPartitioner()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getToken(java.nio.ByteBuffer)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getToken</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a>&nbsp;getToken(java.nio.ByteBuffer&nbsp;key)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/dht/IPartitioner.html#getToken(java.nio.ByteBuffer)">getToken</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a>&lt;<a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a>&gt;</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html#getToken(java.nio.ByteBuffer)">getToken</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cassandra/dht/AbstractByteOrderedPartitioner.html" title="class in org.apache.cassandra.dht">AbstractByteOrderedPartitioner</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>a Token that can be used to route a given key (This is NOT a method to create a Token from its string representation; for that, use TokenFactory.fromString.)</dd></dl> </li> </ul> <a name="getHeapSizeOf(org.apache.cassandra.dht.BytesToken)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getHeapSizeOf</h4> <pre>public&nbsp;long&nbsp;getHeapSizeOf(<a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht">BytesToken</a>&nbsp;token)</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the on-heap memory used by the provided token</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/ByteOrderedPartitioner.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/dht/Bounds.html" title="class in org.apache.cassandra.dht"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/dht/BytesToken.html" title="class in org.apache.cassandra.dht"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/cassandra/dht/ByteOrderedPartitioner.html" target="_top">Frames</a></li> <li><a href="ByteOrderedPartitioner.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="#fields_inherited_from_class_org.apache.cassandra.dht.AbstractByteOrderedPartitioner">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>