| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RelOptRuleCall (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="RelOptRuleCall (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/RelOptRuleCall.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>Nested | </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.plan</a></div> |
| <h2 title="Class RelOptRuleCall" class="title">Class RelOptRuleCall</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.plan.RelOptRuleCall</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="hep/HepRuleCall.html" title="class in org.apache.calcite.plan.hep">HepRuleCall</a></code>, <code><a href="volcano/VolcanoRuleCall.html" title="class in org.apache.calcite.plan.volcano">VolcanoRuleCall</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">RelOptRuleCall</span> |
| extends java.lang.Object</pre> |
| <div class="block">A <code>RelOptRuleCall</code> is an invocation of a <a href="RelOptRule.html" title="class in org.apache.calcite.plan"><code>RelOptRule</code></a> with a |
| set of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>relational expression</code></a>s as arguments.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#id">id</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static org.slf4j.Logger</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOGGER">LOGGER</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextId">nextId</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Generator for <a href="#id"><code>id</code></a> values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nodeInputs">nodeInputs</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operand0">operand0</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parents">parents</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#planner">planner</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rels">rels</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rule">rule</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </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.RelOptPlanner,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.rel.RelNode%5B%5D,java.util.Map)">RelOptRuleCall</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[] rels, |
| java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>> nodeInputs)</code></th> |
| <td class="colLast"> </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.RelOptPlanner,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.rel.RelNode%5B%5D,java.util.Map,java.util.List)">RelOptRuleCall</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[] rels, |
| java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>> nodeInputs, |
| java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> parents)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a RelOptRuleCall.</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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="../tools/RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#builder()">builder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a <a href="../tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a> to be used by |
| code within the call.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChildRels(org.apache.calcite.rel.RelNode)">getChildRels</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the children of a given relational expression node matched in a |
| rule.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetadataQuery()">getMetadataQuery</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the current RelMetadataQuery, to be used for instance by |
| <a href="RelOptRule.html#onMatch(org.apache.calcite.plan.RelOptRuleCall)"><code>RelOptRule.onMatch(RelOptRuleCall)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperand0()">getOperand0</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the root operand matched by this rule.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParents()">getParents</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPlanner()">getPlanner</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the planner.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelList()">getRelList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a list of matched relational expressions.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRels()">getRels</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#getRelList()"><code>getRelList()</code></a> or <a href="#rel(int)"><code>rel(int)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRule()">getRule</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the invoked planner rule.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><T extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rel(int)">rel</a></span>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block">Retrieves the <code>ordinal</code>th matched relational expression.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setChildRels(org.apache.calcite.rel.RelNode,java.util.List)">setChildRels</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</code></th> |
| <td class="colLast"> |
| <div class="block">Assigns the input relational expressions of a given relational expression, |
| as seen by this particular call.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transformTo(org.apache.calcite.rel.RelNode)">transformTo</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers that a rule has produced an equivalent relational expression, |
| but no other equivalences.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transformTo(org.apache.calcite.rel.RelNode,java.util.Map)">transformTo</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> equiv)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers that a rule has produced an equivalent relational expression.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="LOGGER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOGGER</h4> |
| <pre>protected static final org.slf4j.Logger LOGGER</pre> |
| </li> |
| </ul> |
| <a id="nextId"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextId</h4> |
| <pre>private static int nextId</pre> |
| <div class="block">Generator for <a href="#id"><code>id</code></a> values.</div> |
| </li> |
| </ul> |
| <a id="id"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>id</h4> |
| <pre>public final int id</pre> |
| </li> |
| </ul> |
| <a id="operand0"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>operand0</h4> |
| <pre>protected final <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand0</pre> |
| </li> |
| </ul> |
| <a id="nodeInputs"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nodeInputs</h4> |
| <pre>protected java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>> nodeInputs</pre> |
| </li> |
| </ul> |
| <a id="rule"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rule</h4> |
| <pre>public final <a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule</pre> |
| </li> |
| </ul> |
| <a id="rels"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rels</h4> |
| <pre>public final <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[] rels</pre> |
| </li> |
| </ul> |
| <a id="planner"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>planner</h4> |
| <pre>private final <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner</pre> |
| </li> |
| </ul> |
| <a id="parents"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parents</h4> |
| <pre>private final java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> parents</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.RelOptPlanner,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.rel.RelNode[],java.util.Map,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RelOptRuleCall</h4> |
| <pre>protected RelOptRuleCall​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[] rels, |
| java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>> nodeInputs, |
| java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> parents)</pre> |
| <div class="block">Creates a RelOptRuleCall.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - Planner</dd> |
| <dd><code>operand</code> - Root operand</dd> |
| <dd><code>rels</code> - Array of relational expressions which matched each |
| operand</dd> |
| <dd><code>nodeInputs</code> - For each node which matched with |
| <code>matchAnyChildren</code>=true, a list of the node's |
| inputs</dd> |
| <dd><code>parents</code> - list of parent RelNodes corresponding to the first |
| relational expression in the array argument, if known; |
| otherwise, null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.rel.RelNode[],java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RelOptRuleCall</h4> |
| <pre>protected RelOptRuleCall​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[] rels, |
| java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>>> nodeInputs)</pre> |
| </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="getOperand0()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperand0</h4> |
| <pre class="methodSignature">public <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> getOperand0()</pre> |
| <div class="block">Returns the root operand matched by this rule.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>root operand</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRule()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRule</h4> |
| <pre class="methodSignature">public <a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> getRule()</pre> |
| <div class="block">Returns the invoked planner rule.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>planner rule</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRels()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRels</h4> |
| <pre class="methodSignature">@Deprecated |
| public <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>[] getRels()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#getRelList()"><code>getRelList()</code></a> or <a href="#rel(int)"><code>rel(int)</code></a></div> |
| </div> |
| <div class="block">Returns a list of matched relational expressions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>matched relational expressions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRelList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRelList</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> getRelList()</pre> |
| <div class="block">Returns a list of matched relational expressions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>matched relational expressions</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#rel(int)"><code>rel(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rel(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rel</h4> |
| <pre class="methodSignature">public <T extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> T rel​(int ordinal)</pre> |
| <div class="block">Retrieves the <code>ordinal</code>th matched relational expression. This |
| corresponds to the <code>ordinal</code>th operand of the rule.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ordinal</code> - Ordinal</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Relational expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getChildRels(org.apache.calcite.rel.RelNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChildRels</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> getChildRels​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</pre> |
| <div class="block">Returns the children of a given relational expression node matched in a |
| rule. |
| |
| <p>If the policy of the operand which caused the match is not |
| <a href="RelOptRuleOperandChildPolicy.html#ANY"><code>RelOptRuleOperandChildPolicy.ANY</code></a>, |
| the children will have their |
| own operands and therefore be easily available in the array returned by |
| the <a href="#getRelList()"><code>getRelList()</code></a> method, so this method returns null. |
| |
| <p>This method is for |
| <a href="RelOptRuleOperandChildPolicy.html#ANY"><code>RelOptRuleOperandChildPolicy.ANY</code></a>, |
| which is generally used when a node can have a variable number of |
| children, and hence where the matched children are not retrievable by any |
| other means. |
| |
| <p>Warning: it produces wrong result for <code>unordered(...)</code> case.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Children of relational expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setChildRels(org.apache.calcite.rel.RelNode,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setChildRels</h4> |
| <pre class="methodSignature">protected void setChildRels​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</pre> |
| <div class="block">Assigns the input relational expressions of a given relational expression, |
| as seen by this particular call. Is only called when the operand is |
| <a href="RelOptRule.html#any()"><code>RelOptRule.any()</code></a>.</div> |
| </li> |
| </ul> |
| <a id="getPlanner()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPlanner</h4> |
| <pre class="methodSignature">public <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> getPlanner()</pre> |
| <div class="block">Returns the planner.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>planner</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMetadataQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadataQuery</h4> |
| <pre class="methodSignature">public <a href="../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> getMetadataQuery()</pre> |
| <div class="block">Returns the current RelMetadataQuery, to be used for instance by |
| <a href="RelOptRule.html#onMatch(org.apache.calcite.plan.RelOptRuleCall)"><code>RelOptRule.onMatch(RelOptRuleCall)</code></a>.</div> |
| </li> |
| </ul> |
| <a id="getParents()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParents</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> getParents()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of parents of the first relational expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transformTo(org.apache.calcite.rel.RelNode,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transformTo</h4> |
| <pre class="methodSignature">public abstract void transformTo​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| java.util.Map<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,​<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> equiv)</pre> |
| <div class="block">Registers that a rule has produced an equivalent relational expression. |
| |
| <p>Called by the rule whenever it finds a match. The implementation of |
| this method guarantees that the original relational expression (that is, |
| <code>this.rels[0]</code>) has its traits propagated to the new |
| relational expression (<code>rel</code>) and its unregistered children. |
| Any trait not specifically set in the RelTraitSet returned by <code> |
| rel.getTraits()</code> will be copied from <code> |
| this.rels[0].getTraitSet()</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression equivalent to the root relational |
| expression of the rule call, <code>call.rels(0)</code></dd> |
| <dd><code>equiv</code> - Map of other equivalences</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transformTo(org.apache.calcite.rel.RelNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transformTo</h4> |
| <pre class="methodSignature">public final void transformTo​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</pre> |
| <div class="block">Registers that a rule has produced an equivalent relational expression, |
| but no other equivalences.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression equivalent to the root relational |
| expression of the rule call, <code>call.rels(0)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="builder()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre class="methodSignature">public <a href="../tools/RelBuilder.html" title="class in org.apache.calcite.tools">RelBuilder</a> builder()</pre> |
| <div class="block">Creates a <a href="../tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a> to be used by |
| code within the call. The <a href="RelOptRule.html#relBuilderFactory"><code>RelOptRule.relBuilderFactory</code></a> argument contains policies |
| such as what implementation of <a href="../rel/core/Filter.html" title="class in org.apache.calcite.rel.core"><code>Filter</code></a> to create.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RelOptRuleCall.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>Nested | </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> |