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>DecoratedKey (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/DecoratedKey.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/DataTracker.View.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/DefinitionsUpdateVerbHandler.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/DecoratedKey.html" target="_top">Frames</a></li> <li><a href="DecoratedKey.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.db</div> <h2 title="Class DecoratedKey" class="title">Class DecoratedKey</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.DecoratedKey</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.lang.Comparable<<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>>, <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>, <a href="../../../../org/apache/cassandra/dht/RingPosition.html" title="interface in org.apache.cassandra.dht">RingPosition</a><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../org/apache/cassandra/db/BufferDecoratedKey.html" title="class in org.apache.cassandra.db">BufferDecoratedKey</a>, <a href="../../../../org/apache/cassandra/db/NativeDecoratedKey.html" title="class in org.apache.cassandra.db">NativeDecoratedKey</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">DecoratedKey</span> extends java.lang.Object implements <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></pre> <div class="block">Represents a decorated key, handy for certain operations where just working with strings gets slow. We do a lot of sorting of DecoratedKeys, so for speed, we assume that tokens correspond one-to-one with keys. This is not quite correct in the case of RandomPartitioner (which uses MD5 to hash keys to tokens); if this matters, you can subclass RP to use a stronger hash, or use a non-lossy tokenization scheme (as in the OrderPreservingPartitioner classes).</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> <ul class="blockList"> <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.cassandra.db.RowPosition">  </a> <h3>Nested classes/interfaces inherited from interface org.apache.cassandra.db.<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></h3> <code><a href="../../../../org/apache/cassandra/db/RowPosition.ForKey.html" title="class in org.apache.cassandra.db">RowPosition.ForKey</a>, <a href="../../../../org/apache/cassandra/db/RowPosition.Kind.html" title="enum in org.apache.cassandra.db">RowPosition.Kind</a>, <a href="../../../../org/apache/cassandra/db/RowPosition.RowPositionSerializer.html" title="class in org.apache.cassandra.db">RowPosition.RowPositionSerializer</a></code></li> </ul> </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>static java.util.Comparator<<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/db/DecoratedKey.html#comparator">comparator</a></strong></code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.RowPosition">  </a> <h3>Fields inherited from interface org.apache.cassandra.db.<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></h3> <code><a href="../../../../org/apache/cassandra/db/RowPosition.html#serializer">serializer</a></code></li> </ul> </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/DecoratedKey.html#DecoratedKey(org.apache.cassandra.dht.Token)">DecoratedKey</a></strong>(<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> token)</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 int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#compareTo(org.apache.cassandra.dht.IPartitioner,%20java.nio.ByteBuffer,%20org.apache.cassandra.db.RowPosition)">compareTo</a></strong>(<a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner, java.nio.ByteBuffer key, <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> position)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#compareTo(org.apache.cassandra.db.RowPosition)">compareTo</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="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#getKey()">getKey</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/db/DecoratedKey.html#getToken()">getToken</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#hashCode()">hashCode</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/DecoratedKey.html#isMinimum()">isMinimum</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#isMinimum(org.apache.cassandra.dht.IPartitioner)">isMinimum</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="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/db/RowPosition.Kind.html" title="enum in org.apache.cassandra.db">RowPosition.Kind</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/db/DecoratedKey.html#kind()">kind</a></strong>()</code> </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/DecoratedKey.html#toString()">toString</a></strong>()</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, finalize, getClass, notify, notifyAll, 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="comparator">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>comparator</h4> <pre>public static final java.util.Comparator<<a href="../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>> comparator</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="DecoratedKey(org.apache.cassandra.dht.Token)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>DecoratedKey</h4> <pre>public DecoratedKey(<a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> token)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="hashCode()">  </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="equals(java.lang.Object)">  </a> <ul class="blockList"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="compareTo(org.apache.cassandra.db.RowPosition)">  </a> <ul class="blockList"> <li class="blockList"> <h4>compareTo</h4> <pre>public int compareTo(<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> pos)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>></code></dd> </dl> </li> </ul> <a name="compareTo(org.apache.cassandra.dht.IPartitioner, java.nio.ByteBuffer, org.apache.cassandra.db.RowPosition)">  </a> <ul class="blockList"> <li class="blockList"> <h4>compareTo</h4> <pre>public static int compareTo(<a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner, java.nio.ByteBuffer key, <a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> position)</pre> </li> </ul> <a name="isMinimum(org.apache.cassandra.dht.IPartitioner)">  </a> <ul class="blockList"> <li class="blockList"> <h4>isMinimum</h4> <pre>public boolean isMinimum(<a href="../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/dht/RingPosition.html#isMinimum(org.apache.cassandra.dht.IPartitioner)">isMinimum</a></code> in interface <code><a href="../../../../org/apache/cassandra/dht/RingPosition.html" title="interface in org.apache.cassandra.dht">RingPosition</a><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>></code></dd> </dl> </li> </ul> <a name="isMinimum()">  </a> <ul class="blockList"> <li class="blockList"> <h4>isMinimum</h4> <pre>public boolean isMinimum()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/db/RowPosition.html#isMinimum()">isMinimum</a></code> in interface <code><a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></code></dd> </dl> </li> </ul> <a name="kind()">  </a> <ul class="blockList"> <li class="blockList"> <h4>kind</h4> <pre>public <a href="../../../../org/apache/cassandra/db/RowPosition.Kind.html" title="enum in org.apache.cassandra.db">RowPosition.Kind</a> kind()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/db/RowPosition.html#kind()">kind</a></code> in interface <code><a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a></code></dd> </dl> </li> </ul> <a name="toString()">  </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="getToken()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getToken</h4> <pre>public <a href="../../../../org/apache/cassandra/dht/Token.html" title="class in org.apache.cassandra.dht">Token</a> getToken()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/dht/RingPosition.html#getToken()">getToken</a></code> in interface <code><a href="../../../../org/apache/cassandra/dht/RingPosition.html" title="interface in org.apache.cassandra.dht">RingPosition</a><<a href="../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a>></code></dd> </dl> </li> </ul> <a name="getKey()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>getKey</h4> <pre>public abstract java.nio.ByteBuffer getKey()</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/DecoratedKey.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/DataTracker.View.html" title="class in org.apache.cassandra.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/db/DefinitionsUpdateVerbHandler.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/DecoratedKey.html" target="_top">Frames</a></li> <li><a href="DecoratedKey.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>