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>IndexSummary (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/IndexSummary.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/io/sstable/IndexHelper.IndexInfo.Serializer.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.IndexSummarySerializer.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/IndexSummary.html" target="_top">Frames</a></li> <li><a href="IndexSummary.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.io.sstable</div> <h2 title="Class IndexSummary" class="title">Class IndexSummary</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>org.apache.cassandra.io.sstable.IndexSummary</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.io.Closeable, java.lang.AutoCloseable</dd> </dl> <hr> <br> <pre>public class <span class="strong">IndexSummary</span> extends java.lang.Object implements java.io.Closeable</pre> </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/io/sstable/IndexSummary.IndexSummarySerializer.html" title="class in org.apache.cassandra.io.sstable">IndexSummary.IndexSummarySerializer</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>static <a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.IndexSummarySerializer.html" title="class in org.apache.cassandra.io.sstable">IndexSummary.IndexSummarySerializer</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#serializer">serializer</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/io/sstable/IndexSummary.html#IndexSummary(org.apache.cassandra.dht.IPartitioner,%20org.apache.cassandra.cache.RefCountedMemory,%20int,%20int,%20int,%20int)">IndexSummary</a></strong>(<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner, <a href="../../../../../org/apache/cassandra/cache/RefCountedMemory.html" title="class in org.apache.cassandra.cache">RefCountedMemory</a> memory, int summarySize, int sizeAtFullSampling, int minIndexInterval, int samplingLevel)</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>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#binarySearch(org.apache.cassandra.db.RowPosition)">binarySearch</a></strong>(<a href="../../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> key)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#close()">close</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>double</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getEffectiveIndexInterval()">getEffectiveIndexInterval</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/io/sstable/IndexSummary.html#getEffectiveIndexIntervalAfterIndex(int)">getEffectiveIndexIntervalAfterIndex</a></strong>(int index)</code> <div class="block">Returns the number of primary (on-disk) index entries between the index summary entry at `index` and the next index summary entry (assuming there is one).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getEntry(int)">getEntry</a></strong>(int index)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getEstimatedKeyCount()">getEstimatedKeyCount</a></strong>()</code> <div class="block">Returns an estimate of the total number of keys in the SSTable.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getKey(int)">getKey</a></strong>(int index)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getMaxNumberOfEntries()">getMaxNumberOfEntries</a></strong>()</code> <div class="block">Returns the number of entries this summary would have if it were at the full sampling level, which is equal to the number of entries in the primary on-disk index divided by the min index interval.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getMinIndexInterval()">getMinIndexInterval</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getOffHeapSize()">getOffHeapSize</a></strong>()</code> <div class="block">Returns the amount of off-heap memory used for this summary.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getPosition(int)">getPosition</a></strong>(int index)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getPositionInSummary(int)">getPositionInSummary</a></strong>(int index)</code> <div class="block">Gets the position of the actual index summary entry in our Memory attribute, 'bytes'.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#getSamplingLevel()">getSamplingLevel</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html" title="class in org.apache.cassandra.io.sstable">IndexSummary</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#readOnlyClone()">readOnlyClone</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html#size()">size</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, 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="serializer">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>serializer</h4> <pre>public static final <a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.IndexSummarySerializer.html" title="class in org.apache.cassandra.io.sstable">IndexSummary.IndexSummarySerializer</a> serializer</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="IndexSummary(org.apache.cassandra.dht.IPartitioner, org.apache.cassandra.cache.RefCountedMemory, int, int, int, int)">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>IndexSummary</h4> <pre>public IndexSummary(<a href="../../../../../org/apache/cassandra/dht/IPartitioner.html" title="interface in org.apache.cassandra.dht">IPartitioner</a> partitioner, <a href="../../../../../org/apache/cassandra/cache/RefCountedMemory.html" title="class in org.apache.cassandra.cache">RefCountedMemory</a> memory, int summarySize, int sizeAtFullSampling, int minIndexInterval, int samplingLevel)</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="binarySearch(org.apache.cassandra.db.RowPosition)">  </a> <ul class="blockList"> <li class="blockList"> <h4>binarySearch</h4> <pre>public int binarySearch(<a href="../../../../../org/apache/cassandra/db/RowPosition.html" title="interface in org.apache.cassandra.db">RowPosition</a> key)</pre> </li> </ul> <a name="getPositionInSummary(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPositionInSummary</h4> <pre>public int getPositionInSummary(int index)</pre> <div class="block">Gets the position of the actual index summary entry in our Memory attribute, 'bytes'.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The index of the entry or key to get the position for</dd> <dt><span class="strong">Returns:</span></dt><dd>an offset into our Memory attribute where the actual entry resides</dd></dl> </li> </ul> <a name="getKey(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getKey</h4> <pre>public byte[] getKey(int index)</pre> </li> </ul> <a name="getPosition(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getPosition</h4> <pre>public long getPosition(int index)</pre> </li> </ul> <a name="getEntry(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getEntry</h4> <pre>public byte[] getEntry(int index)</pre> </li> </ul> <a name="getMinIndexInterval()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMinIndexInterval</h4> <pre>public int getMinIndexInterval()</pre> </li> </ul> <a name="getEffectiveIndexInterval()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getEffectiveIndexInterval</h4> <pre>public double getEffectiveIndexInterval()</pre> </li> </ul> <a name="getEstimatedKeyCount()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getEstimatedKeyCount</h4> <pre>public long getEstimatedKeyCount()</pre> <div class="block">Returns an estimate of the total number of keys in the SSTable.</div> </li> </ul> <a name="size()">  </a> <ul class="blockList"> <li class="blockList"> <h4>size</h4> <pre>public int size()</pre> </li> </ul> <a name="getSamplingLevel()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getSamplingLevel</h4> <pre>public int getSamplingLevel()</pre> </li> </ul> <a name="getMaxNumberOfEntries()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getMaxNumberOfEntries</h4> <pre>public int getMaxNumberOfEntries()</pre> <div class="block">Returns the number of entries this summary would have if it were at the full sampling level, which is equal to the number of entries in the primary on-disk index divided by the min index interval.</div> </li> </ul> <a name="getOffHeapSize()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getOffHeapSize</h4> <pre>public long getOffHeapSize()</pre> <div class="block">Returns the amount of off-heap memory used for this summary.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>size in bytes</dd></dl> </li> </ul> <a name="getEffectiveIndexIntervalAfterIndex(int)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getEffectiveIndexIntervalAfterIndex</h4> <pre>public int getEffectiveIndexIntervalAfterIndex(int index)</pre> <div class="block">Returns the number of primary (on-disk) index entries between the index summary entry at `index` and the next index summary entry (assuming there is one). Without any downsampling, this will always be equivalent to the index interval.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of an index summary entry (between zero and the index entry size)</dd> <dt><span class="strong">Returns:</span></dt><dd>the number of partitions after `index` until the next partition with a summary entry</dd></dl> </li> </ul> <a name="close()">  </a> <ul class="blockList"> <li class="blockList"> <h4>close</h4> <pre>public void close()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>close</code> in interface <code>java.io.Closeable</code></dd> <dt><strong>Specified by:</strong></dt> <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> </dl> </li> </ul> <a name="readOnlyClone()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>readOnlyClone</h4> <pre>public <a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.html" title="class in org.apache.cassandra.io.sstable">IndexSummary</a> readOnlyClone()</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/IndexSummary.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/io/sstable/IndexHelper.IndexInfo.Serializer.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/io/sstable/IndexSummary.IndexSummarySerializer.html" title="class in org.apache.cassandra.io.sstable"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/io/sstable/IndexSummary.html" target="_top">Frames</a></li> <li><a href="IndexSummary.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>