apidocs/org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html - drill-site - Git at Google

 <!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 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>AbstractIndexDescriptor (Drill : 1.20.3 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="AbstractIndexDescriptor (Drill : 1.20.3 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <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/AbstractIndexDescriptor.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/drill/exec/planner/index/AbstractIndexCollection.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexStatistics.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html" target="_top">Frames</a></li>
 <li><a href="AbstractIndexDescriptor.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>Nested&nbsp;|&nbsp;</li>
 <li><a href="#fields.inherited.from.class.org.apache.drill.exec.planner.index.DrillIndexDefinition">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.drill.exec.planner.index</div>
 <h2 title="Class AbstractIndexDescriptor" class="title">Class AbstractIndexDescriptor</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html" title="class in org.apache.drill.exec.planner.index">org.apache.drill.exec.planner.index.DrillIndexDefinition</a></li>
 <li>
 <ul class="inheritance">
 <li>org.apache.drill.exec.planner.index.AbstractIndexDescriptor</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDescriptor.html" title="class in org.apache.drill.exec.planner.index">DrillIndexDescriptor</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public abstract class <span class="typeNameLabel">AbstractIndexDescriptor</span>
 extends <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html" title="class in org.apache.drill.exec.planner.index">DrillIndexDefinition</a>
 implements <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></pre>
 <div class="block">Abstract base class for an Index descriptor</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>
 <ul class="blockList">
 <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.drill.exec.planner.index.IndexDefinition">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a></h3>
 <code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.IndexType.html" title="enum in org.apache.drill.exec.planner.index">IndexDefinition.IndexType</a></code></li>
 </ul>
 </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.drill.exec.planner.index.DrillIndexDefinition">
 <!--   -->
 </a>
 <h3>Fields inherited from class&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html" title="class in org.apache.drill.exec.planner.index">DrillIndexDefinition</a></h3>
 <code><a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#allIndexColumns">allIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#indexCollationContext">indexCollationContext</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#indexColumns">indexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#indexName">indexName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#indexType">indexType</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#nonIndexColumns">nonIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#nullsDirection">nullsDirection</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#rowKeyColumns">rowKeyColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#tableName">tableName</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#AbstractIndexDescriptor-java.util.List-org.apache.drill.exec.planner.index.CollationContext-java.util.List-java.util.List-java.lang.String-java.lang.String-org.apache.drill.exec.planner.index.IndexDefinition.IndexType-org.apache.calcite.rel.RelFieldCollation.NullDirection-">AbstractIndexDescriptor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/common/expression/LogicalExpression.html" title="interface in org.apache.drill.common.expression">LogicalExpression</a>&gt;&nbsp;indexCols,
                        <a href="../../../../../../org/apache/drill/exec/planner/index/CollationContext.html" title="class in org.apache.drill.exec.planner.index">CollationContext</a>&nbsp;indexCollationContext,
                        <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/common/expression/LogicalExpression.html" title="interface in org.apache.drill.common.expression">LogicalExpression</a>&gt;&nbsp;nonIndexCols,
                        <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/common/expression/LogicalExpression.html" title="interface in org.apache.drill.common.expression">LogicalExpression</a>&gt;&nbsp;rowKeyColumns,
                        <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;indexName,
                        <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableName,
                        <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.IndexType.html" title="enum in org.apache.drill.exec.planner.index">IndexDefinition.IndexType</a>&nbsp;type,
                        org.apache.calcite.rel.RelFieldCollation.NullDirection&nbsp;nullsDirection)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>org.apache.calcite.plan.RelOptCost</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#getCost-org.apache.drill.exec.planner.index.IndexProperties-org.apache.calcite.plan.RelOptPlanner-int-org.apache.drill.exec.physical.base.GroupScan-">getCost</a></span>(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a>&nbsp;indexProps,
        org.apache.calcite.plan.RelOptPlanner&nbsp;planner,
        int&nbsp;numProjectedFields,
        <a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a>&nbsp;primaryGroupScan)</code>
 <div class="block">Get the total cost of index access (I/O, CPU) in the context of the current query</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="../../../../../../org/apache/drill/exec/physical/base/IndexGroupScan.html" title="interface in org.apache.drill.exec.physical.base">IndexGroupScan</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#getIndexGroupScan--">getIndexGroupScan</a></span>()</code>
 <div class="block">Get an instance of the group scan associated with this index descriptor</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#getRows-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-">getRows</a></span>(org.apache.calcite.rel.RelNode&nbsp;scan,
        org.apache.calcite.rex.RexNode&nbsp;indexCondition)</code>
 <div class="block">Get the estimated row count for a single index condition</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#isAsyncIndex--">isAsyncIndex</a></span>()</code>
 <div class="block">Whether this index is maintained synchronously (i.e primary table updates are propagated to the index
  synchronously) or asynchronously with some delay.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#supportsFullTextSearch--">supportsFullTextSearch</a></span>()</code>
 <div class="block">Whether or not the index supports full-text search (to allow pushing down such filters)</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html#supportsRowCountStats--">supportsRowCountStats</a></span>()</code>
 <div class="block">Whether or not the index supports getting row count statistics</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.planner.index.DrillIndexDefinition">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html" title="class in org.apache.drill.exec.planner.index">DrillIndexDefinition</a></h3>
 <code><a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#allColumnsIndexed-java.util.Collection-">allColumnsIndexed</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#columnsInIndexFields-java.util.Collection-java.util.Collection-">columnsInIndexFields</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getCollation--">getCollation</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getCollationMap--">getCollationMap</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getIndexColumnOrdinal-org.apache.drill.common.expression.LogicalExpression-">getIndexColumnOrdinal</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getIndexColumns--">getIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getIndexName--">getIndexName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getIndexType--">getIndexType</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getNonIndexColumns--">getNonIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getNullsOrderingDirection--">getNullsOrderingDirection</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getRowKeyColumns--">getRowKeyColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#getTableName--">getTableName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#isCoveringIndex-java.util.List-">isCoveringIndex</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#pathExactIn-org.apache.drill.common.expression.SchemaPath-java.util.Collection-">pathExactIn</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#someColumnsIndexed-java.util.Collection-">someColumnsIndexed</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#someColumnsInIndexFields-java.util.Collection-java.util.Collection-">someColumnsInIndexFields</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/DrillIndexDefinition.html#toString--">toString</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.planner.index.IndexDescriptor">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></h3>
 <code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getFunctionalInfo--">getFunctionalInfo</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getPluginCostModel--">getPluginCostModel</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.exec.planner.index.IndexDefinition">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.drill.exec.planner.index.<a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html" title="interface in org.apache.drill.exec.planner.index">IndexDefinition</a></h3>
 <code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#allColumnsIndexed-java.util.Collection-">allColumnsIndexed</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getCollation--">getCollation</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getCollationMap--">getCollationMap</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexColumnOrdinal-org.apache.drill.common.expression.LogicalExpression-">getIndexColumnOrdinal</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexColumns--">getIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexName--">getIndexName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getIndexType--">getIndexType</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getNonIndexColumns--">getNonIndexColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getNullsOrderingDirection--">getNullsOrderingDirection</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getRowKeyColumns--">getRowKeyColumns</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#getTableName--">getTableName</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#isCoveringIndex-java.util.List-">isCoveringIndex</a>, <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.html#someColumnsIndexed-java.util.Collection-">someColumnsIndexed</a></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="AbstractIndexDescriptor-java.util.List-org.apache.drill.exec.planner.index.CollationContext-java.util.List-java.util.List-java.lang.String-java.lang.String-org.apache.drill.exec.planner.index.IndexDefinition.IndexType-org.apache.calcite.rel.RelFieldCollation.NullDirection-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>AbstractIndexDescriptor</h4>
 <pre>public&nbsp;AbstractIndexDescriptor(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/common/expression/LogicalExpression.html" title="interface in org.apache.drill.common.expression">LogicalExpression</a>&gt;&nbsp;indexCols,
                                <a href="../../../../../../org/apache/drill/exec/planner/index/CollationContext.html" title="class in org.apache.drill.exec.planner.index">CollationContext</a>&nbsp;indexCollationContext,
                                <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/common/expression/LogicalExpression.html" title="interface in org.apache.drill.common.expression">LogicalExpression</a>&gt;&nbsp;nonIndexCols,
                                <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/common/expression/LogicalExpression.html" title="interface in org.apache.drill.common.expression">LogicalExpression</a>&gt;&nbsp;rowKeyColumns,
                                <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;indexName,
                                <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;tableName,
                                <a href="../../../../../../org/apache/drill/exec/planner/index/IndexDefinition.IndexType.html" title="enum in org.apache.drill.exec.planner.index">IndexDefinition.IndexType</a>&nbsp;type,
                                org.apache.calcite.rel.RelFieldCollation.NullDirection&nbsp;nullsDirection)</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getRows-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRows</h4>
 <pre>public&nbsp;double&nbsp;getRows(org.apache.calcite.rel.RelNode&nbsp;scan,
                       org.apache.calcite.rex.RexNode&nbsp;indexCondition)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getRows-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-">IndexDescriptor</a></code></span></div>
 <div class="block">Get the estimated row count for a single index condition</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getRows-org.apache.calcite.rel.RelNode-org.apache.calcite.rex.RexNode-">getRows</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>scan</code> - The rel node corresponding to the primary table</dd>
 <dd><code>indexCondition</code> - The index condition (e.g index_col1 < 10 AND index_col2 = 'abc')</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The estimated row count</dd>
 </dl>
 </li>
 </ul>
 <a name="supportsRowCountStats--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>supportsRowCountStats</h4>
 <pre>public&nbsp;boolean&nbsp;supportsRowCountStats()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#supportsRowCountStats--">IndexDescriptor</a></code></span></div>
 <div class="block">Whether or not the index supports getting row count statistics</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#supportsRowCountStats--">supportsRowCountStats</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>True if index supports getting row count, False otherwise</dd>
 </dl>
 </li>
 </ul>
 <a name="getIndexGroupScan--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getIndexGroupScan</h4>
 <pre>public&nbsp;<a href="../../../../../../org/apache/drill/exec/physical/base/IndexGroupScan.html" title="interface in org.apache.drill.exec.physical.base">IndexGroupScan</a>&nbsp;getIndexGroupScan()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getIndexGroupScan--">IndexDescriptor</a></code></span></div>
 <div class="block">Get an instance of the group scan associated with this index descriptor</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getIndexGroupScan--">getIndexGroupScan</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>An instance of group scan for this index</dd>
 </dl>
 </li>
 </ul>
 <a name="supportsFullTextSearch--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>supportsFullTextSearch</h4>
 <pre>public&nbsp;boolean&nbsp;supportsFullTextSearch()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#supportsFullTextSearch--">IndexDescriptor</a></code></span></div>
 <div class="block">Whether or not the index supports full-text search (to allow pushing down such filters)</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#supportsFullTextSearch--">supportsFullTextSearch</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>True if index supports full-text search, False otherwise</dd>
 </dl>
 </li>
 </ul>
 <a name="getCost-org.apache.drill.exec.planner.index.IndexProperties-org.apache.calcite.plan.RelOptPlanner-int-org.apache.drill.exec.physical.base.GroupScan-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCost</h4>
 <pre>public&nbsp;org.apache.calcite.plan.RelOptCost&nbsp;getCost(<a href="../../../../../../org/apache/drill/exec/planner/index/IndexProperties.html" title="interface in org.apache.drill.exec.planner.index">IndexProperties</a>&nbsp;indexProps,
                                                   org.apache.calcite.plan.RelOptPlanner&nbsp;planner,
                                                   int&nbsp;numProjectedFields,
                                                   <a href="../../../../../../org/apache/drill/exec/physical/base/GroupScan.html" title="interface in org.apache.drill.exec.physical.base">GroupScan</a>&nbsp;primaryGroupScan)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getCost-org.apache.drill.exec.planner.index.IndexProperties-org.apache.calcite.plan.RelOptPlanner-int-org.apache.drill.exec.physical.base.GroupScan-">IndexDescriptor</a></code></span></div>
 <div class="block">Get the total cost of index access (I/O, CPU) in the context of the current query</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#getCost-org.apache.drill.exec.planner.index.IndexProperties-org.apache.calcite.plan.RelOptPlanner-int-org.apache.drill.exec.physical.base.GroupScan-">getCost</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>indexProps</code> - properties (metrics) of a single index in the context of current query</dd>
 <dd><code>planner</code> - Planner instance</dd>
 <dd><code>numProjectedFields</code> - Number of projected fields</dd>
 <dd><code>primaryGroupScan</code> - Primary table's GroupScan instance</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a RelOptCost instance representing the total cost</dd>
 </dl>
 </li>
 </ul>
 <a name="isAsyncIndex--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>isAsyncIndex</h4>
 <pre>public&nbsp;boolean&nbsp;isAsyncIndex()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#isAsyncIndex--">IndexDescriptor</a></code></span></div>
 <div class="block">Whether this index is maintained synchronously (i.e primary table updates are propagated to the index
  synchronously) or asynchronously with some delay.  The latter is more common for distributed NoSQL databases.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html#isAsyncIndex--">isAsyncIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/drill/exec/planner/index/IndexDescriptor.html" title="interface in org.apache.drill.exec.planner.index">IndexDescriptor</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>True if the index is maintained asynchronously, False otherwise</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>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <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/AbstractIndexDescriptor.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/drill/exec/planner/index/AbstractIndexCollection.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/drill/exec/planner/index/AbstractIndexStatistics.html" title="class in org.apache.drill.exec.planner.index"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/drill/exec/planner/index/AbstractIndexDescriptor.html" target="_top">Frames</a></li>
 <li><a href="AbstractIndexDescriptor.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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>Nested&nbsp;|&nbsp;</li>
 <li><a href="#fields.inherited.from.class.org.apache.drill.exec.planner.index.DrillIndexDefinition">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 &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>