| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MockRelOptPlanner (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.test, class: MockRelOptPlanner"> |
| <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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.test</a></div> |
| <h1 title="Class MockRelOptPlanner" class="title">Class MockRelOptPlanner</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.AbstractRelOptPlanner</a> |
| <div class="inheritance">org.apache.calcite.test.MockRelOptPlanner</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MockRelOptPlanner</span> |
| <span class="extends-implements">extends <a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></span></div> |
| <div class="block">MockRelOptPlanner is a mock implementation of the <a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a> |
| interface.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.plan.RelOptPlanner">Nested classes/interfaces inherited from interface org.apache.calcite.plan.<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h2> |
| <code><a href="../plan/RelOptPlanner.CannotPlanException.html" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a>, <a href="../plan/RelOptPlanner.Executor.html" title="interface in org.apache.calcite.plan">RelOptPlanner.Executor</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.plan.AbstractRelOptPlanner">Fields inherited from class org.apache.calcite.plan.<a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></h3> |
| <code><a href="../plan/AbstractRelOptPlanner.html#cancelFlag">cancelFlag</a>, <a href="../plan/AbstractRelOptPlanner.html#context">context</a>, <a href="../plan/AbstractRelOptPlanner.html#costFactory">costFactory</a>, <a href="../plan/AbstractRelOptPlanner.html#mapDescToRule">mapDescToRule</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.plan.RelOptPlanner">Fields inherited from interface org.apache.calcite.plan.<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3> |
| <code><a href="../plan/RelOptPlanner.html#LOGGER">LOGGER</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.Context)" class="member-name-link">MockRelOptPlanner</a><wbr>(<a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a> context)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates MockRelOptPlanner.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRule(org.apache.calcite.plan.RelOptRule)" class="member-name-link">addRule</a><wbr>(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a rule.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">changeTraits</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Changes a relational expression to an equivalent one with a different set |
| of traits.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes all internal state, including all registered rules, |
| materialized views, and lattices.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)" class="member-name-link">ensureRegistered</a><wbr>(<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> equivRel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a relational expression if it is not already registered.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findBestExp()" class="member-name-link">findBestExp</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Finds the most efficient expression to implement this query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)" class="member-name-link">getRelMetadataTimestamp</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoot()" class="member-name-link">getRoot</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the root node of this query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRules()" class="member-name-link">getRules</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the list of all registered rules.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRegistered(org.apache.calcite.rel.RelNode)" class="member-name-link">isRegistered</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether a relational expression has been registered.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)" class="member-name-link">register</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| @Nullable <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> equivRel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a relational expression in the expression bank.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeRule(org.apache.calcite.plan.RelOptRule)" class="member-name-link">removeRule</a><wbr>(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes a rule.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setRelMetadataTimestamp(long)" class="member-name-link">setRelMetadataTimestamp</a><wbr>(long metadataTimestamp)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRoot(org.apache.calcite.rel.RelNode)" class="member-name-link">setRoot</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the root node of this query.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.plan.AbstractRelOptPlanner">Methods inherited from class org.apache.calcite.plan.<a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></h3> |
| <code><a href="../plan/AbstractRelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a>, <a href="../plan/AbstractRelOptPlanner.html#addListener(org.apache.calcite.plan.RelOptListener)">addListener</a>, <a href="../plan/AbstractRelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a>, <a href="../plan/AbstractRelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a>, <a href="../plan/AbstractRelOptPlanner.html#checkCancel()">checkCancel</a>, <a href="../plan/AbstractRelOptPlanner.html#chooseDelegate()">chooseDelegate</a>, <a href="../plan/AbstractRelOptPlanner.html#clearRelTraitDefs()">clearRelTraitDefs</a>, <a href="../plan/AbstractRelOptPlanner.html#dumpRuleAttemptsInfo()">dumpRuleAttemptsInfo</a>, <a href="../plan/AbstractRelOptPlanner.html#emptyTraitSet()">emptyTraitSet</a>, <a href="../plan/AbstractRelOptPlanner.html#fireRule(org.apache.calcite.plan.RelOptRuleCall)">fireRule</a>, <a href="../plan/AbstractRelOptPlanner.html#getContext()">getContext</a>, <a href="../plan/AbstractRelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode)">getCost</a>, <a href="../plan/AbstractRelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a>, <a href="../plan/AbstractRelOptPlanner.html#getCostFactory()">getCostFactory</a>, <a href="../plan/AbstractRelOptPlanner.html#getExecutor()">getExecutor</a>, <a href="../plan/AbstractRelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a>, <a href="../plan/AbstractRelOptPlanner.html#getListener()">getListener</a>, <a href="../plan/AbstractRelOptPlanner.html#getMaterializations()">getMaterializations</a>, <a href="../plan/AbstractRelOptPlanner.html#getRelTraitDefs()">getRelTraitDefs</a>, <a href="../plan/AbstractRelOptPlanner.html#getRuleByDescription(java.lang.String)">getRuleByDescription</a>, <a href="../plan/AbstractRelOptPlanner.html#isRuleExcluded(org.apache.calcite.plan.RelOptRule)">isRuleExcluded</a>, <a href="../plan/AbstractRelOptPlanner.html#notifyChosen(org.apache.calcite.rel.RelNode)">notifyChosen</a>, <a href="../plan/AbstractRelOptPlanner.html#notifyDiscard(org.apache.calcite.rel.RelNode)">notifyDiscard</a>, <a href="../plan/AbstractRelOptPlanner.html#notifyEquivalence(org.apache.calcite.rel.RelNode,java.lang.Object,boolean)">notifyEquivalence</a>, <a href="../plan/AbstractRelOptPlanner.html#notifyTransformation(org.apache.calcite.plan.RelOptRuleCall,org.apache.calcite.rel.RelNode,boolean)">notifyTransformation</a>, <a href="../plan/AbstractRelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a>, <a href="../plan/AbstractRelOptPlanner.html#onNewClass(org.apache.calcite.rel.RelNode)">onNewClass</a>, <a href="../plan/AbstractRelOptPlanner.html#prune(org.apache.calcite.rel.RelNode)">prune</a>, <a href="../plan/AbstractRelOptPlanner.html#registerClass(org.apache.calcite.rel.RelNode)">registerClass</a>, <a href="../plan/AbstractRelOptPlanner.html#registerMetadataProviders(java.util.List)">registerMetadataProviders</a>, <a href="../plan/AbstractRelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a>, <a href="../plan/AbstractRelOptPlanner.html#setCancelFlag(org.apache.calcite.util.CancelFlag)">setCancelFlag</a>, <a href="../plan/AbstractRelOptPlanner.html#setExecutor(org.apache.calcite.rex.RexExecutor)">setExecutor</a>, <a href="../plan/AbstractRelOptPlanner.html#setRuleDescExclusionFilter(java.util.regex.Pattern)">setRuleDescExclusionFilter</a>, <a href="../plan/AbstractRelOptPlanner.html#subClasses(java.lang.Class)">subClasses</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.Context)"> |
| <h3>MockRelOptPlanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">MockRelOptPlanner</span><wbr><span class="parameters">(<a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a> context)</span></div> |
| <div class="block">Creates MockRelOptPlanner.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setRoot(org.apache.calcite.rel.RelNode)"> |
| <h3>setRoot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRoot</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#setRoot(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Sets the root node of this query.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoot()"> |
| <h3>getRoot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">getRoot</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#getRoot()">RelOptPlanner</a></code></span></div> |
| <div class="block">Returns the root node of this query.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Root node</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptPlanner.html#clear()">clear</a></code> in interface <code><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../plan/AbstractRelOptPlanner.html#clear()">clear</a></code> in class <code><a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRules()"> |
| <h3>getRules</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>></span> <span class="element-name">getRules</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#getRules()">RelOptPlanner</a></code></span></div> |
| <div class="block">Returns the list of all registered rules.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptPlanner.html#getRules()">getRules</a></code> in interface <code><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../plan/AbstractRelOptPlanner.html#getRules()">getRules</a></code> in class <code><a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRule(org.apache.calcite.plan.RelOptRule)"> |
| <h3>addRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">addRule</span><wbr><span class="parameters">(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/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="../plan/RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"><code>registered</code></a> RelTraitDef |
| instances.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></code> in interface <code><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../plan/AbstractRelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></code> in class <code><a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether the rule was added, as per |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#add(E)" title="class or interface in java.util" class="external-link"><code>Collection.add(E)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeRule(org.apache.calcite.plan.RelOptRule)"> |
| <h3>removeRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">removeRule</span><wbr><span class="parameters">(<a href="../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div> |
| <div class="block">Removes a rule.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></code> in interface <code><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../plan/AbstractRelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></code> in class <code><a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the rule was present, as per |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link"><code>Collection.remove(Object)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)"> |
| <h3>changeTraits</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">changeTraits</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">RelOptPlanner</a></code></span></div> |
| <div class="block">Changes a relational expression to an equivalent one with a different set |
| of traits.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression (may or may not have been registered; must |
| not have the desired traits)</dd> |
| <dd><code>toTraits</code> - Trait set to convert the relational expression to</dd> |
| <dt>Returns:</dt> |
| <dd>Relational expression with desired traits. Never null, but may be |
| abstract</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findBestExp()"> |
| <h3>findBestExp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">findBestExp</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#findBestExp()">RelOptPlanner</a></code></span></div> |
| <div class="block">Finds the most efficient expression to implement this query.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| @Nullable <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> equivRel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Registers a relational expression in the expression bank. |
| |
| <p>After it has been registered, you may not modify it. |
| |
| <p>The expression must not already have been registered. If you are not |
| sure whether it has been registered, call |
| <a href="../plan/RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"><code>RelOptPlanner.ensureRegistered(RelNode, RelNode)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression to register (must not already be |
| registered)</dd> |
| <dd><code>equivRel</code> - Relational expression it is equivalent to (may be null)</dd> |
| <dt>Returns:</dt> |
| <dd>the same expression, or an equivalent existing expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"> |
| <h3>ensureRegistered</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">ensureRegistered</span><wbr><span class="parameters">(<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> equivRel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Registers a relational expression if it is not already registered. |
| |
| <p>If <code>equivRel</code> is specified, <code>rel</code> is placed in the same |
| equivalence set. It is OK if <code>equivRel</code> has different traits; |
| <code>rel</code> will end up in a different subset of the same set. |
| |
| <p>It is OK if <code>rel</code> is a subset.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression to register</dd> |
| <dd><code>equivRel</code> - Relational expression it is equivalent to (may be null)</dd> |
| <dt>Returns:</dt> |
| <dd>Registered relational expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRegistered(org.apache.calcite.rel.RelNode)"> |
| <h3>isRegistered</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRegistered</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptPlanner.html#isRegistered(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div> |
| <div class="block">Determines whether a relational expression has been registered.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - expression to test</dd> |
| <dt>Returns:</dt> |
| <dd>whether rel has been registered</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)"> |
| <h3>getRelMetadataTimestamp</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getRelMetadataTimestamp</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code> in interface <code><a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../plan/AbstractRelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code> in class <code><a href="../plan/AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - rel of interest</dd> |
| <dt>Returns:</dt> |
| <dd>timestamp of last change which might affect metadata derivation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRelMetadataTimestamp(long)"> |
| <h3>setRelMetadataTimestamp</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRelMetadataTimestamp</span><wbr><span class="parameters">(long metadataTimestamp)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
