| <!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"> |
| <meta name="description" content="declaration: package: org.apache.calcite.plan, class: AbstractRelOptPlanner"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">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 = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.plan</a></div> |
| <h1 title="Class AbstractRelOptPlanner" class="title">Class AbstractRelOptPlanner</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><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> |
| <div class="inheritance">org.apache.calcite.plan.AbstractRelOptPlanner</div> |
| </div> |
| <section class="description"> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="inheritedList"> |
| <h2>Nested classes/interfaces inherited from interface org.apache.calcite.plan.<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h2> |
| <a id="nested.classes.inherited.from.class.org.apache.calcite.plan.RelOptPlanner"> |
| <!-- --> |
| </a><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></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <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"> </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"> </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><<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>,​<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="#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> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h3>Fields inherited from interface org.apache.calcite.plan.<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3> |
| <a id="fields.inherited.from.class.org.apache.calcite.plan.RelOptPlanner"> |
| <!-- --> |
| </a><code><a href="RelOptPlanner.html#LOGGER">LOGGER</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <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>​(<a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a> costFactory, |
| <a href="Context.html" title="interface in org.apache.calcite.plan">Context</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an AbstractRelOptPlanner.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <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>​(<a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a> lattice)</code></th> |
| <td class="colLast"> |
| <div class="block">Defines a lattice.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <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>​(<a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a> newListener)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a listener to this planner.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <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>​(<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a> materialization)</code></th> |
| <td class="colLast"> |
| <div class="block">Defines a pair of relational expressions that are equivalent.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <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>​(<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a> relTraitDef)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers a rel trait definition.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <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>​(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers a rule.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <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 class="altColor" id="i6"> |
| <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 class="rowColor" id="i7"> |
| <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 class="altColor" id="i8"> |
| <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 class="rowColor" id="i9"> |
| <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"> </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <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 class="rowColor" id="i11"> |
| <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>​(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> ruleCall)</code></th> |
| <td class="colLast"> |
| <div class="block">Fires a rule, taking care of tracing and listener notification.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <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 class="rowColor" id="i13"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</code></th> |
| <td class="colLast"> |
| <div class="block">Computes the cost of a RelNode.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <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 class="altColor" id="i16"> |
| <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 class="rowColor" id="i17"> |
| <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>​(<a href="RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves a lattice, given its star table.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <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"> </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <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><<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>></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 class="altColor" id="i20"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a timestamp for a given rel's metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <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><<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>></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 class="altColor" id="i22"> |
| <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>​(<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> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the rule with a given description.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <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><<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="#getRules()">getRules</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the list of all registered rules.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <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>​(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether a given rule is excluded by ruleDescExclusionFilter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> 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 class="altColor" id="i26"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> 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 class="rowColor" id="i27"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> 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> equivalenceClass, |
| boolean 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 class="altColor" id="i28"> |
| <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>​(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> ruleCall, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> newRel, |
| boolean 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 class="rowColor" id="i29"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> newRel)</code></th> |
| <td class="colLast"> |
| <div class="block">Called when a relational expression is copied to a similar expression.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> 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 class="rowColor" id="i31"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></th> |
| <td class="colLast"> |
| <div class="block">Prunes a node from the planner.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <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>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> node)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers a class of RelNode.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <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>​(<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><<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>> 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 class="altColor" id="i34"> |
| <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>​(<a href="RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a> schema)</code></th> |
| <td class="colLast"> |
| <div class="block">Tells this planner that a schema exists.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <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>​(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes a rule.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <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>​(<a href="../util/CancelFlag.html" title="class in org.apache.calcite.util">CancelFlag</a> cancelFlag)</code></th> |
| <td class="colLast"> |
| <div class="block">Does nothing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <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>​(<a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a> executor)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the object that can execute scalar expressions.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <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>​(<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> exclusionFilter)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the exclusion filter to use for this planner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <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><<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><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#subClasses(java.lang.Class)">subClasses</a></span>​(<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><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> clazz)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns sub-classes of relational expression.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class 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> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><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></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.plan.<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.plan.RelOptPlanner"> |
| <!-- --> |
| </a><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></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="mapDescToRule">mapDescToRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><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><<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>,​<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="memberName">mapDescToRule</span></div> |
| <div class="block">Maps rule description to rule, just to ensure that rules' descriptions |
| are unique.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="costFactory">costFactory</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></span> <span class="memberName">costFactory</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cancelFlag">cancelFlag</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><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></span> <span class="memberName">cancelFlag</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="context">context</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="Context.html" title="interface in org.apache.calcite.plan">Context</a></span> <span class="memberName">context</span></div> |
| <div class="block">External context. Never null.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.plan.RelOptCostFactory,org.apache.calcite.plan.Context)">AbstractRelOptPlanner</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="memberName">AbstractRelOptPlanner</span>​(<span class="arguments"><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a> costFactory, |
| <a href="Context.html" title="interface in org.apache.calcite.plan">Context</a> context)</span></div> |
| <div class="block">Creates an AbstractRelOptPlanner.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clear()">clear</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">clear</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getContext()">getContext</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="Context.html" title="interface in org.apache.calcite.plan">Context</a></span> <span class="memberName">getContext</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getCostFactory()">getCostFactory</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></span> <span class="memberName">getCostFactory</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setCancelFlag(org.apache.calcite.util.CancelFlag)">setCancelFlag</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setCancelFlag</span>​(<span class="arguments"><a href="../util/CancelFlag.html" title="class in org.apache.calcite.util">CancelFlag</a> cancelFlag)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="checkCancel()">checkCancel</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">checkCancel</span>()</div> |
| <div class="block">Checks to see whether cancellation has been requested, and if so, throws |
| an exception.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRules()">getRules</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><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><<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="memberName">getRules</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">addRule</span>​(<span class="arguments"><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">removeRule</span>​(<span class="arguments"><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRuleByDescription(java.lang.String)">getRuleByDescription</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></span> <span class="memberName">getRuleByDescription</span>​(<span class="arguments"><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> description)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setRuleDescExclusionFilter(java.util.regex.Pattern)">setRuleDescExclusionFilter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setRuleDescExclusionFilter</span>​(<span class="arguments"><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> exclusionFilter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isRuleExcluded(org.apache.calcite.plan.RelOptRule)">isRuleExcluded</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isRuleExcluded</span>​(<span class="arguments"><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="chooseDelegate()">chooseDelegate</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></span> <span class="memberName">chooseDelegate</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">addMaterialization</span>​(<span class="arguments"><a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a> materialization)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getMaterializations()">getMaterializations</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><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><<a href="RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>></span> <span class="memberName">getMaterializations</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">addLattice</span>​(<span class="arguments"><a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a> lattice)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptLattice.html" title="class in org.apache.calcite.plan">RelOptLattice</a></span> <span class="memberName">getLattice</span>​(<span class="arguments"><a href="RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">registerSchema</span>​(<span class="arguments"><a href="RelOptSchema.html" title="interface in org.apache.calcite.plan">RelOptSchema</a> schema)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">long</span> <span class="memberName">getRelMetadataTimestamp</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prune(org.apache.calcite.rel.RelNode)">prune</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">prune</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerClass(org.apache.calcite.rel.RelNode)">registerClass</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">registerClass</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> node)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="onNewClass(org.apache.calcite.rel.RelNode)">onNewClass</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">onNewClass</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> node)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="emptyTraitSet()">emptyTraitSet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span> <span class="memberName">emptyTraitSet</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="memberName">getCost</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getCost(org.apache.calcite.rel.RelNode)">getCost</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="memberName">getCost</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode)">getCost</a></code> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addListener(org.apache.calcite.plan.RelOptListener)">addListener</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">addListener</span>​(<span class="arguments"><a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a> newListener)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="registerMetadataProviders(java.util.List)">registerMetadataProviders</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">registerMetadataProviders</span>​(<span class="arguments"><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><<a href="../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>> list)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">addRelTraitDef</span>​(<span class="arguments"><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a> relTraitDef)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clearRelTraitDefs()">clearRelTraitDefs</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">clearRelTraitDefs</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRelTraitDefs()">getRelTraitDefs</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><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><<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>></span> <span class="memberName">getRelTraitDefs</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setExecutor(org.apache.calcite.rex.RexExecutor)">setExecutor</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setExecutor</span>​(<span class="arguments"><a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a> executor)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getExecutor()">getExecutor</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></span> <span class="memberName">getExecutor</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">onCopy</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> newRel)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="dumpRuleAttemptsInfo()">dumpRuleAttemptsInfo</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">dumpRuleAttemptsInfo</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireRule(org.apache.calcite.plan.RelOptRuleCall)">fireRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">fireRule</span>​(<span class="arguments"><a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> ruleCall)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyTransformation(org.apache.calcite.plan.RelOptRuleCall,org.apache.calcite.rel.RelNode,boolean)">notifyTransformation</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyTransformation</span>​(<span class="arguments"><a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> ruleCall, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> newRel, |
| boolean before)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyChosen(org.apache.calcite.rel.RelNode)">notifyChosen</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyChosen</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyEquivalence(org.apache.calcite.rel.RelNode,java.lang.Object,boolean)">notifyEquivalence</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyEquivalence</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> 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> equivalenceClass, |
| boolean physical)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notifyDiscard(org.apache.calcite.rel.RelNode)">notifyDiscard</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">notifyDiscard</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getListener()">getListener</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></span> <span class="memberName">getListener</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="subClasses(java.lang.Class)">subClasses</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><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><<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><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>></span> <span class="memberName">subClasses</span>​(<span class="arguments"><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><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> clazz)</span></div> |
| <div class="block">Returns sub-classes of relational expression.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <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"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
