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>AbstractSimplePerColumnSecondaryIndex (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/AbstractSimplePerColumnSecondaryIndex.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/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" target="_top">Frames</a></li> <li><a href="AbstractSimplePerColumnSecondaryIndex.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.index</div> <h2 title="Class AbstractSimplePerColumnSecondaryIndex" class="title">Class AbstractSimplePerColumnSecondaryIndex</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>org.apache.cassandra.db.index.AbstractSimplePerColumnSecondaryIndex</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/CompositesIndex.html" title="class in org.apache.cassandra.db.index.composites">CompositesIndex</a>, <a href="../../../../../org/apache/cassandra/db/index/keys/KeysIndex.html" title="class in org.apache.cassandra.db.index.keys">KeysIndex</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">AbstractSimplePerColumnSecondaryIndex</span> extends <a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">PerColumnSecondaryIndex</a></pre> <div class="block">Implements a secondary index for a column family using a second column family in which the row keys are indexed values, and column names are base row keys.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <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/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#columnDef">columnDef</a></strong></code> </td> </tr> <tr class="rowColor"> <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/AbstractSimplePerColumnSecondaryIndex.html#indexCfs">indexCfs</a></strong></code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.db.index.SecondaryIndex">  </a> <h3>Fields inherited from class 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>  <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/AbstractSimplePerColumnSecondaryIndex.html#AbstractSimplePerColumnSecondaryIndex()">AbstractSimplePerColumnSecondaryIndex</a></strong>()</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>void</code></td> <td class="colLast"><code><strong><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></strong>(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell, <a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</code> <div class="block">Delete a column from the index.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#estimateResultRows()">estimateResultRows</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#expressionString(org.apache.cassandra.db.IndexExpression)">expressionString</a></strong>(<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a> expr)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#forceBlockingFlush()">forceBlockingFlush</a></strong>()</code> <div class="block">Forces this indexes' in memory data to disk</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getExpressionComparator()">getExpressionComparator</a></strong>()</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><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/AbstractSimplePerColumnSecondaryIndex.html#getIndexCfs()">getIndexCfs</a></strong>()</code> <div class="block">Allow access to the underlying column family store if there is one</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected abstract java.nio.ByteBuffer</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexedValue(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell)">getIndexedValue</a></strong>(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected <a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexKeyComparator()">getIndexKeyComparator</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><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/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexKeyFor(java.nio.ByteBuffer)">getIndexKeyFor</a></strong>(java.nio.ByteBuffer value)</code> <div class="block">Returns the decoratedKey for a column value</div> </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/index/AbstractSimplePerColumnSecondaryIndex.html#getIndexName()">getIndexName</a></strong>()</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#init()">init</a></strong>()</code> <div class="block">Perform any initialization work</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><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></strong>(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell, <a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</code> <div class="block">insert a column to the index</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#invalidate()">invalidate</a></strong>()</code> <div class="block">Remove the index and unregisters this index's mbean if one exists</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected abstract <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/AbstractSimplePerColumnSecondaryIndex.html#makeIndexColumnName(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell)">makeIndexColumnName</a></strong>(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#reload()">reload</a></strong>()</code> <div class="block">Reload an existing index following a change to its configuration, or that of the indexed column(s).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#removeIndex(java.nio.ByteBuffer)">removeIndex</a></strong>(java.nio.ByteBuffer columnName)</code> <div class="block">Delete all files and references to this index</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html#truncateBlocking(long)">truncateBlocking</a></strong>(long truncatedAt)</code> <div class="block">Truncate all the data from the current index</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><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></strong>(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> oldCol, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> col, <a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</code> <div class="block">update a column from the index</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.db.index.PerColumnSecondaryIndex">  </a> <h3>Methods inherited from class 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 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#createSecondaryIndexSearcher(java.util.Set)">createSecondaryIndexSearcher</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#getIndexComparator(org.apache.cassandra.config.CFMetaData,%20org.apache.cassandra.config.ColumnDefinition)">getIndexComparator</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>, <a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#validateOptions()">validateOptions</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 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="indexCfs">  </a> <ul class="blockList"> <li class="blockList"> <h4>indexCfs</h4> <pre>protected <a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> indexCfs</pre> </li> </ul> <a name="columnDef">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>columnDef</h4> <pre>protected <a href="../../../../../org/apache/cassandra/config/ColumnDefinition.html" title="class in org.apache.cassandra.config">ColumnDefinition</a> columnDef</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="constructor_detail">  </a> <h3>Constructor Detail</h3> <a name="AbstractSimplePerColumnSecondaryIndex()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>AbstractSimplePerColumnSecondaryIndex</h4> <pre>public AbstractSimplePerColumnSecondaryIndex()</pre> </li> </ul> </li> </ul>  <ul class="blockList"> <li class="blockList"><a name="method_detail">  </a> <h3>Method Detail</h3> <a name="init()">  </a> <ul class="blockList"> <li class="blockList"> <h4>init</h4> <pre>public void init()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#init()">SecondaryIndex</a></code></strong></div> <div class="block">Perform any initialization work</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#init()">init</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> </dl> </li> </ul> <a name="getIndexKeyComparator()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexKeyComparator</h4> <pre>protected <a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a><?> getIndexKeyComparator()</pre> </li> </ul> <a name="getIndexKeyFor(java.nio.ByteBuffer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexKeyFor</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/DecoratedKey.html" title="class in org.apache.cassandra.db">DecoratedKey</a> getIndexKeyFor(java.nio.ByteBuffer value)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexKeyFor(java.nio.ByteBuffer)">SecondaryIndex</a></code></strong></div> <div class="block">Returns the decoratedKey for a column value</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexKeyFor(java.nio.ByteBuffer)">getIndexKeyFor</a></code> in class <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>value</code> - column value</dd> <dt><span class="strong">Returns:</span></dt><dd>decorated key</dd></dl> </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 abstract <a href="../../../../../org/apache/cassandra/db/composites/CellName.html" title="interface in org.apache.cassandra.db.composites">CellName</a> makeIndexColumnName(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</pre> </li> </ul> <a name="getIndexedValue(java.nio.ByteBuffer, org.apache.cassandra.db.Cell)">  </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexedValue</h4> <pre>protected abstract java.nio.ByteBuffer getIndexedValue(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell)</pre> </li> </ul> <a name="getExpressionComparator()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getExpressionComparator</h4> <pre>protected abstract <a href="../../../../../org/apache/cassandra/db/marshal/AbstractType.html" title="class in org.apache.cassandra.db.marshal">AbstractType</a> getExpressionComparator()</pre> </li> </ul> <a name="expressionString(org.apache.cassandra.db.IndexExpression)">  </a> <ul class="blockList"> <li class="blockList"> <h4>expressionString</h4> <pre>public java.lang.String expressionString(<a href="../../../../../org/apache/cassandra/db/IndexExpression.html" title="class in org.apache.cassandra.db">IndexExpression</a> expr)</pre> </li> </ul> <a name="delete(java.nio.ByteBuffer, org.apache.cassandra.db.Cell, org.apache.cassandra.utils.concurrent.OpOrder.Group)">  </a> <ul class="blockList"> <li class="blockList"> <h4>delete</h4> <pre>public void delete(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell, <a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#delete(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">PerColumnSecondaryIndex</a></code></strong></div> <div class="block">Delete a column from the index.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#delete(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">delete</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">PerColumnSecondaryIndex</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>rowKey</code> - the underlying row key which is indexed</dd><dd><code>cell</code> - all the column info</dd></dl> </li> </ul> <a name="insert(java.nio.ByteBuffer, org.apache.cassandra.db.Cell, org.apache.cassandra.utils.concurrent.OpOrder.Group)">  </a> <ul class="blockList"> <li class="blockList"> <h4>insert</h4> <pre>public void insert(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> cell, <a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#insert(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">PerColumnSecondaryIndex</a></code></strong></div> <div class="block">insert a column to the index</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#insert(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">insert</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">PerColumnSecondaryIndex</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>rowKey</code> - the underlying row key which is indexed</dd><dd><code>cell</code> - all the column info</dd></dl> </li> </ul> <a name="update(java.nio.ByteBuffer, org.apache.cassandra.db.Cell, org.apache.cassandra.db.Cell, org.apache.cassandra.utils.concurrent.OpOrder.Group)">  </a> <ul class="blockList"> <li class="blockList"> <h4>update</h4> <pre>public void update(java.nio.ByteBuffer rowKey, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> oldCol, <a href="../../../../../org/apache/cassandra/db/Cell.html" title="interface in org.apache.cassandra.db">Cell</a> col, <a href="../../../../../org/apache/cassandra/utils/concurrent/OpOrder.Group.html" title="class in org.apache.cassandra.utils.concurrent">OpOrder.Group</a> opGroup)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html#update(java.nio.ByteBuffer,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.db.Cell,%20org.apache.cassandra.utils.concurrent.OpOrder.Group)">PerColumnSecondaryIndex</a></code></strong></div> <div class="block">update a column from the index</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.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> in class <code><a href="../../../../../org/apache/cassandra/db/index/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index">PerColumnSecondaryIndex</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>rowKey</code> - the underlying row key which is indexed</dd><dd><code>oldCol</code> - the previous column info</dd><dd><code>col</code> - all the column info</dd></dl> </li> </ul> <a name="removeIndex(java.nio.ByteBuffer)">  </a> <ul class="blockList"> <li class="blockList"> <h4>removeIndex</h4> <pre>public void removeIndex(java.nio.ByteBuffer columnName)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#removeIndex(java.nio.ByteBuffer)">SecondaryIndex</a></code></strong></div> <div class="block">Delete all files and references to this index</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#removeIndex(java.nio.ByteBuffer)">removeIndex</a></code> in class <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>columnName</code> - the indexed column to remove</dd></dl> </li> </ul> <a name="forceBlockingFlush()">  </a> <ul class="blockList"> <li class="blockList"> <h4>forceBlockingFlush</h4> <pre>public void forceBlockingFlush()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#forceBlockingFlush()">SecondaryIndex</a></code></strong></div> <div class="block">Forces this indexes' in memory data to disk</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#forceBlockingFlush()">forceBlockingFlush</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> </dl> </li> </ul> <a name="invalidate()">  </a> <ul class="blockList"> <li class="blockList"> <h4>invalidate</h4> <pre>public void invalidate()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#invalidate()">SecondaryIndex</a></code></strong></div> <div class="block">Remove the index and unregisters this index's mbean if one exists</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#invalidate()">invalidate</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> </dl> </li> </ul> <a name="truncateBlocking(long)">  </a> <ul class="blockList"> <li class="blockList"> <h4>truncateBlocking</h4> <pre>public void truncateBlocking(long truncatedAt)</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#truncateBlocking(long)">SecondaryIndex</a></code></strong></div> <div class="block">Truncate all the data from the current index</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#truncateBlocking(long)">truncateBlocking</a></code> in class <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>truncatedAt</code> - The truncation timestamp, all data before that timestamp should be rejected.</dd></dl> </li> </ul> <a name="getIndexCfs()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexCfs</h4> <pre>public <a href="../../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> getIndexCfs()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexCfs()">SecondaryIndex</a></code></strong></div> <div class="block">Allow access to the underlying column family store if there is one</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexCfs()">getIndexCfs</a></code> in class <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">Returns:</span></dt><dd>the underlying column family store or null</dd></dl> </li> </ul> <a name="getIndexName()">  </a> <ul class="blockList"> <li class="blockList"> <h4>getIndexName</h4> <pre>public java.lang.String getIndexName()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#getIndexName()">getIndexName</a></code> in class <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">Returns:</span></dt><dd>The name of the index</dd></dl> </li> </ul> <a name="reload()">  </a> <ul class="blockList"> <li class="blockList"> <h4>reload</h4> <pre>public void reload()</pre> <div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#reload()">SecondaryIndex</a></code></strong></div> <div class="block">Reload an existing index following a change to its configuration, or that of the indexed column(s). Differs from init() in that we expect expect new resources (such as CFS for a KEYS index) to be created by init() but not here</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#reload()">reload</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> </dl> </li> </ul> <a name="estimateResultRows()">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>estimateResultRows</h4> <pre>public long estimateResultRows()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html#estimateResultRows()">estimateResultRows</a></code> in class <code><a href="../../../../../org/apache/cassandra/db/index/SecondaryIndex.html" title="class in org.apache.cassandra.db.index">SecondaryIndex</a></code></dd> </dl> </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/AbstractSimplePerColumnSecondaryIndex.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/PerColumnSecondaryIndex.html" title="class in org.apache.cassandra.db.index"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/db/index/AbstractSimplePerColumnSecondaryIndex.html" target="_top">Frames</a></li> <li><a href="AbstractSimplePerColumnSecondaryIndex.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>