| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RelOptRule (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.plan, class: RelOptRule"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":41,"i1":9,"i2":9,"i3":9,"i4":41,"i5":41,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":41,"i15":6,"i16":41,"i17":41,"i18":41,"i19":41,"i20":41,"i21":41,"i22":41,"i23":41,"i24":10,"i25":41}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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 = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.plan</a></div> |
| <h1 title="Class RelOptRule" class="title">Class RelOptRule</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.plan.RelOptRule</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="RelRule.html" title="class in org.apache.calcite.plan">RelRule</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">RelOptRule</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <div class="block">A <code>RelOptRule</code> transforms an expression into another. It has a |
| list of <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan"><code>RelOptRuleOperand</code></a>s, which determine whether the rule can be |
| applied to a particular section of the tree. |
| |
| <p>The optimizer figures out which rules are applicable, then calls |
| <a href="#onMatch(org.apache.calcite.plan.RelOptRuleCall)"><code>onMatch(org.apache.calcite.plan.RelOptRuleCall)</code></a> on each of them.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelOptRule.ConverterRelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRule.ConverterRelOptRuleOperand</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Operand to an instance of the converter rule.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#description">description</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Description of rule, must be unique within planner.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operands">operands</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Flattened list of operands.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#relBuilderFactory">relBuilderFactory</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Factory for a builder for relational expressions.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptRuleOperand)">RelOptRule</a></span>​(<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a rule.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptRuleOperand,java.lang.String)">RelOptRule</a></span>​(<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a rule with an explicit description.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.tools.RelBuilderFactory,java.lang.String)">RelOptRule</a></span>​(<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a> relBuilderFactory, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a rule with an explicit description.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>static <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#any()">any</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandDetailBuilder.html#anyInputs()"><code>RelRule.OperandDetailBuilder.anyInputs()</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static <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="#convert(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTrait)">convert</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> toTrait)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts one trait of a relational expression, if it does not |
| already have that trait.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>static <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="#convert(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">convert</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts a relation expression to a given set of traits, if it does not |
| already have those traits.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertList(java.util.List,org.apache.calcite.plan.RelTrait)">convertList</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> rels, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts a list of relational expressions.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>protected static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><a href="RelOptRule.ConverterRelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRule.ConverterRelOptRuleOperand</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertOperand(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait)">convertOperand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| com.google.common.base.Predicate<? super R> predicate, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#convertOperand(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait)"><code>convertOperand(Class, Predicate, RelTrait)</code></a>.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>protected static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><a href="RelOptRule.ConverterRelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRule.ConverterRelOptRuleOperand</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertOperand(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait)">convertOperand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><? super R> predicate, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(org.apache.calcite.plan.RelOptRule)">equals</a></span>​(<a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> that)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this rule is equal to another rule.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <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="#getOperand()">getOperand</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the root operand of this rule.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperands()">getOperands</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a flattened list of operands of this rule.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutConvention()">getOutConvention</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the convention of the result of firing this rule, null if |
| not known.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutTrait()">getOutTrait</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the trait which will be modified as a result of firing this rule, |
| or null if the rule is not a converter rule.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#matches(org.apache.calcite.plan.RelOptRuleCall)">matches</a></span>​(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this rule could possibly match the given operands.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>static <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#none()">none</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandDetailBuilder.html#noInputs()"><code>RelRule.OperandDetailBuilder.noInputs()</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onMatch(org.apache.calcite.plan.RelOptRuleCall)">onMatch</a></span>​(<a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Receives notification about a rule match.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operand(java.lang.Class,org.apache.calcite.plan.RelTrait,com.google.common.base.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| com.google.common.base.Predicate<? super R> predicate, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)"><code>operandJ(java.lang.Class<R>, org.apache.calcite.plan.RelTrait, java.util.function.Predicate<? super R>, org.apache.calcite.plan.RelOptRuleOperandChildren)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operand(java.lang.Class,org.apache.calcite.plan.RelTrait,com.google.common.base.Predicate,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| com.google.common.base.Predicate<? super R> predicate, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operand(java.lang.Class,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)">operandJ</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><? super R> predicate, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code>static <R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>><br><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="#operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operandJ</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><? super R> predicate, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code>static <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#some(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">some</a></span>​(<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandDetailBuilder.html#inputs(org.apache.calcite.plan.RelRule.OperandTransform...)"><code>RelRule.OperandDetailBuilder.inputs(org.apache.calcite.plan.RelRule.OperandTransform...)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the description of this rule.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code>static <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unordered(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">unordered</a></span>​(<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="description">description</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">description</span></div> |
| <div class="block">Description of rule, must be unique within planner. Default is the name |
| of the class sans package name, but derived classes are encouraged to |
| override.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="relBuilderFactory">relBuilderFactory</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a></span> <span class="memberName">relBuilderFactory</span></div> |
| <div class="block">Factory for a builder for relational expressions. |
| |
| <p>The actual builder is available via <a href="RelOptRuleCall.html#builder()"><code>RelOptRuleCall.builder()</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operands">operands</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>></span> <span class="memberName">operands</span></div> |
| <div class="block">Flattened list of operands.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.plan.RelOptRuleOperand)">RelOptRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">RelOptRule</span>​(<span class="arguments"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand)</span></div> |
| <div class="block">Creates a rule.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operand</code> - root operand, must not be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.plan.RelOptRuleOperand,java.lang.String)">RelOptRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">RelOptRule</span>​(<span class="arguments"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</span></div> |
| <div class="block">Creates a rule with an explicit description.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operand</code> - root operand, must not be null</dd> |
| <dd><code>description</code> - Description, or null to guess description</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.tools.RelBuilderFactory,java.lang.String)">RelOptRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">RelOptRule</span>​(<span class="arguments"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> operand, |
| <a href="../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a> relBuilderFactory, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> description)</span></div> |
| <div class="block">Creates a rule with an explicit description.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operand</code> - root operand, must not be null</dd> |
| <dd><code>description</code> - Description, or null to guess description</dd> |
| <dd><code>relBuilderFactory</code> - Builder for relational expressions</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| <div class="block">Creates an operand that matches a relational expression that has no |
| children.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>R</code> - Class of relational expression to match</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - Class of relational expression to match (must not be null)</dd> |
| <dd><code>operandList</code> - Child operands</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Operand that matches a relational expression that has no |
| children</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operand(java.lang.Class,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| <div class="block">Creates an operand that matches a relational expression that has no |
| children.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>R</code> - Class of relational expression to match</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - Class of relational expression to match (must not be null)</dd> |
| <dd><code>trait</code> - Trait to match, or null to match any trait</dd> |
| <dd><code>operandList</code> - Child operands</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Operand that matches a relational expression that has no |
| children</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)">operandJ</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operandJ</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><? super R> predicate, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| <div class="block">Creates an operand that matches a relational expression that has a |
| particular trait and predicate.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>R</code> - Class of relational expression to match</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - Class of relational expression to match (must not be null)</dd> |
| <dd><code>trait</code> - Trait to match, or null to match any trait</dd> |
| <dd><code>predicate</code> - Additional match predicate</dd> |
| <dd><code>operandList</code> - Child operands</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Operand that matches a relational expression that has a |
| particular trait and predicate</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operand(java.lang.Class,org.apache.calcite.plan.RelTrait,com.google.common.base.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| com.google.common.base.Predicate<? super R> predicate, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> operandList)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)"><code>operandJ(java.lang.Class<R>, org.apache.calcite.plan.RelTrait, java.util.function.Predicate<? super R>, org.apache.calcite.plan.RelOptRuleOperandChildren)</code></a></div> |
| </div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operandJ</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operandJ</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><? super R> predicate, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| <div class="block">Creates an operand that matches a relational expression that has no |
| children.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>R</code> - Class of relational expression to match</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - Class of relational expression to match (must not be null)</dd> |
| <dd><code>trait</code> - Trait to match, or null to match any trait</dd> |
| <dd><code>predicate</code> - Additional match predicate</dd> |
| <dd><code>first</code> - First operand</dd> |
| <dd><code>rest</code> - Rest operands</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Operand</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operand(java.lang.Class,org.apache.calcite.plan.RelTrait,com.google.common.base.Predicate,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| com.google.common.base.Predicate<? super R> predicate, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">operand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandBuilder.html#operand(java.lang.Class)"><code>RelRule.OperandBuilder.operand(Class)</code></a></div> |
| </div> |
| <div class="block">Creates an operand that matches a relational expression with a given |
| list of children. |
| |
| <p>Shorthand for <code>operand(clazz, some(...))</code>. |
| |
| <p>If you wish to match a relational expression that has no children |
| (that is, a leaf node), write <code>operand(clazz, none())</code></p>. |
| |
| <p>If you wish to match a relational expression that has any number of |
| children, write <code>operand(clazz, any())</code></p>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>R</code> - Class of relational expression to match</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - Class of relational expression to match (must not be null)</dd> |
| <dd><code>first</code> - First operand</dd> |
| <dd><code>rest</code> - Rest operands</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Operand that matches a relational expression with a given |
| list of children</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="convertOperand(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait)">convertOperand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">protected static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> |
| <span class="returnType"><a href="RelOptRule.ConverterRelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRule.ConverterRelOptRuleOperand</a></span> <span class="memberName">convertOperand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Predicate</a><? super R> predicate, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates an operand for a converter rule.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - Class of relational expression to match (must not be null)</dd> |
| <dd><code>trait</code> - Trait to match, or null to match any trait</dd> |
| <dd><code>predicate</code> - Predicate to apply to relational expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="convertOperand(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait)">convertOperand</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">protected static</span> <span class="typeParameters"><R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> |
| <span class="returnType"><a href="RelOptRule.ConverterRelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRule.ConverterRelOptRuleOperand</a></span> <span class="memberName">convertOperand</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><R> clazz, |
| com.google.common.base.Predicate<? super R> predicate, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#convertOperand(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait)"><code>convertOperand(Class, Predicate, RelTrait)</code></a>.</div> |
| </div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="some(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">some</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></span> <span class="memberName">some</span>​(<span class="arguments"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandDetailBuilder.html#inputs(org.apache.calcite.plan.RelRule.OperandTransform...)"><code>RelRule.OperandDetailBuilder.inputs(org.apache.calcite.plan.RelRule.OperandTransform...)</code></a></div> |
| </div> |
| <div class="block">Creates a list of child operands that matches child relational |
| expressions in the order they appear.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>first</code> - First child operand</dd> |
| <dd><code>rest</code> - Remaining child operands (may be empty)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of child operands that matches child relational |
| expressions in the order</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="unordered(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">unordered</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></span> <span class="memberName">unordered</span>​(<span class="arguments"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> first, |
| <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>... rest)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a list of child operands that matches child relational |
| expressions in any order. |
| |
| <p>This is useful when matching a relational expression which |
| can have a variable number of children. For example, the rule to |
| eliminate empty children of a Union would have operands</p> |
| |
| <blockquote>Operand(Union, true, Operand(Empty))</blockquote> |
| |
| <p>and given the relational expressions</p> |
| |
| <blockquote>Union(LogicalFilter, Empty, LogicalProject)</blockquote> |
| |
| <p>would fire the rule with arguments</p> |
| |
| <blockquote>{Union, Empty}</blockquote> |
| |
| <p>It is up to the rule to deduce the other children, or indeed the |
| position of the matched child.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>first</code> - First child operand</dd> |
| <dd><code>rest</code> - Remaining child operands (may be empty)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of child operands that matches child relational |
| expressions in any order</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="none()">none</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></span> <span class="memberName">none</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandDetailBuilder.html#noInputs()"><code>RelRule.OperandDetailBuilder.noInputs()</code></a></div> |
| </div> |
| <div class="block">Creates an empty list of child operands.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Empty list of child operands</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="any()">any</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a></span> <span class="memberName">any</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="RelRule.OperandDetailBuilder.html#anyInputs()"><code>RelRule.OperandDetailBuilder.anyInputs()</code></a></div> |
| </div> |
| <div class="block">Creates a list of child operands that signifies that the operand matches |
| any number of child relational expressions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of child operands that signifies that the operand matches |
| any number of child relational expressions</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOperand()">getOperand</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="memberName">getOperand</span>()</div> |
| <div class="block">Returns the root operand of this rule.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the root operand of this rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOperands()">getOperands</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>></span> <span class="memberName">getOperands</span>()</div> |
| <div class="block">Returns a flattened list of operands of this rule.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>flattened list of operands</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="hashCode()">hashCode</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">hashCode</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equals(java.lang.Object)">equals</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">equals</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equals(org.apache.calcite.plan.RelOptRule)">equals</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">equals</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a> |
| <a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> that)</span></div> |
| <div class="block">Returns whether this rule is equal to another rule. |
| |
| <p>The base implementation checks that the rules have the same class and |
| that the operands are equal; derived classes can override.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>that</code> - Another rule</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether this rule is equal to another rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="matches(org.apache.calcite.plan.RelOptRuleCall)">matches</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">matches</span>​(<span class="arguments"><a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> call)</span></div> |
| <div class="block">Returns whether this rule could possibly match the given operands. |
| |
| <p>This method is an opportunity to apply side-conditions to a rule. The |
| <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a> calls this method after matching all operands of |
| the rule, and before calling <a href="#onMatch(org.apache.calcite.plan.RelOptRuleCall)"><code>onMatch(RelOptRuleCall)</code></a>. |
| |
| <p>In implementations of <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a> which may queue up a |
| matched <a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan"><code>RelOptRuleCall</code></a> for a long time before calling |
| <a href="#onMatch(org.apache.calcite.plan.RelOptRuleCall)"><code>onMatch(RelOptRuleCall)</code></a>, this method is beneficial because it |
| allows the planner to discard rules earlier in the process. |
| |
| <p>The default implementation of this method returns <code>true</code>. |
| It is acceptable for any implementation of this method to give a false |
| positives, that is, to say that the rule matches the operands but have |
| <a href="#onMatch(org.apache.calcite.plan.RelOptRuleCall)"><code>onMatch(RelOptRuleCall)</code></a> subsequently not generate any |
| successors. |
| |
| <p>The following script is useful to identify rules which commonly |
| produce no successors. You should override this method for these rules: |
| |
| <blockquote> |
| <pre><code>awk ' |
| /Apply rule/ {rule=$4; ruleCount[rule]++;} |
| /generated 0 successors/ {ruleMiss[rule]++;} |
| END { |
| printf "%-30s %s %s\n", "Rule", "Fire", "Miss"; |
| for (i in ruleCount) { |
| printf "%-30s %5d %5d\n", i, ruleCount[i], ruleMiss[i]; |
| } |
| } ' FarragoTrace.log</code></pre> |
| </blockquote></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - Rule call which has been determined to match all operands of |
| this rule</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this RelOptRule matches a given RelOptRuleCall</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="onMatch(org.apache.calcite.plan.RelOptRuleCall)">onMatch</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType">void</span> <span class="memberName">onMatch</span>​(<span class="arguments"><a href="RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a> call)</span></div> |
| <div class="block">Receives notification about a rule match. At the time that this method is |
| called, <a href="RelOptRuleCall.html#rels"><code>call.rels</code></a> holds the set of relational |
| expressions which match the operands to the rule; <code> |
| call.rels[0]</code> is the root expression. |
| |
| <p>Typically a rule would check that the nodes are valid matches, creates |
| a new expression, then calls back <a href="RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode,java.util.Map,org.apache.calcite.plan.RelHintsPropagator)"><code>RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map<org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode>, org.apache.calcite.plan.RelHintsPropagator)</code></a> to |
| register the expression.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - Rule call</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#matches(org.apache.calcite.plan.RelOptRuleCall)"><code>matches(RelOptRuleCall)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOutConvention()">getOutConvention</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span> <span class="memberName">getOutConvention</span>()</div> |
| <div class="block">Returns the convention of the result of firing this rule, null if |
| not known.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Convention of the result of firing this rule, null if |
| not known</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOutTrait()">getOutTrait</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></span> <span class="memberName">getOutTrait</span>()</div> |
| <div class="block">Returns the trait which will be modified as a result of firing this rule, |
| or null if the rule is not a converter rule.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Trait which will be modified as a result of firing this rule, |
| or null if the rule is not a converter rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <div class="block">Returns the description of this rule. |
| |
| <p>It must be unique (for rules that are not equal) and must consist of |
| only the characters A-Z, a-z, 0-9, '_', '.', '(', ')', '-', ',', '[', ']', ':', ' '. |
| It must start with a letter.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="convert(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">convert</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="memberName">convert</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</span></div> |
| <div class="block">Converts a relation expression to a given set of traits, if it does not |
| already have those traits.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression to convert</dd> |
| <dd><code>toTraits</code> - desired traits</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a relational expression with the desired traits; never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="convert(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTrait)">convert</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="memberName">convert</span>​(<span class="arguments"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> toTrait)</span></div> |
| <div class="block">Converts one trait of a relational expression, if it does not |
| already have that trait.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression to convert</dd> |
| <dd><code>toTrait</code> - Desired trait</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a relational expression with the desired trait; never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="convertList(java.util.List,org.apache.calcite.plan.RelTrait)">convertList</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="memberName">convertList</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> rels, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</span></div> |
| <div class="block">Converts a list of relational expressions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rels</code> - Relational expressions</dd> |
| <dd><code>trait</code> - Trait to add to each relational expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of converted relational expressions, never null</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
