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>RandomPartitioner (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/RandomPartitioner.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/OrderPreservingPartitioner.html" title="class in org.apache.cassandra.dht"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/dht/Range.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/RandomPartitioner.html" target="_top">Frames</a></li> <li><a href="RandomPartitioner.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>Nested | </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.dht</div> <h2 title="Class RandomPartitioner" class="title">Class RandomPartitioner</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><<a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a>></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.dht.RandomPartitioner</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><<a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a>></dd> </dl> <hr> <br> <pre>public class <span class="strong">RandomPartitioner</span> extends <a href="../../../../org/apache/cassandra/dht/AbstractPartitioner.html" title="class in org.apache.cassandra.dht">AbstractPartitioner</a><<a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a>></pre> <div class="block">This class generates a BigIntegerToken using MD5 hash.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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>static java.math.BigInteger</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#MAXIMUM">MAXIMUM</a></strong></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#MINIMUM">MINIMUM</a></strong></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.math.BigInteger</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#ZERO">ZERO</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/dht/RandomPartitioner.html#RandomPartitioner()">RandomPartitioner</a></strong>()</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><a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#decorateKey(java.nio.ByteBuffer)">decorateKey</a></strong>(java.nio.ByteBuffer key)</code> <div class="block">Transform key to object representation of the on-disk format.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>,java.lang.Float></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#describeOwnership(java.util.List)">describeOwnership</a></strong>(java.util.List<<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> sortedTokens)</code> <div class="block">Calculate the deltas between tokens in the ring in order to compare relative sizes.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#getHeapSizeOf(org.apache.cassandra.dht.BigIntegerToken)">getHeapSizeOf</a></strong>(<a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a> token)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#getMinimumToken()">getMinimumToken</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#getRandomToken()">getRandomToken</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#getToken(java.nio.ByteBuffer)">getToken</a></strong>(java.nio.ByteBuffer key)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/Token.TokenFactory.html" title="class in org.apache.cassandra.dht">Token.TokenFactory</a><java.math.BigInteger></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#getTokenFactory()">getTokenFactory</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#getTokenValidator()">getTokenValidator</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#midpoint(org.apache.cassandra.dht.Token,%20org.apache.cassandra.dht.Token)">midpoint</a></strong>(<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> ltoken, <a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> rtoken)</code> <div class="block">Calculate a Token representing the approximate "middle" of the given range.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/dht/RandomPartitioner.html#preservesOrder()">preservesOrder</a></strong>()</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.dht.AbstractPartitioner">  </a> <h3>Methods inherited from class 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 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="ZERO">  </a> <ul class="blockList"> <li class="blockList"> <h4>ZERO</h4> <pre>public static final java.math.BigInteger ZERO</pre> </li> </ul> <a name="MINIMUM">  </a> <ul class="blockList"> <li class="blockList"> <h4>MINIMUM</h4> <pre>public static final <a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a> MINIMUM</pre> </li> </ul> <a name="MAXIMUM">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>MAXIMUM</h4> <pre>public static final java.math.BigInteger MAXIMUM</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="RandomPartitioner()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>RandomPartitioner</h4> <pre>public RandomPartitioner()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="decorateKey(java.nio.ByteBuffer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>decorateKey</h4> <pre>public <a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> decorateKey(java.nio.ByteBuffer key)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/dht/IPartitioner.html#decorateKey(java.nio.ByteBuffer)">IPartitioner</a></code></strong></div> <div class="block">Transform key to object representation of the on-disk format.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the raw, client-facing key</dd> <dt><span class="strong">Returns:</span></dt><dd>decorated version of key</dd></dl> </li> </ul> <a name="midpoint(org.apache.cassandra.dht.Token, org.apache.cassandra.dht.Token)">  </a> <ul class="blockList"> <li class="blockList"> <h4>midpoint</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> midpoint(<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> ltoken, <a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> rtoken)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/dht/IPartitioner.html#midpoint(org.apache.cassandra.dht.Token,%20org.apache.cassandra.dht.Token)">IPartitioner</a></code></strong></div> <div class="block">Calculate a Token representing the approximate "middle" of the given range.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>The approximate midpoint between left and right.</dd></dl> </li> </ul> <a name="getMinimumToken()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMinimumToken</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a> getMinimumToken()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>A Token smaller than all others in the range that is being partitioned. Not legal to assign to a node or key. (But legal to use in range scans.)</dd></dl> </li> </ul> <a name="getRandomToken()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getRandomToken</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a> getRandomToken()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>a randomly generated token</dd></dl> </li> </ul> <a name="getTokenFactory()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTokenFactory</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/Token.TokenFactory.html" title="class in org.apache.cassandra.dht">Token.TokenFactory</a><java.math.BigInteger> getTokenFactory()</pre> </li> </ul> <a name="preservesOrder()">  </a> <ul class="blockList"> <li class="blockList"> <h4>preservesOrder</h4> <pre>public boolean preservesOrder()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>True if the implementing class preserves key order in the Tokens it generates.</dd></dl> </li> </ul> <a name="getToken(java.nio.ByteBuffer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getToken</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a> getToken(java.nio.ByteBuffer key)</pre> <dl><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.BigIntegerToken)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getHeapSizeOf</h4> <pre>public long getHeapSizeOf(<a href="../../../../org/apache/cassandra/dht/BigIntegerToken.html" title="class in org.apache.cassandra.dht">BigIntegerToken</a> token)</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>the on-heap memory used by the provided token</dd></dl> </li> </ul> <a name="describeOwnership(java.util.List)">  </a> <ul class="blockList"> <li class="blockList"> <h4>describeOwnership</h4> <pre>public java.util.Map<<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>,java.lang.Float> describeOwnership(java.util.List<<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a>> sortedTokens)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/cassandra/dht/IPartitioner.html#describeOwnership(java.util.List)">IPartitioner</a></code></strong></div> <div class="block">Calculate the deltas between tokens in the ring in order to compare relative sizes.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sortedTokens</code> - a sorted List of Tokens</dd> <dt><span class="strong">Returns:</span></dt><dd>the mapping from 'token' to 'percentage of the ring owned by that token'.</dd></dl> </li> </ul> <a name="getTokenValidator()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>getTokenValidator</h4> <pre>public <a href="../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> getTokenValidator()</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/RandomPartitioner.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/OrderPreservingPartitioner.html" title="class in org.apache.cassandra.dht"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/dht/Range.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/RandomPartitioner.html" target="_top">Frames</a></li> <li><a href="RandomPartitioner.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>Nested | </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>