javadocAggregate/org/apache/calcite/plan/AbstractRelOptPlanner.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>AbstractRelOptPlanner (Apache Calcite calcite API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="AbstractRelOptPlanner (Apache Calcite calcite API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":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";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</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 class="aboutLanguage"><b>Apache Calcite</b></div>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.plan</a></div>
 <h2 title="Class AbstractRelOptPlanner" class="title">Class AbstractRelOptPlanner</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li>org.apache.calcite.plan.AbstractRelOptPlanner</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="hep/HepPlanner.html" title="class in org.apache.calcite.plan.hep">HepPlanner</a></code>, <code><a href="volcano/VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a></code></dd>
 </dl>
 <hr>
 <pre>public abstract class <span class="typeNameLabel">AbstractRelOptPlanner</span>
 extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
 implements <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></pre>
 <div class="block">Abstract base for implementations of the <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a> interface.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <ul class="blockList">
 <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.plan.RelOptPlanner">
 <!--   -->
 </a>
 <h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.plan.<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3>
 <code><a href="RelOptPlanner.CannotPlanException.html" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a>, <a href="RelOptPlanner.Executor.html" title="interface in org.apache.calcite.plan">RelOptPlanner.Executor</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- =========== FIELD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Field</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic" class="externalLink">AtomicBoolean</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancelFlag">cancelFlag</a></span></code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="Context.html" title="interface in org.apache.calcite.plan">Context</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#context">context</a></span></code></th>
 <td class="colLast">
 <div class="block">External context.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#costFactory">costFactory</a></span></code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mapDescToRule">mapDescToRule</a></span></code></th>
 <td class="colLast">
 <div class="block">Maps rule description to rule, just to ensure that rules' descriptions
  are unique.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.plan.RelOptPlanner">
 <!--   -->
 </a>
 <h3>Fields inherited from interface&nbsp;org.apache.calcite.plan.<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3>
 <code><a href="RelOptPlanner.html#LOGGER">LOGGER</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier</th>
 <th class="colSecond" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected </code></td>
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCostFactory,org.apache.calcite.plan.Context)">AbstractRelOptPlanner</a></span>&#8203;(<a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;costFactory,
                      <a href="Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;context)</code></th>
 <td class="colLast">
 <div class="block">Creates an AbstractRelOptPlanner.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <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="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a></span>&#8203;(<a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a>&nbsp;lattice)</code></th>
 <td class="colLast">
 <div class="block">Defines a lattice.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addListener(org.apache.calcite.plan.RelOptListener)">addListener</a></span>&#8203;(<a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a>&nbsp;newListener)</code></th>
 <td class="colLast">
 <div class="block">Adds a listener to this planner.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></span>&#8203;(<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&nbsp;materialization)</code></th>
 <td class="colLast">
 <div class="block">Defines a pair of relational expressions that are equivalent.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a></span>&#8203;(<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&nbsp;relTraitDef)</code></th>
 <td class="colLast">
 <div class="block">Registers a rel trait definition.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></span>&#8203;(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</code></th>
 <td class="colLast">
 <div class="block">Registers a rule.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkCancel()">checkCancel</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Checks to see whether cancellation has been requested, and if so, throws
  an exception.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#chooseDelegate()">chooseDelegate</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Negotiates an appropriate planner to deal with distributed queries.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Removes all internal state, including all registered rules,
  materialized views, and lattices.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearRelTraitDefs()">clearRelTraitDefs</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Clear all the registered RelTraitDef.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dumpRuleAttemptsInfo()">dumpRuleAttemptsInfo</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code><a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emptyTraitSet()">emptyTraitSet</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Creates an empty trait set.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireRule(org.apache.calcite.plan.RelOptRuleCall)">fireRule</a></span>&#8203;(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a>&nbsp;ruleCall)</code></th>
 <td class="colLast">
 <div class="block">Fires a rule, taking care of tracing and listener notification.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code><a href="Context.html" title="interface in org.apache.calcite.plan">Context</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Provides the Context created when this planner was constructed.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCost(org.apache.calcite.rel.RelNode)">getCost</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
        <a href="../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
 <td class="colLast">
 <div class="block">Computes the cost of a RelNode.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCostFactory()">getCostFactory</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the factory that creates
  <a href="RelOptCost.html" title="interface in org.apache.calcite.plan"><code>RelOptCost</code></a>s.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code><a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutor()">getExecutor</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the executor used to evaluate constant expressions.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code><a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a></span>&#8203;(<a href="RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a>&nbsp;table)</code></th>
 <td class="colLast">
 <div class="block">Retrieves a lattice, given its star table.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code><a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getListener()">getListener</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaterializations()">getMaterializations</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the materializations that have been registered with the planner.</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
 <td class="colLast">
 <div class="block">Gets a timestamp for a given rel's metadata.</div>
 </td>
 </tr>
 <tr id="i21" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelTraitDefs()">getRelTraitDefs</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the list of active trait types.</div>
 </td>
 </tr>
 <tr id="i22" class="altColor">
 <td class="colFirst"><code>protected <a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRuleByDescription(java.lang.String)">getRuleByDescription</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;description)</code></th>
 <td class="colLast">
 <div class="block">Returns the rule with a given description.</div>
 </td>
 </tr>
 <tr id="i23" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRules()">getRules</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the list of all registered rules.</div>
 </td>
 </tr>
 <tr id="i24" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRuleExcluded(org.apache.calcite.plan.RelOptRule)">isRuleExcluded</a></span>&#8203;(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</code></th>
 <td class="colLast">
 <div class="block">Determines whether a given rule is excluded by ruleDescExclusionFilter.</div>
 </td>
 </tr>
 <tr id="i25" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyChosen(org.apache.calcite.rel.RelNode)">notifyChosen</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
 <td class="colLast">
 <div class="block">Takes care of tracing and listener notification when a rel is chosen as
  part of the final plan.</div>
 </td>
 </tr>
 <tr id="i26" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyDiscard(org.apache.calcite.rel.RelNode)">notifyDiscard</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
 <td class="colLast">
 <div class="block">Takes care of tracing and listener notification when a rel is discarded.</div>
 </td>
 </tr>
 <tr id="i27" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyEquivalence(org.apache.calcite.rel.RelNode,java.lang.Object,boolean)">notifyEquivalence</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
                  <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;equivalenceClass,
                  boolean&nbsp;physical)</code></th>
 <td class="colLast">
 <div class="block">Takes care of tracing and listener notification when a rel equivalence is
  detected.</div>
 </td>
 </tr>
 <tr id="i28" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notifyTransformation(org.apache.calcite.plan.RelOptRuleCall,org.apache.calcite.rel.RelNode,boolean)">notifyTransformation</a></span>&#8203;(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a>&nbsp;ruleCall,
                     <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;newRel,
                     boolean&nbsp;before)</code></th>
 <td class="colLast">
 <div class="block">Takes care of tracing and listener notification when a rule's
  transformation is applied.</div>
 </td>
 </tr>
 <tr id="i29" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
       <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;newRel)</code></th>
 <td class="colLast">
 <div class="block">Called when a relational expression is copied to a similar expression.</div>
 </td>
 </tr>
 <tr id="i30" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onNewClass(org.apache.calcite.rel.RelNode)">onNewClass</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;node)</code></th>
 <td class="colLast">
 <div class="block">Called when a new class of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> is seen.</div>
 </td>
 </tr>
 <tr id="i31" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prune(org.apache.calcite.rel.RelNode)">prune</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
 <td class="colLast">
 <div class="block">Prunes a node from the planner.</div>
 </td>
 </tr>
 <tr id="i32" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerClass(org.apache.calcite.rel.RelNode)">registerClass</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;node)</code></th>
 <td class="colLast">
 <div class="block">Registers a class of RelNode.</div>
 </td>
 </tr>
 <tr id="i33" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&gt;&nbsp;list)</code></th>
 <td class="colLast">
 <div class="block">Gives this planner a chance to register one or more
  <a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata"><code>RelMetadataProvider</code></a>s in the chain which will be used to answer
  metadata queries.</div>
 </td>
 </tr>
 <tr id="i34" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a></span>&#8203;(<a href="RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a>&nbsp;schema)</code></th>
 <td class="colLast">
 <div class="block">Tells this planner that a schema exists.</div>
 </td>
 </tr>
 <tr id="i35" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></span>&#8203;(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</code></th>
 <td class="colLast">
 <div class="block">Removes a rule.</div>
 </td>
 </tr>
 <tr id="i36" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCancelFlag(org.apache.calcite.util.CancelFlag)">setCancelFlag</a></span>&#8203;(<a href="../util/CancelFlag.html" title="class in org.apache.calcite.util">CancelFlag</a>&nbsp;cancelFlag)</code></th>
 <td class="colLast">
 <div class="block">Does nothing.</div>
 </td>
 </tr>
 <tr id="i37" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExecutor(org.apache.calcite.rex.RexExecutor)">setExecutor</a></span>&#8203;(<a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a>&nbsp;executor)</code></th>
 <td class="colLast">
 <div class="block">Sets the object that can execute scalar expressions.</div>
 </td>
 </tr>
 <tr id="i38" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRuleDescExclusionFilter(java.util.regex.Pattern)">setRuleDescExclusionFilter</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex" class="externalLink">Pattern</a>&nbsp;exclusionFilter)</code></th>
 <td class="colLast">
 <div class="block">Sets the exclusion filter to use for this planner.</div>
 </td>
 </tr>
 <tr id="i39" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subClasses(java.lang.Class)">subClasses</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;clazz)</code></th>
 <td class="colLast">
 <div class="block">Returns sub-classes of relational expression.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.plan.RelOptPlanner">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.calcite.plan.<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3>
 <code><a href="RelOptPlanner.html#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">changeTraits</a>, <a href="RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">ensureRegistered</a>, <a href="RelOptPlanner.html#findBestExp()">findBestExp</a>, <a href="RelOptPlanner.html#getRoot()">getRoot</a>, <a href="RelOptPlanner.html#isRegistered(org.apache.calcite.rel.RelNode)">isRegistered</a>, <a href="RelOptPlanner.html#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">register</a>, <a href="RelOptPlanner.html#setRoot(org.apache.calcite.rel.RelNode)">setRoot</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a id="mapDescToRule">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>mapDescToRule</h4>
 <pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt; mapDescToRule</pre>
 <div class="block">Maps rule description to rule, just to ensure that rules' descriptions
  are unique.</div>
 </li>
 </ul>
 <a id="costFactory">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>costFactory</h4>
 <pre>protected final&nbsp;<a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a> costFactory</pre>
 </li>
 </ul>
 <a id="cancelFlag">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>cancelFlag</h4>
 <pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true" title="class or interface in java.util.concurrent.atomic" class="externalLink">AtomicBoolean</a> cancelFlag</pre>
 </li>
 </ul>
 <a id="context">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>context</h4>
 <pre>protected final&nbsp;<a href="Context.html" title="interface in org.apache.calcite.plan">Context</a> context</pre>
 <div class="block">External context. Never null.</div>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;(org.apache.calcite.plan.RelOptCostFactory,org.apache.calcite.plan.Context)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>AbstractRelOptPlanner</h4>
 <pre>protected&nbsp;AbstractRelOptPlanner&#8203;(<a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;costFactory,
                                 <a href="Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;context)</pre>
 <div class="block">Creates an AbstractRelOptPlanner.</div>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="clear()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clear</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#clear()">RelOptPlanner</a></code></span></div>
 <div class="block">Removes all internal state, including all registered rules,
  materialized views, and lattices.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="getContext()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getContext</h4>
 <pre class="methodSignature">public&nbsp;<a href="Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;getContext()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getContext()">RelOptPlanner</a></code></span></div>
 <div class="block">Provides the Context created when this planner was constructed.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getContext()">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Never null; either an externally defined context, or a dummy
  context that returns null for each requested interface</dd>
 </dl>
 </li>
 </ul>
 <a id="getCostFactory()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCostFactory</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;getCostFactory()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getCostFactory()">RelOptPlanner</a></code></span></div>
 <div class="block">Returns the factory that creates
  <a href="RelOptCost.html" title="interface in org.apache.calcite.plan"><code>RelOptCost</code></a>s.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getCostFactory()">getCostFactory</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="setCancelFlag(org.apache.calcite.util.CancelFlag)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setCancelFlag</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;setCancelFlag&#8203;(<a href="../util/CancelFlag.html" title="class in org.apache.calcite.util">CancelFlag</a>&nbsp;cancelFlag)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#setCancelFlag(org.apache.calcite.util.CancelFlag)">RelOptPlanner</a></code></span></div>
 <div class="block">Does nothing.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#setCancelFlag(org.apache.calcite.util.CancelFlag)">setCancelFlag</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>cancelFlag</code> - flag which the planner should periodically check</dd>
 </dl>
 </li>
 </ul>
 <a id="checkCancel()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>checkCancel</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;checkCancel()</pre>
 <div class="block">Checks to see whether cancellation has been requested, and if so, throws
  an exception.</div>
 </li>
 </ul>
 <a id="getRules()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRules</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;getRules()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getRules()">RelOptPlanner</a></code></span></div>
 <div class="block">Returns the list of all registered rules.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getRules()">getRules</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="addRule(org.apache.calcite.plan.RelOptRule)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addRule</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;addRule&#8203;(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div>
 <div class="block">Registers a rule.

  <p>If the rule has already been registered, does nothing.
  This method determines if the given rule is a
  <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> and pass the
  ConverterRule to all
  <a href="RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"><code>registered</code></a> RelTraitDef
  instances.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>whether the rule was added, as per
  <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true#add(E)" title="class or interface in java.util" class="externalLink"><code>Collection.add(E)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="removeRule(org.apache.calcite.plan.RelOptRule)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>removeRule</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;removeRule&#8203;(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div>
 <div class="block">Removes a rule.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the rule was present, as per
  <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util" class="externalLink"><code>Collection.remove(Object)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="getRuleByDescription(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRuleByDescription</h4>
 <pre class="methodSignature">protected&nbsp;<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;getRuleByDescription&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;description)</pre>
 <div class="block">Returns the rule with a given description.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>description</code> - Description</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Rule with given description, or null if not found</dd>
 </dl>
 </li>
 </ul>
 <a id="setRuleDescExclusionFilter(java.util.regex.Pattern)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setRuleDescExclusionFilter</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;setRuleDescExclusionFilter&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex" class="externalLink">Pattern</a>&nbsp;exclusionFilter)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#setRuleDescExclusionFilter(java.util.regex.Pattern)">RelOptPlanner</a></code></span></div>
 <div class="block">Sets the exclusion filter to use for this planner. Rules which match the
  given pattern will not be fired regardless of whether or when they are
  added to the planner.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#setRuleDescExclusionFilter(java.util.regex.Pattern)">setRuleDescExclusionFilter</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>exclusionFilter</code> - pattern to match for exclusion; null to disable
                         filtering</dd>
 </dl>
 </li>
 </ul>
 <a id="isRuleExcluded(org.apache.calcite.plan.RelOptRule)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isRuleExcluded</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;isRuleExcluded&#8203;(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</pre>
 <div class="block">Determines whether a given rule is excluded by ruleDescExclusionFilter.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rule</code> - rule to test</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true iff rule should be excluded</dd>
 </dl>
 </li>
 </ul>
 <a id="chooseDelegate()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>chooseDelegate</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;chooseDelegate()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#chooseDelegate()">RelOptPlanner</a></code></span></div>
 <div class="block">Negotiates an appropriate planner to deal with distributed queries. The
  idea is that the schemas decide among themselves which has the most
  knowledge. Right now, the local planner retains control.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#chooseDelegate()">chooseDelegate</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addMaterialization</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;addMaterialization&#8203;(<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&nbsp;materialization)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">RelOptPlanner</a></code></span></div>
 <div class="block">Defines a pair of relational expressions that are equivalent.

  <p>Typically <code>tableRel</code> is a
  <a href="../rel/logical/LogicalTableScan.html" title="class in org.apache.calcite.rel.logical"><code>LogicalTableScan</code></a> representing a
  table that is a materialized view and <code>queryRel</code> is the SQL
  expression that populates that view. The intention is that
  <code>tableRel</code> is cheaper to evaluate and therefore if the query being
  optimized uses (or can be rewritten to use) <code>queryRel</code> as a
  sub-expression then it can be optimized by using <code>tableRel</code>
  instead.</p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="getMaterializations()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMaterializations</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&gt;&nbsp;getMaterializations()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getMaterializations()">RelOptPlanner</a></code></span></div>
 <div class="block">Returns the materializations that have been registered with the planner.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getMaterializations()">getMaterializations</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="addLattice(org.apache.calcite.plan.RelOptLattice)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addLattice</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;addLattice&#8203;(<a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a>&nbsp;lattice)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">RelOptPlanner</a></code></span></div>
 <div class="block">Defines a lattice.

  <p>The lattice may have materializations; it is not necessary to call
  <a href="RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)"><code>RelOptPlanner.addMaterialization(org.apache.calcite.plan.RelOptMaterialization)</code></a> for these; they are registered implicitly.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="getLattice(org.apache.calcite.plan.RelOptTable)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLattice</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a>&nbsp;getLattice&#8203;(<a href="RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a>&nbsp;table)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">RelOptPlanner</a></code></span></div>
 <div class="block">Retrieves a lattice, given its star table.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="registerSchema(org.apache.calcite.plan.RelOptSchema)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>registerSchema</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;registerSchema&#8203;(<a href="RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a>&nbsp;schema)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">RelOptPlanner</a></code></span></div>
 <div class="block">Tells this planner that a schema exists. This is the schema's chance to
  tell the planner about all of the special transformation rules.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRelMetadataTimestamp</h4>
 <pre class="methodSignature">public&nbsp;long&nbsp;getRelMetadataTimestamp&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
 <div class="block">Gets a timestamp for a given rel's metadata. This timestamp is used by
  <a href="../rel/metadata/CachingRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata"><code>CachingRelMetadataProvider</code></a> to decide whether cached metadata has
  gone stale.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rel</code> - rel of interest</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>timestamp of last change which might affect metadata derivation</dd>
 </dl>
 </li>
 </ul>
 <a id="prune(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>prune</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;prune&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#prune(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
 <div class="block">Prunes a node from the planner.

  <p>When a node is pruned, the related pending rule
  calls are cancelled, and future rules will not fire.
  This can be used to reduce the search space. </p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#prune(org.apache.calcite.rel.RelNode)">prune</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rel</code> - the node to prune.</dd>
 </dl>
 </li>
 </ul>
 <a id="registerClass(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>registerClass</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;registerClass&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;node)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#registerClass(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
 <div class="block">Registers a class of RelNode. If this class of RelNode has been seen
  before, does nothing.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#registerClass(org.apache.calcite.rel.RelNode)">registerClass</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>node</code> - Relational expression</dd>
 </dl>
 </li>
 </ul>
 <a id="onNewClass(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>onNewClass</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;onNewClass&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;node)</pre>
 <div class="block">Called when a new class of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> is seen.</div>
 </li>
 </ul>
 <a id="emptyTraitSet()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>emptyTraitSet</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;emptyTraitSet()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#emptyTraitSet()">RelOptPlanner</a></code></span></div>
 <div class="block">Creates an empty trait set. It contains all registered traits, and the
  default values of any traits that have them.

  <p>The empty trait set acts as the prototype (a kind of factory) for all
  subsequently created trait sets.</p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#emptyTraitSet()">emptyTraitSet</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Empty trait set</dd>
 </dl>
 </li>
 </ul>
 <a id="getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCost</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;getCost&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
                           <a href="../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelOptPlanner</a></code></span></div>
 <div class="block">Computes the cost of a RelNode. In most cases, this just dispatches to
  <a href="../rel/metadata/RelMetadataQuery.html#getCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rel</code> - Relational expression of interest</dd>
 <dd><code>mq</code> - Metadata query</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>estimated cost</dd>
 </dl>
 </li>
 </ul>
 <a id="getCost(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCost</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;getCost&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode)">getCost</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="addListener(org.apache.calcite.plan.RelOptListener)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addListener</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;addListener&#8203;(<a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a>&nbsp;newListener)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#addListener(org.apache.calcite.plan.RelOptListener)">RelOptPlanner</a></code></span></div>
 <div class="block">Adds a listener to this planner.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#addListener(org.apache.calcite.plan.RelOptListener)">addListener</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>newListener</code> - new listener to be notified of events</dd>
 </dl>
 </li>
 </ul>
 <a id="registerMetadataProviders(java.util.List)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>registerMetadataProviders</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;registerMetadataProviders&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&gt;&nbsp;list)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#registerMetadataProviders(java.util.List)">RelOptPlanner</a></code></span></div>
 <div class="block">Gives this planner a chance to register one or more
  <a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata"><code>RelMetadataProvider</code></a>s in the chain which will be used to answer
  metadata queries.

  <p>Planners which use their own relational expressions internally
  to represent concepts such as equivalence classes will generally need to
  supply corresponding metadata providers.</p></div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>list</code> - receives planner's custom providers, if any</dd>
 </dl>
 </li>
 </ul>
 <a id="addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>addRelTraitDef</h4>
 <pre class="methodSignature">public&nbsp;boolean&nbsp;addRelTraitDef&#8203;(<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&nbsp;relTraitDef)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">RelOptPlanner</a></code></span></div>
 <div class="block">Registers a rel trait definition. If the <a href="RelTraitDef.html" title="class in org.apache.calcite.plan"><code>RelTraitDef</code></a> has already
  been registered, does nothing.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>whether the RelTraitDef was added, as per
  <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true#add(E)" title="class or interface in java.util" class="externalLink"><code>Collection.add(E)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="clearRelTraitDefs()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clearRelTraitDefs</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;clearRelTraitDefs()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#clearRelTraitDefs()">RelOptPlanner</a></code></span></div>
 <div class="block">Clear all the registered RelTraitDef.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#clearRelTraitDefs()">clearRelTraitDefs</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="getRelTraitDefs()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRelTraitDefs</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;&nbsp;getRelTraitDefs()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getRelTraitDefs()">RelOptPlanner</a></code></span></div>
 <div class="block">Returns the list of active trait types.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getRelTraitDefs()">getRelTraitDefs</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="setExecutor(org.apache.calcite.rex.RexExecutor)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setExecutor</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;setExecutor&#8203;(<a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a>&nbsp;executor)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#setExecutor(org.apache.calcite.rex.RexExecutor)">RelOptPlanner</a></code></span></div>
 <div class="block">Sets the object that can execute scalar expressions.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#setExecutor(org.apache.calcite.rex.RexExecutor)">setExecutor</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="getExecutor()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getExecutor</h4>
 <pre class="methodSignature">public&nbsp;<a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a>&nbsp;getExecutor()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#getExecutor()">RelOptPlanner</a></code></span></div>
 <div class="block">Returns the executor used to evaluate constant expressions.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#getExecutor()">getExecutor</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>onCopy</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;onCopy&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
                    <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;newRel)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
 <div class="block">Called when a relational expression is copied to a similar expression.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="RelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="dumpRuleAttemptsInfo()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>dumpRuleAttemptsInfo</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;dumpRuleAttemptsInfo()</pre>
 </li>
 </ul>
 <a id="fireRule(org.apache.calcite.plan.RelOptRuleCall)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>fireRule</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;fireRule&#8203;(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a>&nbsp;ruleCall)</pre>
 <div class="block">Fires a rule, taking care of tracing and listener notification.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ruleCall</code> - description of rule call</dd>
 </dl>
 </li>
 </ul>
 <a id="notifyTransformation(org.apache.calcite.plan.RelOptRuleCall,org.apache.calcite.rel.RelNode,boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>notifyTransformation</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;notifyTransformation&#8203;(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a>&nbsp;ruleCall,
                                     <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;newRel,
                                     boolean&nbsp;before)</pre>
 <div class="block">Takes care of tracing and listener notification when a rule's
  transformation is applied.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ruleCall</code> - description of rule call</dd>
 <dd><code>newRel</code> - result of transformation</dd>
 <dd><code>before</code> - true before registration of new rel; false after</dd>
 </dl>
 </li>
 </ul>
 <a id="notifyChosen(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>notifyChosen</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;notifyChosen&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
 <div class="block">Takes care of tracing and listener notification when a rel is chosen as
  part of the final plan.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rel</code> - chosen rel</dd>
 </dl>
 </li>
 </ul>
 <a id="notifyEquivalence(org.apache.calcite.rel.RelNode,java.lang.Object,boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>notifyEquivalence</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;notifyEquivalence&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
                                  <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;equivalenceClass,
                                  boolean&nbsp;physical)</pre>
 <div class="block">Takes care of tracing and listener notification when a rel equivalence is
  detected.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rel</code> - chosen rel</dd>
 </dl>
 </li>
 </ul>
 <a id="notifyDiscard(org.apache.calcite.rel.RelNode)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>notifyDiscard</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;notifyDiscard&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
 <div class="block">Takes care of tracing and listener notification when a rel is discarded.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rel</code> - Discarded rel</dd>
 </dl>
 </li>
 </ul>
 <a id="getListener()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getListener</h4>
 <pre class="methodSignature">public&nbsp;<a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a>&nbsp;getListener()</pre>
 </li>
 </ul>
 <a id="subClasses(java.lang.Class)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>subClasses</h4>
 <pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&gt;&nbsp;subClasses&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;clazz)</pre>
 <div class="block">Returns sub-classes of relational expression.</div>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</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 class="aboutLanguage"><b>Apache Calcite</b></div>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </body>
 </html>