| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Correlate (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Correlate (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Correlate.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.rel.core</a></div> |
| <h2 title="Class Correlate" class="title">Class Correlate</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.AbstractRelNode</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../BiRel.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.BiRel</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.rel.core.Correlate</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.lang.Cloneable</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> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../../adapter/enumerable/EnumerableCorrelate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCorrelate</a></code>, <code><a href="../logical/LogicalCorrelate.html" title="class in org.apache.calcite.rel.logical">LogicalCorrelate</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">Correlate</span> |
| extends <a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></pre> |
| <div class="block">A relational operator that performs nested-loop joins. |
| |
| <p>It behaves like a kind of <a href="Join.html" title="class in org.apache.calcite.rel.core"><code>Join</code></a>, |
| but works by setting variables in its environment and restarting its |
| right-hand input. |
| |
| <p>Correlate is not a join since: typical rules should not match Correlate. |
| |
| <p>A Correlate is used to represent a correlated query. One |
| implementation strategy is to de-correlate the expression. |
| |
| <table> |
| <caption>Mapping of physical operations to logical ones</caption> |
| <tr><th>Physical operation</th><th>Logical operation</th></tr> |
| <tr><td>NestedLoops</td><td>Correlate(A, B, regular)</td></tr> |
| <tr><td>NestedLoopsOuter</td><td>Correlate(A, B, outer)</td></tr> |
| <tr><td>NestedLoopsSemi</td><td>Correlate(A, B, semi)</td></tr> |
| <tr><td>NestedLoopsAnti</td><td>Correlate(A, B, anti)</td></tr> |
| <tr><td>HashJoin</td><td>EquiJoin(A, B)</td></tr> |
| <tr><td>HashJoinOuter</td><td>EquiJoin(A, B, outer)</td></tr> |
| <tr><td>HashJoinSemi</td><td>SemiJoin(A, B, semi)</td></tr> |
| <tr><td>HashJoinAnti</td><td>SemiJoin(A, B, anti)</td></tr> |
| </table></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="CorrelationId.html" title="class in org.apache.calcite.rel.core"><code>CorrelationId</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.rel.RelNode"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces 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.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#correlationId">correlationId</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#joinType">joinType</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiredColumns">requiredColumns</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.rel.BiRel"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.calcite.rel.<a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></h3> |
| <code><a href="../BiRel.html#left">left</a>, <a href="../BiRel.html#right">right</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.rel.AbstractRelNode"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.calcite.rel.<a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <code><a href="../AbstractRelNode.html#digest">digest</a>, <a href="../AbstractRelNode.html#id">id</a>, <a href="../AbstractRelNode.html#rowType">rowType</a>, <a href="../AbstractRelNode.html#traitSet">traitSet</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)">Correlate</a></span>​(<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, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Correlate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.sql.SemiJoinType)">Correlate</a></span>​(<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, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="../../sql/SemiJoinType.html" title="enum in org.apache.calcite.sql">SemiJoinType</a> joinType)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.rel.RelInput)">Correlate</a></span>​(<a href="../RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Correlate by parsing serialized output.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Returns the cost of this plan (not including children).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></span>​(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| java.util.List<<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)">copy</a></span>​(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deriveRowType()">deriveRowType</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#explainTerms(org.apache.calcite.rel.RelWriter)">explainTerms</a></span>​(<a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</code></th> |
| <td class="colLast"> |
| <div class="block">Describes the inputs and attributes of this relational expression.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrelationId()">getCorrelationId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the correlating expressions.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrelVariable()">getCorrelVariable</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJoinType()">getJoinType</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequiredColumns()">getRequiredColumns</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the required columns in left relation required for the correlation |
| in the right.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<<a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVariablesSet()">getVariablesSet</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></span>​(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| <a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this relational expression is valid.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.rel.BiRel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.calcite.rel.<a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></h3> |
| <code><a href="../BiRel.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../BiRel.html#getInputs()">getInputs</a>, <a href="../BiRel.html#getLeft()">getLeft</a>, <a href="../BiRel.html#getRight()">getRight</a>, <a href="../BiRel.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.rel.AbstractRelNode"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.calcite.rel.<a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <code><a href="../AbstractRelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../AbstractRelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../AbstractRelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="../AbstractRelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="../AbstractRelNode.html#computeDigest()">computeDigest</a>, <a href="../AbstractRelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner)">computeSelfCost</a>, <a href="../AbstractRelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a>, <a href="../AbstractRelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="../AbstractRelNode.html#getChildExps()">getChildExps</a>, <a href="../AbstractRelNode.html#getCluster()">getCluster</a>, <a href="../AbstractRelNode.html#getCollationList()">getCollationList</a>, <a href="../AbstractRelNode.html#getConvention()">getConvention</a>, <a href="../AbstractRelNode.html#getDescription()">getDescription</a>, <a href="../AbstractRelNode.html#getDigest()">getDigest</a>, <a href="../AbstractRelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../AbstractRelNode.html#getId()">getId</a>, <a href="../AbstractRelNode.html#getInput(int)">getInput</a>, <a href="../AbstractRelNode.html#getQuery()">getQuery</a>, <a href="../AbstractRelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../AbstractRelNode.html#getRows()">getRows</a>, <a href="../AbstractRelNode.html#getRowType()">getRowType</a>, <a href="../AbstractRelNode.html#getTable()">getTable</a>, <a href="../AbstractRelNode.html#getTraitSet()">getTraitSet</a>, <a href="../AbstractRelNode.html#getVariablesStopped()">getVariablesStopped</a>, <a href="../AbstractRelNode.html#isDistinct()">isDistinct</a>, <a href="../AbstractRelNode.html#isKey(org.apache.calcite.util.ImmutableBitSet)">isKey</a>, <a href="../AbstractRelNode.html#isValid(boolean)">isValid</a>, <a href="../AbstractRelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../AbstractRelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../AbstractRelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../AbstractRelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../AbstractRelNode.html#sole(java.util.List)">sole</a>, <a href="../AbstractRelNode.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="correlationId"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>correlationId</h4> |
| <pre>protected final <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId</pre> |
| </li> |
| </ul> |
| <a id="requiredColumns"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>requiredColumns</h4> |
| <pre>protected final <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns</pre> |
| </li> |
| </ul> |
| <a id="joinType"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>joinType</h4> |
| <pre>protected final <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Correlate</h4> |
| <pre>protected Correlate​(<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, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</pre> |
| <div class="block">Creates a Correlate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cluster</code> - Cluster this relational expression belongs to</dd> |
| <dd><code>left</code> - Left input relational expression</dd> |
| <dd><code>right</code> - Right input relational expression</dd> |
| <dd><code>correlationId</code> - Variable name for the row of left input</dd> |
| <dd><code>requiredColumns</code> - Set of columns that are used by correlation</dd> |
| <dd><code>joinType</code> - Join type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.sql.SemiJoinType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>Correlate</h4> |
| <pre>@Deprecated |
| protected Correlate​(<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, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="../../sql/SemiJoinType.html" title="enum in org.apache.calcite.sql">SemiJoinType</a> joinType)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.calcite.rel.RelInput)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Correlate</h4> |
| <pre>public Correlate​(<a href="../RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a> input)</pre> |
| <div class="block">Creates a Correlate by parsing serialized output.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - Input representation</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre class="methodSignature">public boolean isValid​(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| <a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">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 <code>AssertionError</code> if it |
| is not valid.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractRelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>litmus</code> - What to do if invalid</dd> |
| <dd><code>context</code> - Context for validity checking</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether relational expression is valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public <a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a> copy​(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| java.util.List<<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</pre> |
| <div class="block"><span class="descfrmTypeLabel">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.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractRelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>traitSet</code> - Trait set</dd> |
| <dd><code>inputs</code> - Inputs</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Copy of this relational expression, substituting traits and |
| inputs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.CorrelationId,org.apache.calcite.util.ImmutableBitSet,org.apache.calcite.rel.core.JoinRelType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public abstract <a href="Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a> copy​(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> right, |
| <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> correlationId, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> requiredColumns, |
| <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</pre> |
| </li> |
| </ul> |
| <a id="getJoinType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJoinType</h4> |
| <pre class="methodSignature">public <a href="JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> getJoinType()</pre> |
| </li> |
| </ul> |
| <a id="deriveRowType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deriveRowType</h4> |
| <pre class="methodSignature">protected <a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> deriveRowType()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractRelNode.html#deriveRowType()">deriveRowType</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="explainTerms(org.apache.calcite.rel.RelWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>explainTerms</h4> |
| <pre class="methodSignature">public <a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> explainTerms​(<a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../AbstractRelNode.html#explainTerms(org.apache.calcite.rel.RelWriter)">AbstractRelNode</a></code></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="../externalize/RelWriterImpl.html#item(java.lang.String,java.lang.Object)"><code>RelWriterImpl.item(String, Object)</code></a> |
| methods for each input and attribute.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../BiRel.html#explainTerms(org.apache.calcite.rel.RelWriter)">explainTerms</a></code> in class <code><a href="../BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pw</code> - Plan writer</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Plan writer for fluent-explain pattern</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCorrelationId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCorrelationId</h4> |
| <pre class="methodSignature">public <a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a> getCorrelationId()</pre> |
| <div class="block">Returns the correlating expressions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>correlating expressions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCorrelVariable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCorrelVariable</h4> |
| <pre class="methodSignature">public java.lang.String getCorrelVariable()</pre> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractRelNode.html#getCorrelVariable()">getCorrelVariable</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Name of correlating variable, or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRequiredColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequiredColumns</h4> |
| <pre class="methodSignature">public <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> getRequiredColumns()</pre> |
| <div class="block">Returns the required columns in left relation required for the correlation |
| in the right.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>columns in left relation required for the correlation in the right</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getVariablesSet()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVariablesSet</h4> |
| <pre class="methodSignature">public java.util.Set<<a href="CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>> getVariablesSet()</pre> |
| <div class="block"><span class="descfrmTypeLabel">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. |
| |
| <p>Note: only <a href="Correlate.html" title="class in org.apache.calcite.rel.core"><code>Correlate</code></a> should set |
| variables.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractRelNode.html#getVariablesSet()">getVariablesSet</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Names of variables which are set in this relational |
| expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>computeSelfCost</h4> |
| <pre class="methodSignature">public <a href="../../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a> computeSelfCost​(<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)</pre> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../AbstractRelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - Planner for cost calculation</dd> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Cost of this plan (not including children)</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Correlate.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
