| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractRelNode (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.rel, class: AbstractRelNode"> |
| <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><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="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.rel</a></div> |
| <h1 title="Class AbstractRelNode" class="title">Class AbstractRelNode</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">org.apache.calcite.rel.AbstractRelNode</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code>, <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></code>, <code><a href="../adapter/druid/DruidQuery.html" title="class in org.apache.calcite.adapter.druid">DruidQuery</a></code>, <code><a href="../plan/hep/HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a></code>, <code><a href="rules/MultiJoin.html" title="class in org.apache.calcite.rel.rules">MultiJoin</a></code>, <code><a href="../plan/volcano/RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code>, <code><a href="core/SetOp.html" title="class in org.apache.calcite.rel.core">SetOp</a></code>, <code><a href="SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></code>, <code><a href="core/TableFunctionScan.html" title="class in org.apache.calcite.rel.core">TableFunctionScan</a></code>, <code><a href="core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a></code>, <code><a href="core/Values.html" title="class in org.apache.calcite.rel.core">Values</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractRelNode</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span></div> |
| <div class="block">Base class for every relational expression (<a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>).</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.rel.RelNode">Nested classes/interfaces inherited from interface org.apache.calcite.rel.<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h2> |
| <code><a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="../plan/RelDigest.html" title="interface in org.apache.calcite.plan">RelDigest</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#digest" class="member-name-link">digest</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The digest that uniquely identifies the node.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#id" class="member-name-link">id</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Unique id of this object, for debugging.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected @MonotonicNonNull <a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#rowType" class="member-name-link">rowType</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Cached type of this relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#traitSet" class="member-name-link">traitSet</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">RelTraitSet that describes the traits of this RelNode.</div> |
| </div> |
| </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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">AbstractRelNode</a><wbr>(<a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates an <code>AbstractRelNode</code>.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><a href="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="#accept(org.apache.calcite.rel.RelShuttle)" class="member-name-link">accept</a><wbr>(<a href="RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a> shuttle)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Accepts a visit from a shuttle.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#accept(org.apache.calcite.rex.RexShuttle)" class="member-name-link">accept</a><wbr>(<a href="../rex/RexShuttle.html" title="class in org.apache.calcite.rex">RexShuttle</a> shuttle)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Accepts a visit from a shuttle.</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="#childrenAccept(org.apache.calcite.rel.RelVisitor)" class="member-name-link">childrenAccept</a><wbr>(<a href="RelVisitor.html" title="class in org.apache.calcite.rel">RelVisitor</a> visitor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Interacts with the <a href="RelVisitor.html" title="class in org.apache.calcite.rel"><code>RelVisitor</code></a> in a |
| <a href="../util/Glossary.html#VISITOR_PATTERN"><code>visitor pattern</code></a> to |
| traverse the tree of relational expressions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#collectVariablesSet(java.util.Set)" class="member-name-link">collectVariablesSet</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>> variableSet)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Collects variables set by this expression.</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="#collectVariablesUsed(java.util.Set)" class="member-name-link">collectVariablesUsed</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>> variableSet)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Collects variables known to be used by this expression or its |
| descendants.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">computeSelfCost</a><wbr>(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</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 cost of this plan (not including children).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)" class="member-name-link">copy</a><wbr>(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deepEquals(java.lang.Object)" class="member-name-link">deepEquals</a><wbr>(@Nullable <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> obj)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Equality check for RelNode digest.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deepHashCode()" class="member-name-link">deepHashCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compute hash code for RelNode digest.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deriveRowType()" class="member-name-link">deriveRowType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(@Nullable <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> obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">estimateRowCount</a><wbr>(<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an estimate of the number of rows this relational expression will |
| return.</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="#explain(org.apache.calcite.rel.RelWriter)" class="member-name-link">explain</a><wbr>(<a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Describes the inputs and attributes of this relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#explainTerms(org.apache.calcite.rel.RelWriter)" class="member-name-link">explainTerms</a><wbr>(<a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Describes the inputs and attributes of this relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCluster()" class="member-name-link">getCluster</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 cluster this relational expression belongs to.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final @Nullable <a href="../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConvention()" class="member-name-link">getConvention</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the CallingConvention trait from this RelNode's |
| <a href="../plan/RelOptNode.html#getTraitSet()"><code>trait set</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCorrelVariable()" class="member-name-link">getCorrelVariable</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 name of the variable which is to be implicitly set at runtime |
| each time a row is returned from the first input of this relational |
| expression; or null if there is no variable.</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>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></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="#getDescription()" class="member-name-link">getDescription</a>()</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><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDigest()" class="member-name-link">getDigest</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 a digest string of this <code>RelNode</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExpectedInputRowType(int)" class="member-name-link">getExpectedInputRowType</a><wbr>(int ordinalInParent)</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 type of the rows expected for an input.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getId()" class="member-name-link">getId</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 ID of this relational expression, unique among all relational |
| expressions created since the server was started.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#getInput(int)" class="member-name-link">getInput</a><wbr>(int i)</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 <code>i</code><sup>th</sup> input relational expression.</div> |
| </div> |
| <div class="col-first even-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="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="#getInputs()" class="member-name-link">getInputs</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 an array of this relational expression's inputs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../plan/RelDigest.html" title="interface in org.apache.calcite.plan">RelDigest</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelDigest()" class="member-name-link">getRelDigest</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 a digest of this <code>RelNode</code>.</div> |
| </div> |
| <div class="col-first even-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelTypeName()" class="member-name-link">getRelTypeName</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 name of this relational expression's class, sans package |
| name, for use in explain.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRowType()" class="member-name-link">getRowType</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 type of the rows returned by this relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTable()" class="member-name-link">getTable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If this relational expression represents an access to a table, returns |
| that table, otherwise returns null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTraitSet()" class="member-name-link">getTraitSet</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Retrieves this RelNode's traits.</div> |
| </div> |
| <div class="col-first even-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/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVariablesSet()" class="member-name-link">getVariablesSet</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 variables that are set in this relational |
| expression but also used and therefore not available to parents of this |
| relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></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="#isEnforcer()" class="member-name-link">isEnforcer</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Indicates whether it is an enforcer operator, e.g.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)" class="member-name-link">isValid</a><wbr>(<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| @Nullable <a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this relational expression is valid.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>final <@Nullable M extends @Nullable <a href="metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>><br>M</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">metadata</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><@Nullable M> metadataClass, |
| <a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</code></div> |
| <div class="col-last even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="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="#onRegister(org.apache.calcite.plan.RelOptPlanner)" class="member-name-link">onRegister</a><wbr>(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Receives notification that this expression is about to be registered.</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="#recomputeDigest()" class="member-name-link">recomputeDigest</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Recomputes the digest.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</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.plan.RelOptPlanner)" class="member-name-link">register</a><wbr>(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers any special rules specific to this kind of relational |
| expression.</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="#replaceInput(int,org.apache.calcite.rel.RelNode)" class="member-name-link">replaceInput</a><wbr>(int ordinalInParent, |
| <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> p)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Replaces the <code>ordinalInParent</code><sup>th</sup> input.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#sole(java.util.List)" class="member-name-link">sole</a><wbr>(<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><T> collection)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Description; consists of id plus digest.</div> |
| </div> |
| </div> |
| </div> |
| </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#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#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#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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelNode">Methods inherited from interface org.apache.calcite.rel.<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3> |
| <code><a href="RelNode.html#explain()">explain</a>, <a href="RelNode.html#fieldIsNullable(int)">fieldIsNullable</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="rowType"> |
| <h3>rowType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">@MonotonicNonNull <a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">rowType</span></div> |
| <div class="block">Cached type of this relational expression.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="digest"> |
| <h3>digest</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=INTERNAL) |
| </span><span class="modifiers">protected</span> <span class="return-type"><a href="../plan/RelDigest.html" title="interface in org.apache.calcite.plan">RelDigest</a></span> <span class="element-name">digest</span></div> |
| <div class="block">The digest that uniquely identifies the node.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="id"> |
| <h3>id</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">int</span> <span class="element-name">id</span></div> |
| <div class="block">Unique id of this object, for debugging.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="traitSet"> |
| <h3>traitSet</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span> <span class="element-name">traitSet</span></div> |
| <div class="block">RelTraitSet that describes the traits of this RelNode.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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.RelOptCluster,org.apache.calcite.plan.RelTraitSet)"> |
| <h3>AbstractRelNode</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractRelNode</span><wbr><span class="parameters">(<a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet)</span></div> |
| <div class="block">Creates an <code>AbstractRelNode</code>.</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="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">RelNode</a></code></span></div> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs. |
| |
| <p>Sub-classes with other important attributes are encouraged to create |
| variants of this method with more parameters.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>traitSet</code> - Trait set</dd> |
| <dd><code>inputs</code> - Inputs</dd> |
| <dt>Returns:</dt> |
| <dd>Copy of this relational expression, substituting traits and |
| inputs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sole(java.util.List)"> |
| <h3>sole</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">sole</span><wbr><span class="parameters">(<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><T> collection)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCluster()"> |
| <h3>getCluster</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a></span> <span class="element-name">getCluster</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptNode.html#getCluster()">RelOptNode</a></code></span></div> |
| <div class="block">Returns the cluster this relational expression belongs to.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getCluster()">getCluster</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>cluster</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConvention()"> |
| <h3>getConvention</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span> <span class="element-name">getConvention</span><wbr><span class="parameters">(@UnknownInitialization AbstractRelNode this)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getConvention()">RelNode</a></code></span></div> |
| <div class="block">Return the CallingConvention trait from this RelNode's |
| <a href="../plan/RelOptNode.html#getTraitSet()"><code>trait set</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getConvention()">getConvention</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>this RelNode's CallingConvention</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraitSet()"> |
| <h3>getTraitSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span> <span class="element-name">getTraitSet</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptNode.html#getTraitSet()">RelOptNode</a></code></span></div> |
| <div class="block">Retrieves this RelNode's traits. Note that although the RelTraitSet |
| returned is modifiable, it <b>must not</b> be modified during |
| optimization. It is legal to modify the traits of a RelNode before or |
| after optimization, although doing so could render a tree of RelNodes |
| unimplementable. If a RelNode's traits need to be modified during |
| optimization, clone the RelNode and change the clone's traits.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getTraitSet()">getTraitSet</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>this RelNode's trait set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCorrelVariable()"> |
| <h3>getCorrelVariable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getCorrelVariable</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getCorrelVariable()">RelNode</a></code></span></div> |
| <div class="block">Returns the name of the variable which is to be implicitly set at runtime |
| each time a row is returned from the first input of this relational |
| expression; or null if there is no variable.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getCorrelVariable()">getCorrelVariable</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Name of correlating variable, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getId()"> |
| <h3>getId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getId</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../plan/RelOptNode.html#getId()">RelOptNode</a></code></span></div> |
| <div class="block">Returns the ID of this relational expression, unique among all relational |
| expressions created since the server was started.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getId()">getId</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Unique ID</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInput(int)"> |
| <h3>getInput</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">getInput</span><wbr><span class="parameters">(int i)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getInput(int)">RelNode</a></code></span></div> |
| <div class="block">Returns the <code>i</code><sup>th</sup> input relational expression.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getInput(int)">getInput</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>i</code> - Ordinal of input</dd> |
| <dt>Returns:</dt> |
| <dd><code>i</code><sup>th</sup> input</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.calcite.plan.RelOptPlanner)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">RelNode</a></code></span></div> |
| <div class="block">Registers any special rules specific to this kind of relational |
| expression. |
| |
| <p>The planner calls this method this first time that it sees a |
| relational expression of this class. The derived class should call |
| <a href="../plan/RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)"><code>RelOptPlanner.addRule(org.apache.calcite.plan.RelOptRule)</code></a> for each rule, and |
| then call <code>super.register</code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>planner</code> - Planner to be used to register additional relational |
| expressions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelTypeName()"> |
| <h3>getRelTypeName</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getRelTypeName</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getRelTypeName()">RelNode</a></code></span></div> |
| <div class="block">Returns the name of this relational expression's class, sans package |
| name, for use in explain. For example, for a <code> |
| org.apache.calcite.rel.ArrayRel.ArrayReader</code>, this method returns |
| "ArrayReader".</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getRelTypeName()">getRelTypeName</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Name of this relational expression's class, sans package name, |
| for use in explain</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| @Nullable <a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">RelNode</a></code></span></div> |
| <div class="block">Returns whether this relational expression is valid. |
| |
| <p>If assertions are enabled, this method is typically called with <code> |
| litmus</code> = <code>THROW</code>, as follows: |
| |
| <blockquote> |
| <pre>assert rel.isValid(Litmus.THROW)</pre> |
| </blockquote> |
| |
| <p>This signals that the method can throw an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link"><code>AssertionError</code></a> if it |
| is not valid.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>litmus</code> - What to do if invalid</dd> |
| <dd><code>context</code> - Context for validity checking</dd> |
| <dt>Returns:</dt> |
| <dd>Whether relational expression is valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowType()"> |
| <h3>getRowType</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getRowType</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getRowType()">RelNode</a></code></span></div> |
| <div class="block">Returns the type of the rows returned by this relational expression.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getRowType()">getRowType</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getRowType()">getRowType</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveRowType()"> |
| <h3>deriveRowType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">deriveRowType</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExpectedInputRowType(int)"> |
| <h3>getExpectedInputRowType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getExpectedInputRowType</span><wbr><span class="parameters">(int ordinalInParent)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getExpectedInputRowType(int)">RelNode</a></code></span></div> |
| <div class="block">Returns the type of the rows expected for an input. Defaults to |
| <a href="RelNode.html#getRowType()"><code>RelNode.getRowType()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinalInParent</code> - input's 0-based ordinal with respect to this |
| parent rel</dd> |
| <dt>Returns:</dt> |
| <dd>expected row type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInputs()"> |
| <h3>getInputs</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="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="element-name">getInputs</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getInputs()">RelNode</a></code></span></div> |
| <div class="block">Returns an array of this relational expression's inputs. If there are no |
| inputs, returns an empty list, not <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getInputs()">getInputs</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getInputs()">getInputs</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Array of this relational expression's inputs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>estimateRowCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">estimateRowCount</span><wbr><span class="parameters">(<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns an estimate of the number of rows this relational expression will |
| return. |
| |
| <p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use |
| <a href="metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a chance to |
| override the rel's default ideas about row count.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Estimate of the number of rows this relational expression will |
| return</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getVariablesSet()"> |
| <h3>getVariablesSet</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/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>></span> <span class="element-name">getVariablesSet</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getVariablesSet()">RelNode</a></code></span></div> |
| <div class="block">Returns the variables that are set in this relational |
| expression but also used and therefore not available to parents of this |
| relational expression.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getVariablesSet()">getVariablesSet</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Names of variables which are set in this relational |
| expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="collectVariablesUsed(java.util.Set)"> |
| <h3>collectVariablesUsed</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">collectVariablesUsed</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>> variableSet)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#collectVariablesUsed(java.util.Set)">RelNode</a></code></span></div> |
| <div class="block">Collects variables known to be used by this expression or its |
| descendants. By default, no such information is available and must be |
| derived by analyzing sub-expressions, but some optimizer implementations |
| may insert special expressions which remember such information.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>variableSet</code> - receives variables used</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEnforcer()"> |
| <h3>isEnforcer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEnforcer</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#isEnforcer()">RelNode</a></code></span></div> |
| <div class="block">Indicates whether it is an enforcer operator, e.g. PhysicalSort, |
| PhysicalHashDistribute, etc. As an enforcer, the operator must be |
| created only when required traitSet is not satisfied by its input.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#isEnforcer()">isEnforcer</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Whether it is an enforcer operator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="collectVariablesSet(java.util.Set)"> |
| <h3>collectVariablesSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">collectVariablesSet</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>> variableSet)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#collectVariablesSet(java.util.Set)">RelNode</a></code></span></div> |
| <div class="block">Collects variables set by this expression. |
| TODO: is this required?</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>variableSet</code> - receives variables known to be set by</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="childrenAccept(org.apache.calcite.rel.RelVisitor)"> |
| <h3>childrenAccept</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">childrenAccept</span><wbr><span class="parameters">(<a href="RelVisitor.html" title="class in org.apache.calcite.rel">RelVisitor</a> visitor)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">RelNode</a></code></span></div> |
| <div class="block">Interacts with the <a href="RelVisitor.html" title="class in org.apache.calcite.rel"><code>RelVisitor</code></a> in a |
| <a href="../util/Glossary.html#VISITOR_PATTERN"><code>visitor pattern</code></a> to |
| traverse the tree of relational expressions.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>visitor</code> - Visitor that will traverse the tree of relational |
| expressions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="accept(org.apache.calcite.rel.RelShuttle)"> |
| <h3>accept</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">accept</span><wbr><span class="parameters">(<a href="RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a> shuttle)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#accept(org.apache.calcite.rel.RelShuttle)">RelNode</a></code></span></div> |
| <div class="block">Accepts a visit from a shuttle.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>shuttle</code> - Shuttle</dd> |
| <dt>Returns:</dt> |
| <dd>A copy of this node incorporating changes made by the shuttle to |
| this node's children</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="accept(org.apache.calcite.rex.RexShuttle)"> |
| <h3>accept</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">accept</span><wbr><span class="parameters">(<a href="../rex/RexShuttle.html" title="class in org.apache.calcite.rex">RexShuttle</a> shuttle)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">RelNode</a></code></span></div> |
| <div class="block">Accepts a visit from a shuttle. If the shuttle updates expression, then |
| a copy of the relation should be created. This new relation might have |
| a different row-type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>shuttle</code> - Shuttle</dd> |
| <dt>Returns:</dt> |
| <dd>A copy of this node incorporating changes made by the shuttle to |
| this node's children</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>computeSelfCost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="element-name">computeSelfCost</span><wbr><span class="parameters">(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns the cost of this plan (not including children). The base |
| implementation throws an error; derived classes should override. |
| |
| <p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use |
| <a href="metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a |
| chance to override the rel's default ideas about cost.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>planner</code> - Planner for cost calculation</dd> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Cost of this plan (not including children)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>metadata</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 final</span> <span class="type-parameters"><@Nullable M extends @Nullable <a href="metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>></span> |
| <span class="return-type">M</span> <span class="element-name">metadata</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><@Nullable M> metadataClass, |
| <a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</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="RelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns a metadata interface.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>M</code> - Type of metadata being requested</dd> |
| <dt>Parameters:</dt> |
| <dd><code>metadataClass</code> - Metadata interface</dd> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Metadata object that supplies the desired metadata (never null, |
| although if the information is not present the metadata object may |
| return null from all methods)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="explain(org.apache.calcite.rel.RelWriter)"> |
| <h3>explain</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">explain</span><wbr><span class="parameters">(<a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#explain(org.apache.calcite.rel.RelWriter)">RelNode</a></code></span></div> |
| <div class="block">Describes the inputs and attributes of this relational expression. |
| Each node should call <code>super.explain</code>, then call the |
| <a href="RelWriter.html#input(java.lang.String,org.apache.calcite.rel.RelNode)"><code>RelWriter.input(String, RelNode)</code></a> |
| and |
| <a href="RelWriter.html#item(java.lang.String,java.lang.Object)"><code>RelWriter.item(String, Object)</code></a> |
| methods for each input and attribute.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>pw</code> - Plan writer</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="explainTerms(org.apache.calcite.rel.RelWriter)"> |
| <h3>explainTerms</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></span> <span class="element-name">explainTerms</span><wbr><span class="parameters">(<a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</span></div> |
| <div class="block">Describes the inputs and attributes of this relational expression. |
| Each node should call <code>super.explainTerms</code>, then call the |
| <a href="RelWriter.html#input(java.lang.String,org.apache.calcite.rel.RelNode)"><code>RelWriter.input(String, RelNode)</code></a> |
| and |
| <a href="RelWriter.html#item(java.lang.String,java.lang.Object)"><code>RelWriter.item(String, Object)</code></a> |
| methods for each input and attribute.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pw</code> - Plan writer</dd> |
| <dt>Returns:</dt> |
| <dd>Plan writer for fluent-explain pattern</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onRegister(org.apache.calcite.plan.RelOptPlanner)"> |
| <h3>onRegister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">onRegister</span><wbr><span class="parameters">(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">RelNode</a></code></span></div> |
| <div class="block">Receives notification that this expression is about to be registered. The |
| implementation of this method must at least register all child |
| expressions.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>planner</code> - Planner that plans this relational node</dd> |
| <dt>Returns:</dt> |
| <dd>Relational expression that should be used by the planner</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="recomputeDigest()"> |
| <h3>recomputeDigest</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">recomputeDigest</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#recomputeDigest()">RelNode</a></code></span></div> |
| <div class="block">Recomputes the digest. |
| |
| <p>INTERNAL USE ONLY. For use by the planner.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#recomputeDigest()">recomputeDigest</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="RelNode.html#getDigest()"><code>RelNode.getDigest()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replaceInput(int,org.apache.calcite.rel.RelNode)"> |
| <h3>replaceInput</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">replaceInput</span><wbr><span class="parameters">(int ordinalInParent, |
| <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> p)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">RelNode</a></code></span></div> |
| <div class="block">Replaces the <code>ordinalInParent</code><sup>th</sup> input. You must |
| override this method if you override <a href="RelNode.html#getInputs()"><code>RelNode.getInputs()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinalInParent</code> - Position of the child input, 0 is the first</dd> |
| <dd><code>p</code> - New node that should be put at position <code>ordinalInParent</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Description; consists of id plus digest.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescription()"> |
| <h3>getDescription</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 final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDescription</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/RelOptNode.html#getDescription()">RelOptNode</a></code></span></div> |
| <div class="block">Returns a string which describes the relational expression and, unlike |
| <a href="../plan/RelOptNode.html#getDigest()"><code>RelOptNode.getDigest()</code></a>, also includes the identity. Typically returns |
| "rel#{id}:{digest}".</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getDescription()">getDescription</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>String which describes the relational expression and, unlike |
| <a href="../plan/RelOptNode.html#getDigest()"><code>RelOptNode.getDigest()</code></a>, also includes the identity</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDigest()"> |
| <h3>getDigest</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getDigest</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getDigest()">RelNode</a></code></span></div> |
| <div class="block">Returns a digest string of this <code>RelNode</code>. |
| |
| <p>Each call creates a new digest string, |
| so don't forget to cache the result if necessary.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getDigest()">getDigest</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../plan/RelOptNode.html#getDigest()">getDigest</a></code> in interface <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Digest string of this <code>RelNode</code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="RelNode.html#getRelDigest()"><code>RelNode.getRelDigest()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelDigest()"> |
| <h3>getRelDigest</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../plan/RelDigest.html" title="interface in org.apache.calcite.plan">RelDigest</a></span> <span class="element-name">getRelDigest</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getRelDigest()">RelNode</a></code></span></div> |
| <div class="block">Returns a digest of this <code>RelNode</code>. |
| |
| <p>INTERNAL USE ONLY. For use by the planner.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getRelDigest()">getRelDigest</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Digest of this <code>RelNode</code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="RelNode.html#getDigest()"><code>RelNode.getDigest()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable()"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a></span> <span class="element-name">getTable</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelNode.html#getTable()">RelNode</a></code></span></div> |
| <div class="block">If this relational expression represents an access to a table, returns |
| that table, otherwise returns null.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#getTable()">getTable</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>If this relational expression represents an access to a table, |
| returns that table, otherwise returns null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(@Nullable <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> obj)</span></div> |
| <div class="block"> |
| |
| <p>This method (and <a href="#hashCode()"><code>hashCode()</code></a> is intentionally final. We do not want |
| sub-classes of <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> to redefine identity. Various algorithms |
| (e.g. visitors, planner) can define the identity as meets their needs.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block"> |
| |
| <p>This method (and <a href="#equals(java.lang.Object)"><code>equals(java.lang.Object)</code></a> is intentionally final. We do not want |
| sub-classes of <a href="RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> to redefine identity. Various algorithms |
| (e.g. visitors, planner) can define the identity as meets their needs.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deepEquals(java.lang.Object)"> |
| <h3>deepEquals</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.25", |
| status=MAINTAINED) |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">deepEquals</span><wbr><span class="parameters">(@Nullable <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> obj)</span></div> |
| <div class="block">Equality check for RelNode digest. |
| |
| <p>By default this method collects digest attributes from |
| <a href="#explainTerms(org.apache.calcite.rel.RelWriter)"><code>explainTerms(RelWriter)</code></a>, then compares each attribute pair. |
| This should work well for most cases. If this method is a performance |
| bottleneck for your project, or the default behavior can't handle |
| your scenario properly, you can choose to override this method and |
| <a href="#deepHashCode()"><code>deepHashCode()</code></a>. See <code>LogicalJoin</code> as an example.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#deepEquals(java.lang.Object)">deepEquals</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Whether the 2 RelNodes are equivalent or have the same digest.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#deepHashCode()"><code>deepHashCode()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deepHashCode()"> |
| <h3>deepHashCode</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.25", |
| status=MAINTAINED) |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">deepHashCode</span>()</div> |
| <div class="block">Compute hash code for RelNode digest.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelNode.html#deepHashCode()">deepHashCode</a></code> in interface <code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="RelNode.html#deepEquals(java.lang.Object)"><code>RelNode.deepEquals(Object)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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> |
