| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelOptRuleOperand (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.plan, class: RelOptRuleOperand"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>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="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.plan</a></div> |
| <h1 title="Class RelOptRuleOperand" class="title">Class RelOptRuleOperand</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.plan.RelOptRuleOperand</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="RelOptRule.ConverterRelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRule.ConverterRelOptRuleOperand</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RelOptRuleOperand</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Operand that determines whether a <a href="RelOptRule.html" title="class in org.apache.calcite.plan"><code>RelOptRule</code></a> |
| can be applied to a particular expression. |
| |
| <p>For example, the rule to pull a filter up from the left side of a join |
| takes operands: <code>Join(Filter, Any)</code>.</p> |
| |
| <p>Note that <code>children</code> means different things if it is empty or |
| it is <code>null</code>: <code>Join(Filter <b>()</b>, Any)</code> means |
| that, to match the rule, <code>Filter</code> must have no operands.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>final <a href="RelOptRuleOperandChildPolicy.html" title="enum in org.apache.calcite.plan">RelOptRuleOperandChildPolicy</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#childPolicy" class="member-name-link">childPolicy</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Whether child operands can be matched in any order.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#ordinalInParent" class="member-name-link">ordinalInParent</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>int</code></div> |
| <div class="col-second even-row-color"><code><a href="#ordinalInRule" class="member-name-link">ordinalInRule</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>int @MonotonicNonNull []</code></div> |
| <div class="col-second odd-row-color"><code><a href="#solveOrder" class="member-name-link">solveOrder</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final @Nullable <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#trait" class="member-name-link">trait</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)" class="member-name-link">RelOptRuleOperand</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><? super R> predicate, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> children)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use |
| <a href="RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperandChildren)"><code>RelOptRule.operand(Class, RelOptRuleOperandChildren)</code></a> or one of its |
| overloaded methods.</div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChildOperands()" class="member-name-link">getChildOperands</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the child operands.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMatchedClass()" class="member-name-link">getMatchedClass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns relational expression class matched by this operand.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParent()" class="member-name-link">getParent</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the parent operand.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRule()" class="member-name-link">getRule</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the rule this operand belongs to.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#matches(org.apache.calcite.rel.RelNode)" class="member-name-link">matches</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether a relational expression matches this operand.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setParent(org.apache.calcite.plan.RelOptRuleOperand)" class="member-name-link">setParent</a><wbr>(@Nullable <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> parent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the parent operand.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRule(org.apache.calcite.plan.RelOptRule)" class="member-name-link">setRule</a><wbr>(@UnknownInitialization <a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the rule this operand belongs to.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"><b>FOR DEBUG ONLY.</b></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="solveOrder"> |
| <h3>solveOrder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int @MonotonicNonNull []</span> <span class="element-name">solveOrder</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ordinalInParent"> |
| <h3>ordinalInParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">ordinalInParent</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ordinalInRule"> |
| <h3>ordinalInRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">ordinalInRule</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="trait"> |
| <h3>trait</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></span> <span class="element-name">trait</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="childPolicy"> |
| <h3>childPolicy</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="RelOptRuleOperandChildPolicy.html" title="enum in org.apache.calcite.plan">RelOptRuleOperandChildPolicy</a></span> <span class="element-name">childPolicy</span></div> |
| <div class="block">Whether child operands can be matched in any order.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)"> |
| <h3>RelOptRuleOperand</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">RelOptRuleOperand</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><R> clazz, |
| <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a><? super R> predicate, |
| <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan">RelOptRuleOperandChildren</a> children)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Use |
| <a href="RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperandChildren)"><code>RelOptRule.operand(Class, RelOptRuleOperandChildren)</code></a> or one of its |
| overloaded methods.</div> |
| </div> |
| <div class="block">Creates an operand. |
| |
| <p>The <code>childOperands</code> argument is often populated by calling one |
| of the following methods: |
| <a href="RelOptRule.html#some(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)"><code>RelOptRule.some(org.apache.calcite.plan.RelOptRuleOperand, org.apache.calcite.plan.RelOptRuleOperand...)</code></a>, |
| <a href="RelOptRule.html#none()"><code>RelOptRule.none()</code></a>, |
| <a href="RelOptRule.html#any()"><code>RelOptRule.any()</code></a>, |
| <a href="RelOptRule.html#unordered(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)"><code>RelOptRule.unordered(org.apache.calcite.plan.RelOptRuleOperand, org.apache.calcite.plan.RelOptRuleOperand...)</code></a>, |
| See <a href="RelOptRuleOperandChildren.html" title="class in org.apache.calcite.plan"><code>RelOptRuleOperandChildren</code></a> for more |
| details.</div> |
| <dl class="notes"> |
| <dt>Parameters:</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> |
| <dd><code>children</code> - Child operands</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getParent()"> |
| <h3>getParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a></span> <span class="element-name">getParent</span>()</div> |
| <div class="block">Returns the parent operand.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>parent operand</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setParent(org.apache.calcite.plan.RelOptRuleOperand)"> |
| <h3>setParent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setParent</span><wbr><span class="parameters">(@Nullable <a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a> parent)</span></div> |
| <div class="block">Sets the parent operand.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>parent</code> - Parent operand</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRule()"> |
| <h3>getRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></span> <span class="element-name">getRule</span>()</div> |
| <div class="block">Returns the rule this operand belongs to.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>containing rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRule(org.apache.calcite.plan.RelOptRule)"> |
| <h3>setRule</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRule</span><wbr><span class="parameters">(@UnknownInitialization <a href="RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a> rule)</span></div> |
| <div class="block">Sets the rule this operand belongs to.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rule</code> - containing rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block"><b>FOR DEBUG ONLY.</b> |
| |
| <p>To facilitate IDE shows the operand description in the debugger, |
| returns the root operand description, but highlight current |
| operand's matched class with '*' in the description.</p> |
| |
| <p>e.g. The following are examples of rule operand description for |
| the operands that match with <code>LogicalFilter</code>.</p> |
| |
| <ul> |
| <li>SemiJoinRule:project: Project(Join(*RelNode*, Aggregate))</li> |
| <li>ProjectFilterTransposeRule: LogicalProject(*LogicalFilter*)</li> |
| <li>FilterProjectTransposeRule: *Filter*(Project)</li> |
| <li>ReduceExpressionsRule(Filter): *LogicalFilter*</li> |
| <li>PruneEmptyJoin(right): Join(*RelNode*, Values)</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>describeIt(RelOptRuleOperand)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMatchedClass()"> |
| <h3>getMatchedClass</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>></span> <span class="element-name">getMatchedClass</span>()</div> |
| <div class="block">Returns relational expression class matched by this operand.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getChildOperands()"> |
| <h3>getChildOperands</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>></span> <span class="element-name">getChildOperands</span>()</div> |
| <div class="block">Returns the child operands.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>child operands</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="matches(org.apache.calcite.rel.RelNode)"> |
| <h3>matches</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">matches</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</span></div> |
| <div class="block">Returns whether a relational expression matches this operand. It must be |
| of the right class and trait.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
