| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelOptListener (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, interface: RelOptListener"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface RelOptListener" class="title">Interface RelOptListener</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="MulticastRelOptListener.html" title="class in org.apache.calcite.plan">MulticastRelOptListener</a></code>, <code><a href="RuleEventLogger.html" title="class in org.apache.calcite.plan">RuleEventLogger</a></code>, <code><a href="visualizer/RuleMatchVisualizer.html" title="class in org.apache.calcite.plan.visualizer">RuleMatchVisualizer</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RelOptListener</span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></span></div> |
| <div class="block">RelOptListener defines an interface for listening to events which occur |
| during the optimization process.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="RelOptListener.RelChosenEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RelChosenEvent</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Event indicating that a relational expression has been chosen.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="RelOptListener.RelDiscardedEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RelDiscardedEvent</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Event indicating that a relational expression has been discarded.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="RelOptListener.RelEquivalenceEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RelEquivalenceEvent</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Event indicating that a relational expression has been found to |
| be equivalent to an equivalence class.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="RelOptListener.RelEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RelEvent</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Event class for abstract event dealing with a relational expression.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="RelOptListener.RuleAttemptedEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RuleAttemptedEvent</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Event indicating that a planner rule has been attempted.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="RelOptListener.RuleEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RuleEvent</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Event indicating that a planner rule has fired.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="RelOptListener.RuleProductionEvent.html" class="type-name-link" title="class in org.apache.calcite.plan">RelOptListener.RuleProductionEvent</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Event indicating that a planner rule has produced a result.</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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#relChosen(org.apache.calcite.plan.RelOptListener.RelChosenEvent)" class="member-name-link">relChosen</a><wbr>(<a href="RelOptListener.RelChosenEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelChosenEvent</a> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Notifies this listener that a relational expression has been chosen as |
| part of the final implementation of the query plan.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#relDiscarded(org.apache.calcite.plan.RelOptListener.RelDiscardedEvent)" class="member-name-link">relDiscarded</a><wbr>(<a href="RelOptListener.RelDiscardedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelDiscardedEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Notifies this listener that a relational expression is no longer of |
| interest to the planner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#relEquivalenceFound(org.apache.calcite.plan.RelOptListener.RelEquivalenceEvent)" class="member-name-link">relEquivalenceFound</a><wbr>(<a href="RelOptListener.RelEquivalenceEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelEquivalenceEvent</a> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Notifies this listener that a relational expression has been registered |
| with a particular equivalence class after an equivalence has been either |
| detected or asserted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ruleAttempted(org.apache.calcite.plan.RelOptListener.RuleAttemptedEvent)" class="member-name-link">ruleAttempted</a><wbr>(<a href="RelOptListener.RuleAttemptedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleAttemptedEvent</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Notifies this listener that an optimizer rule is being applied to a |
| particular relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#ruleProductionSucceeded(org.apache.calcite.plan.RelOptListener.RuleProductionEvent)" class="member-name-link">ruleProductionSucceeded</a><wbr>(<a href="RelOptListener.RuleProductionEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleProductionEvent</a> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Notifies this listener that an optimizer rule has been successfully |
| applied to a particular relational expression, resulting in a new |
| equivalent expression (relEquivalenceFound will also be called unless the |
| new expression is identical to an existing one).</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="relEquivalenceFound(org.apache.calcite.plan.RelOptListener.RelEquivalenceEvent)"> |
| <h3>relEquivalenceFound</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">relEquivalenceFound</span><wbr><span class="parameters">(<a href="RelOptListener.RelEquivalenceEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelEquivalenceEvent</a> event)</span></div> |
| <div class="block">Notifies this listener that a relational expression has been registered |
| with a particular equivalence class after an equivalence has been either |
| detected or asserted. Equivalence classes may be either logical (all |
| expressions which yield the same result set) or physical (all expressions |
| which yield the same result set with a particular calling convention).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ruleAttempted(org.apache.calcite.plan.RelOptListener.RuleAttemptedEvent)"> |
| <h3>ruleAttempted</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">ruleAttempted</span><wbr><span class="parameters">(<a href="RelOptListener.RuleAttemptedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleAttemptedEvent</a> event)</span></div> |
| <div class="block">Notifies this listener that an optimizer rule is being applied to a |
| particular relational expression. This rule is called twice; once before |
| the rule is invoked, and once after. Note that the rel attribute of the |
| event is always the old expression.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ruleProductionSucceeded(org.apache.calcite.plan.RelOptListener.RuleProductionEvent)"> |
| <h3>ruleProductionSucceeded</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">ruleProductionSucceeded</span><wbr><span class="parameters">(<a href="RelOptListener.RuleProductionEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleProductionEvent</a> event)</span></div> |
| <div class="block">Notifies this listener that an optimizer rule has been successfully |
| applied to a particular relational expression, resulting in a new |
| equivalent expression (relEquivalenceFound will also be called unless the |
| new expression is identical to an existing one). This rule is called |
| twice; once before registration of the new rel, and once after. Note that |
| the rel attribute of the event is always the new expression; to get the |
| old expression, use event.getRuleCall().rels[0].</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="relDiscarded(org.apache.calcite.plan.RelOptListener.RelDiscardedEvent)"> |
| <h3>relDiscarded</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">relDiscarded</span><wbr><span class="parameters">(<a href="RelOptListener.RelDiscardedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelDiscardedEvent</a> event)</span></div> |
| <div class="block">Notifies this listener that a relational expression is no longer of |
| interest to the planner.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="relChosen(org.apache.calcite.plan.RelOptListener.RelChosenEvent)"> |
| <h3>relChosen</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">relChosen</span><wbr><span class="parameters">(<a href="RelOptListener.RelChosenEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelChosenEvent</a> event)</span></div> |
| <div class="block">Notifies this listener that a relational expression has been chosen as |
| part of the final implementation of the query plan. After the plan is |
| complete, this is called one more time with null for the rel.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
