| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RuleMatchVisualizer (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.visualizer, class: RuleMatchVisualizer"> |
| <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><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.visualizer</a></div> |
| <h1 title="Class RuleMatchVisualizer" class="title">Class RuleMatchVisualizer</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.visualizer.RuleMatchVisualizer</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</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>, <code><a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RuleMatchVisualizer</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> |
| implements <a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></span></div> |
| <div class="block">This is a tool to visualize the rule match process of a RelOptPlanner. |
| |
| <pre><code> |
| // create the visualizer |
| RuleMatchVisualizer viz = new RuleMatchVisualizer("/path/to/output/dir", "file-name-suffix"); |
| viz.attachTo(planner) |
| |
| planner.findBestExpr(); |
| |
| // extra step for HepPlanner: write the output to files |
| // a VolcanoPlanner will call it automatically |
| viz.writeToFile(); |
| </code></pre></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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.plan.RelOptListener">Nested classes/interfaces inherited from interface org.apache.calcite.plan.<a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></h2> |
| <code><a href="../RelOptListener.RelChosenEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelChosenEvent</a>, <a href="../RelOptListener.RelDiscardedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelDiscardedEvent</a>, <a href="../RelOptListener.RelEquivalenceEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelEquivalenceEvent</a>, <a href="../RelOptListener.RelEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RelEvent</a>, <a href="../RelOptListener.RuleAttemptedEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleAttemptedEvent</a>, <a href="../RelOptListener.RuleEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleEvent</a>, <a href="../RelOptListener.RuleProductionEvent.html" title="class in org.apache.calcite.plan">RelOptListener.RuleProductionEvent</a></code></div> |
| </section> |
| </li> |
| <!-- =========== 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>static final <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 even-row-color"><code><a href="#DEFAULT_SET" class="member-name-link">DEFAULT_SET</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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RuleMatchVisualizer</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Use this constructor when the result shall not be written to disk.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">RuleMatchVisualizer</a><wbr>(<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> outputDirectory, |
| <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> outputSuffix)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Use this constructor to save the result on disk at the end of the planning |
| phase.</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#attachTo(org.apache.calcite.plan.RelOptPlanner)" class="member-name-link">attachTo</a><wbr>(<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Attaches the visualizer to the planner.</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="#getJsonStringResult()" class="member-name-link">getJsonStringResult</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"> |
| <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-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="#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-tab4"> |
| <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-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="#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-tab4"> |
| <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-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="#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-tab4"> |
| <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-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="#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-tab4"> |
| <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 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="#setIncludeIntermediateCosts(boolean)" class="member-name-link">setIncludeIntermediateCosts</a><wbr>(boolean includeIntermediateCosts)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Output intermediate costs, including all cost updates.</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="#setIncludeTransitiveEdges(boolean)" class="member-name-link">setIncludeTransitiveEdges</a><wbr>(boolean includeTransitiveEdges)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Output edges from a subset to the nodes of all subsets that satisfy it.</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="#writeToFile()" class="member-name-link">writeToFile</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes the HTML and JS files of the rule match visualization.</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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</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#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</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#toString()" title="class or interface in java.lang" class="external-link">toString</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="DEFAULT_SET"> |
| <h3>DEFAULT_SET</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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">DEFAULT_SET</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.plan.visualizer.RuleMatchVisualizer.DEFAULT_SET">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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.String,java.lang.String)"> |
| <h3>RuleMatchVisualizer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RuleMatchVisualizer</span><wbr><span class="parameters">(<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> outputDirectory, |
| <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> outputSuffix)</span></div> |
| <div class="block">Use this constructor to save the result on disk at the end of the planning |
| phase. |
| |
| <p>Note: when using HepPlanner, <a href="#writeToFile()"><code>writeToFile()</code></a> needs to be called |
| manually.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>RuleMatchVisualizer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RuleMatchVisualizer</span>()</div> |
| <div class="block">Use this constructor when the result shall not be written to disk.</div> |
| </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="attachTo(org.apache.calcite.plan.RelOptPlanner)"> |
| <h3>attachTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">attachTo</span><wbr><span class="parameters">(<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</span></div> |
| <div class="block">Attaches the visualizer to the planner. |
| Must be called before applying the rules. |
| Must be called exactly once.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIncludeTransitiveEdges(boolean)"> |
| <h3>setIncludeTransitiveEdges</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIncludeTransitiveEdges</span><wbr><span class="parameters">(boolean includeTransitiveEdges)</span></div> |
| <div class="block">Output edges from a subset to the nodes of all subsets that satisfy it.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIncludeIntermediateCosts(boolean)"> |
| <h3>setIncludeIntermediateCosts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIncludeIntermediateCosts</span><wbr><span class="parameters">(boolean includeIntermediateCosts)</span></div> |
| <div class="block">Output intermediate costs, including all cost updates.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ruleAttempted(org.apache.calcite.plan.RelOptListener.RuleAttemptedEvent)"> |
| <h3>ruleAttempted</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptListener.html#ruleAttempted(org.apache.calcite.plan.RelOptListener.RuleAttemptedEvent)">RelOptListener</a></code></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>Specified by:</dt> |
| <dd><code><a href="../RelOptListener.html#ruleAttempted(org.apache.calcite.plan.RelOptListener.RuleAttemptedEvent)">ruleAttempted</a></code> in interface <code><a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></dd> |
| <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="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptListener.html#relChosen(org.apache.calcite.plan.RelOptListener.RelChosenEvent)">RelOptListener</a></code></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>Specified by:</dt> |
| <dd><code><a href="../RelOptListener.html#relChosen(org.apache.calcite.plan.RelOptListener.RelChosenEvent)">relChosen</a></code> in interface <code><a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></dd> |
| <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="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptListener.html#ruleProductionSucceeded(org.apache.calcite.plan.RelOptListener.RuleProductionEvent)">RelOptListener</a></code></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>Specified by:</dt> |
| <dd><code><a href="../RelOptListener.html#ruleProductionSucceeded(org.apache.calcite.plan.RelOptListener.RuleProductionEvent)">ruleProductionSucceeded</a></code> in interface <code><a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></dd> |
| <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="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptListener.html#relDiscarded(org.apache.calcite.plan.RelOptListener.RelDiscardedEvent)">RelOptListener</a></code></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>Specified by:</dt> |
| <dd><code><a href="../RelOptListener.html#relDiscarded(org.apache.calcite.plan.RelOptListener.RelDiscardedEvent)">relDiscarded</a></code> in interface <code><a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="relEquivalenceFound(org.apache.calcite.plan.RelOptListener.RelEquivalenceEvent)"> |
| <h3>relEquivalenceFound</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelOptListener.html#relEquivalenceFound(org.apache.calcite.plan.RelOptListener.RelEquivalenceEvent)">RelOptListener</a></code></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>Specified by:</dt> |
| <dd><code><a href="../RelOptListener.html#relEquivalenceFound(org.apache.calcite.plan.RelOptListener.RelEquivalenceEvent)">relEquivalenceFound</a></code> in interface <code><a href="../RelOptListener.html" title="interface in org.apache.calcite.plan">RelOptListener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - details about the event</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJsonStringResult()"> |
| <h3>getJsonStringResult</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">getJsonStringResult</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeToFile()"> |
| <h3>writeToFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">writeToFile</span>()</div> |
| <div class="block">Writes the HTML and JS files of the rule match visualization. |
| <p> |
| The old files with the same name will be replaced.</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> |
