UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

513 lines (512 loc) 34.2 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 --> <title>CompositesIndex (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="CompositesIndex (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/CompositesIndex.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>Prev Class</li> <li><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/cassandra/db/index/composites/CompositesIndex.html" target="_top">Frames</a></li> <li><a href="CompositesIndex.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:&nbsp;</li> <li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.composites</div> <h2 title="Class CompositesIndex" class="title">Class CompositesIndex</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">org.apache.cassandra.db.index.SecondaryIndex</a></li> <li> <ul class="inheritance"> <li><a href="../../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">org.apache.cassandra.db.index.PerColumnSecondaryIndex</a></li> <li> <ul class="inheritance"> <li><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.db.index.composites.CompositesIndex</li> </ul> </li> </ul> </li> </ul> </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/CompositesIndexOnClusteringKey.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndexOnClusteringKey</a>, <a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndexOnCollectionKey.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndexOnCollectionKey</a>, <a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndexOnCollectionValue.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndexOnCollectionValue</a>, <a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndexOnPartitionKey.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndexOnPartitionKey</a>, <a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndexOnRegular.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndexOnRegular</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">CompositesIndex</span> extends <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">AbstractSimplePerColumnSecondaryIndex</a></pre> <div class="block">Base class for secondary indexes where composites are involved.</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">&nbsp;</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&nbsp;</code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a></strong></code>&nbsp;</td> </tr> </table> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.db.index.<a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">AbstractSimplePerColumnSecondaryIndex</a></h3> <code><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#columnDef">columnDef</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#indexCfs">indexCfs</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.db.index.<a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></h3> <code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#baseCfs">baseCfs</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#columnDefs">columnDefs</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#CUSTOM_INDEX_OPTION_NAME">CUSTOM_INDEX_OPTION_NAME</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#keyComparator">keyComparator</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#logger">logger</a></code></li> </ul> </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">&nbsp;</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/composites/CompositesIndex.html#CompositesIndex()">CompositesIndex</a></strong>()</code>&nbsp;</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">&nbsp;</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 <a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#create(org.apache.cassandra.config.ColumnDefinition)">create</a></strong>(<a href="../../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&nbsp;cfDef)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html" title="class in org.apache.cassandra.db.index">SecondaryIndexSearcher</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#createSecondaryIndexSearcher(java.util.Set)">createSecondaryIndexSearcher</a></strong>(java.util.Set&lt;java.nio.ByteBuffer&gt;&nbsp;columns)</code> <div class="block">Called at query time Creates a implementation specific searcher instance for this index type</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract <a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#decodeEntry(org.apache.cassandra.db.DecoratedKey,%20org.apache.cassandra.db.Cell)">decodeEntry</a></strong>(<a href="../../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>&nbsp;indexedValue, <a href="../../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;indexEntry)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#delete(org.apache.cassandra.db.index.composites.CompositesIndex.IndexedEntry,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">delete</a></strong>(<a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a>&nbsp;entry, <a href="../../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&nbsp;opGroup)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a>&lt;?&gt;</code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#getExpressionComparator()">getExpressionComparator</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#getIndexComparator()">getIndexComparator</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#getIndexComparator(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.config.ColumnDefinition)">getIndexComparator</a></strong>(<a href="../../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;baseMetadata, <a href="../../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&nbsp;cfDef)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#isStale(org.apache.cassandra.db.index.composites.CompositesIndex.IndexedEntry,%20org.apache.cassandra.db.ColumnFamily,%20long)">isStale</a></strong>(<a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a>&nbsp;entry, <a href="../../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&nbsp;data, long&nbsp;now)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected <a href="../../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#makeIndexColumnName(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell)">makeIndexColumnName</a></strong>(java.nio.ByteBuffer&nbsp;rowKey, <a href="../../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;cell)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected abstract <a href="../../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#makeIndexColumnPrefix(java.nio.ByteBuffer,%20org.apache.cassandra.db.composites.Composite)">makeIndexColumnPrefix</a></strong>(java.nio.ByteBuffer&nbsp;rowKey, <a href="../../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;columnName)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html#validateOptions()">validateOptions</a></strong>()</code> <div class="block">Validates the index_options passed in the ColumnDef</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.db.index.<a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">AbstractSimplePerColumnSecondaryIndex</a></h3> <code><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#delete(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">delete</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#estimateResultRows()">estimateResultRows</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#expressionString(org.apache.cassandra.db.IndexExpression)">expressionString</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#forceBlockingFlush()">forceBlockingFlush</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexCfs()">getIndexCfs</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexedValue(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell)">getIndexedValue</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexKeyComparator()">getIndexKeyComparator</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexKeyFor(java.nio.ByteBuffer)">getIndexKeyFor</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexName()">getIndexName</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#init()">init</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#insert(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">insert</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#invalidate()">invalidate</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#reload()">reload</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#removeIndex(java.nio.ByteBuffer)">removeIndex</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#truncateBlocking(long)">truncateBlocking</a>, <a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#update(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">update</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.index.PerColumnSecondaryIndex"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.db.index.<a href="../../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">PerColumnSecondaryIndex</a></h3> <code><a href="../../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#getNameForSystemKeyspace(java.nio.ByteBuffer)">getNameForSystemKeyspace</a>, <a href="../../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#validate(org.apache.cassandra.db.Cell)">validate</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.db.index.<a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></h3> <code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#buildIndexAsync()">buildIndexAsync</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#buildIndexBlocking()">buildIndexBlocking</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#createInstance(org.apache.cassandra.db.ColumnFamilyStore,%20org.apache.cassandra.config.ColumnDefinition)">createInstance</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getBaseCfs()">getBaseCfs</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getColumnDefs()">getColumnDefs</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#indexes(org.apache.cassandra.db.composites.CellName)">indexes</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#isIndexBuilt(java.nio.ByteBuffer)">isIndexBuilt</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#setIndexBuilt()">setIndexBuilt</a>, <a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#setIndexRemoved()">setIndexRemoved</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&nbsp;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="CompositesIndex()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CompositesIndex</h4> <pre>public&nbsp;CompositesIndex()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getIndexComparator()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexComparator</h4> <pre>protected&nbsp;<a href="../../../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a>&nbsp;getIndexComparator()</pre> </li> </ul> <a name="create(org.apache.cassandra.config.ColumnDefinition)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>create</h4> <pre>public static&nbsp;<a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex</a>&nbsp;create(<a href="../../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&nbsp;cfDef)</pre> </li> </ul> <a name="getIndexComparator(org.apache.cassandra.config.CFMetaData, org.apache.cassandra.config.ColumnDefinition)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexComparator</h4> <pre>public static&nbsp;<a href="../../../../../../org/apache/cassandra/db/composites/CellNameType.html" title="interface in org.apache.cassandra.db.composites">CellNameType</a>&nbsp;getIndexComparator(<a href="../../../../../../org/apache/cassandra/config/CFMetaData.html" title="class in org.apache.cassandra.config">CFMetaData</a>&nbsp;baseMetadata, <a href="../../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a>&nbsp;cfDef)</pre> </li> </ul> <a name="makeIndexColumnName(java.nio.ByteBuffer, org.apache.cassandra.db.Cell)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeIndexColumnName</h4> <pre>protected&nbsp;<a href="../../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a>&nbsp;makeIndexColumnName(java.nio.ByteBuffer&nbsp;rowKey, <a href="../../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;cell)</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#makeIndexColumnName(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell)">makeIndexColumnName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">AbstractSimplePerColumnSecondaryIndex</a></code></dd> </dl> </li> </ul> <a name="makeIndexColumnPrefix(java.nio.ByteBuffer, org.apache.cassandra.db.composites.Composite)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>makeIndexColumnPrefix</h4> <pre>protected abstract&nbsp;<a href="../../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;makeIndexColumnPrefix(java.nio.ByteBuffer&nbsp;rowKey, <a href="../../../../../../org/apache/cassandra/db/composites/Composite.html" title="interface in org.apache.cassandra.db.composites">Composite</a>&nbsp;columnName)</pre> </li> </ul> <a name="decodeEntry(org.apache.cassandra.db.DecoratedKey, org.apache.cassandra.db.Cell)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>decodeEntry</h4> <pre>public abstract&nbsp;<a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a>&nbsp;decodeEntry(<a href="../../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a>&nbsp;indexedValue, <a href="../../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a>&nbsp;indexEntry)</pre> </li> </ul> <a name="isStale(org.apache.cassandra.db.index.composites.CompositesIndex.IndexedEntry, org.apache.cassandra.db.ColumnFamily, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isStale</h4> <pre>public abstract&nbsp;boolean&nbsp;isStale(<a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a>&nbsp;entry, <a href="../../../../../../org/apache/cassandra/db/ColumnFamily.html" title="class in org.apache.cassandra.db">ColumnFamily</a>&nbsp;data, long&nbsp;now)</pre> </li> </ul> <a name="delete(org.apache.cassandra.db.index.composites.CompositesIndex.IndexedEntry, org.apache.cassandra.utils.concurrent.OpOrder.Group)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>delete</h4> <pre>public&nbsp;void&nbsp;delete(<a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex.IndexedEntry</a>&nbsp;entry, <a href="../../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a>&nbsp;opGroup)</pre> </li> </ul> <a name="getExpressionComparator()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getExpressionComparator</h4> <pre>protected&nbsp;<a href="../../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a>&lt;?&gt;&nbsp;getExpressionComparator()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getExpressionComparator()">getExpressionComparator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">AbstractSimplePerColumnSecondaryIndex</a></code></dd> </dl> </li> </ul> <a name="createSecondaryIndexSearcher(java.util.Set)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>createSecondaryIndexSearcher</h4> <pre>public&nbsp;<a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndexSearcher.html" title="class in org.apache.cassandra.db.index">SecondaryIndexSearcher</a>&nbsp;createSecondaryIndexSearcher(java.util.Set&lt;java.nio.ByteBuffer&gt;&nbsp;columns)</pre> <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#createSecondaryIndexSearcher(java.util.Set)">SecondaryIndex</a></code></strong></div> <div class="block">Called at query time Creates a implementation specific searcher instance for this index type</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#createSecondaryIndexSearcher(java.util.Set)">createSecondaryIndexSearcher</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>columns</code> - the list of columns which belong to this index type</dd> <dt><span class="strong">Returns:</span></dt><dd>the secondary index search impl</dd></dl> </li> </ul> <a name="validateOptions()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>validateOptions</h4> <pre>public&nbsp;void&nbsp;validateOptions() throws <a href="../../../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></pre> <div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#validateOptions()">SecondaryIndex</a></code></strong></div> <div class="block">Validates the index_options passed in the ColumnDef</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#validateOptions()">validateOptions</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../../../org/apache/cassandra/exceptions/ConfigurationException.html" title="class in org.apache.cassandra.exceptions">ConfigurationException</a></code></dd></dl> </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/CompositesIndex.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>Prev Class</li> <li><a href="../../../../../../org/apache/cassandra/db/index/composites/CompositesIndex.IndexedEntry.html" title="class in org.apache.cassandra.db.index.composites"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/cassandra/db/index/composites/CompositesIndex.html" target="_top">Frames</a></li> <li><a href="CompositesIndex.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:&nbsp;</li> <li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>