cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
365 lines (364 loc) • 16.6 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 -->
<title>IndexHelper (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="IndexHelper (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/IndexHelper.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/Downsampling.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/IndexHelper.IndexInfo.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/IndexHelper.html" target="_top">Frames</a></li>
<li><a href="IndexHelper.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: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </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>Field | </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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.io.sstable</div>
<h2 title="Class IndexHelper" class="title">Class IndexHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.io.sstable.IndexHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">IndexHelper</span>
extends java.lang.Object</pre>
<div class="block">Provides helper to serialize, deserialize and use column indexes.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<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/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a></strong></code> </td>
</tr>
</table>
</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"> </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/IndexHelper.html#IndexHelper()">IndexHelper</a></strong>()</code> </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"> </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 java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.html#deserializeIndex(org.apache.cassandra.io.util.FileDataInput,%20org.apache.cassandra.db.composites.CType)">deserializeIndex</a></strong>(<a href="../../../../../org/apache/cassandra/io/util/FileDataInput.html" title="interface in org.apache.cassandra.io.util">FileDataInput</a> in,
<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> type)</code>
<div class="block">Deserialize the index into a structure and return it</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Comparator<<a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.html#getComparator(org.apache.cassandra.db.composites.CType,%20boolean)">getComparator</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> nameComparator,
boolean reversed)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.html#indexFor(org.apache.cassandra.db.composites.Composite,%20java.util.List,%20org.apache.cassandra.db.composites.CType,%20boolean,%20int)">indexFor</a></strong>(<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> name,
java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a>> indexList,
<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> comparator,
boolean reversed,
int lastIndex)</code>
<div class="block">The index of the IndexInfo in which a scan starting with @name should begin.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.html#skipBloomFilter(java.io.DataInput)">skipBloomFilter</a></strong>(java.io.DataInput in)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.html#skipIndex(java.io.DataInput)">skipIndex</a></strong>(java.io.DataInput in)</code>
<div class="block">Skip the index</div>
</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IndexHelper()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IndexHelper</h4>
<pre>public IndexHelper()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="skipBloomFilter(java.io.DataInput)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipBloomFilter</h4>
<pre>public static void skipBloomFilter(java.io.DataInput in)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="skipIndex(java.io.DataInput)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipIndex</h4>
<pre>public static void skipIndex(java.io.DataInput in)
throws java.io.IOException</pre>
<div class="block">Skip the index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - the data input from which the index should be skipped</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd></dl>
</li>
</ul>
<a name="deserializeIndex(org.apache.cassandra.io.util.FileDataInput, org.apache.cassandra.db.composites.CType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserializeIndex</h4>
<pre>public static java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a>> deserializeIndex(<a href="../../../../../org/apache/cassandra/io/util/FileDataInput.html" title="interface in org.apache.cassandra.io.util">FileDataInput</a> in,
<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> type)
throws java.io.IOException</pre>
<div class="block">Deserialize the index into a structure and return it</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - input source</dd><dd><code>type</code> - the comparator type for the column family</dd>
<dt><span class="strong">Returns:</span></dt><dd>ArrayList<IndexInfo> - list of de-serialized indexes</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs.</dd></dl>
</li>
</ul>
<a name="indexFor(org.apache.cassandra.db.composites.Composite, java.util.List, org.apache.cassandra.db.composites.CType, boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexFor</h4>
<pre>public static int indexFor(<a href="../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a> name,
java.util.List<<a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a>> indexList,
<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> comparator,
boolean reversed,
int lastIndex)</pre>
<div class="block">The index of the IndexInfo in which a scan starting with @name should begin.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - name of the index</dd><dd><code>indexList</code> - list of the indexInfo objects</dd><dd><code>comparator</code> - comparator type</dd><dd><code>reversed</code> - is name reversed</dd>
<dt><span class="strong">Returns:</span></dt><dd>int index</dd></dl>
</li>
</ul>
<a name="getComparator(org.apache.cassandra.db.composites.CType, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getComparator</h4>
<pre>public static java.util.Comparator<<a href="../../../../../org/apache/cassandra/io/sstable/IndexHelper.IndexInfo.html" title="class in org.apache.cassandra.io.sstable">IndexHelper.IndexInfo</a>> getComparator(<a href="../../../../../org/apache/cassandra/db/composites/CType.html" title="interface in org.apache.cassandra.db.composites">CType</a> nameComparator,
boolean reversed)</pre>
</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/IndexHelper.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/Downsampling.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/IndexHelper.IndexInfo.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/IndexHelper.html" target="_top">Frames</a></li>
<li><a href="IndexHelper.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: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li>Field | </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>Field | </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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>