cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
366 lines (365 loc) • 15.9 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:26 CEST 2014 -->
<title>SecondaryIndexSearcher (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="SecondaryIndexSearcher (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/SecondaryIndexSearcher.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/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/index/SecondaryIndexSearcher.html" target="_top">Frames</a></li>
<li><a href="SecondaryIndexSearcher.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>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>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.db.index</div>
<h2 title="Class SecondaryIndexSearcher" class="title">Class SecondaryIndexSearcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.db.index.SecondaryIndexSearcher</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/cassandra/db/index/composites/CompositesSearcher.html" title="class in org.apache.cassandra.db.index.composites">CompositesSearcher</a>, <a href="../../../../../org/apache/cassandra/db/index/keys/KeysSearcher.html" title="class in org.apache.cassandra.db.index.keys">KeysSearcher</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">SecondaryIndexSearcher</span>
extends java.lang.Object</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>
<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>protected <a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#baseCfs">baseCfs</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Set<java.nio.ByteBuffer></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#columns">columns</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html" title="class in org.apache.cassandra.db.index">SecondaryIndexManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#indexManager">indexManager</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/db/index/SecondaryIndexSearcher.html#SecondaryIndexSearcher(org.apache.cassandra.db.index.SecondaryIndexManager,%20java.util.Set)">SecondaryIndexSearcher</a></strong>(<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html" title="class in org.apache.cassandra.db.index">SecondaryIndexManager</a> indexManager,
java.util.Set<java.nio.ByteBuffer> columns)</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#canHandleIndexClause(java.util.List)">canHandleIndexClause</a></strong>(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#highestSelectivityIndex(java.util.List)">highestSelectivityIndex</a></strong>(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#highestSelectivityPredicate(java.util.List)">highestSelectivityPredicate</a></strong>(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html#search(org.apache.cassandra.db.filter.ExtendedFilter)">search</a></strong>(<a href="../../../../../org/apache/cassandra/db/filter/ExtendedFilter.html" title="class in org.apache.cassandra.db.filter">ExtendedFilter</a> filter)</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="indexManager">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>indexManager</h4>
<pre>protected final <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html" title="class in org.apache.cassandra.db.index">SecondaryIndexManager</a> indexManager</pre>
</li>
</ul>
<a name="columns">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columns</h4>
<pre>protected final java.util.Set<java.nio.ByteBuffer> columns</pre>
</li>
</ul>
<a name="baseCfs">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>baseCfs</h4>
<pre>protected final <a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> baseCfs</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SecondaryIndexSearcher(org.apache.cassandra.db.index.SecondaryIndexManager, java.util.Set)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SecondaryIndexSearcher</h4>
<pre>public SecondaryIndexSearcher(<a href="../../../../../org/apache/cassandra/db/index/SecondaryIndexManager.html" title="class in org.apache.cassandra.db.index">SecondaryIndexManager</a> indexManager,
java.util.Set<java.nio.ByteBuffer> columns)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="highestSelectivityIndex(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>highestSelectivityIndex</h4>
<pre>public <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a> highestSelectivityIndex(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</pre>
</li>
</ul>
<a name="search(org.apache.cassandra.db.filter.ExtendedFilter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>search</h4>
<pre>public abstract java.util.List<<a href="../../../../../org/apache/cassandra/db/Row.html" title="class in org.apache.cassandra.db">Row</a>> search(<a href="../../../../../org/apache/cassandra/db/filter/ExtendedFilter.html" title="class in org.apache.cassandra.db.filter">ExtendedFilter</a> filter)</pre>
</li>
</ul>
<a name="canHandleIndexClause(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canHandleIndexClause</h4>
<pre>public boolean canHandleIndexClause(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true this index is able to handle the given index expressions.</dd></dl>
</li>
</ul>
<a name="highestSelectivityPredicate(java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>highestSelectivityPredicate</h4>
<pre>protected <a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a> highestSelectivityPredicate(java.util.List<<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a>> clause)</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/SecondaryIndexSearcher.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/index/SecondaryIndexManager.Updater.html" title="interface in org.apache.cassandra.db.index"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/db/index/SecondaryIndexSearcher.html" target="_top">Frames</a></li>
<li><a href="SecondaryIndexSearcher.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>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>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>