Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / plan / hep / HepRuleCall.html
blob: c7513602d930430ea32713c34b2e37b523e86518 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>HepRuleCall (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.hep, class: HepRuleCall">
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.plan.hep</a></div>
<h1 title="Class HepRuleCall" class="title">Class HepRuleCall</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"><a href="../RelOptRuleCall.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.RelOptRuleCall</a>
<div class="inheritance">org.apache.calcite.plan.hep.HepRuleCall</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">HepRuleCall</span>
<span class="extends-implements">extends <a href="../RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a></span></div>
<div class="block">HepRuleCall implements <a href="../RelOptRuleCall.html" title="class in org.apache.calcite.plan"><code>RelOptRuleCall</code></a> for a <a href="HepPlanner.html" title="class in org.apache.calcite.plan.hep"><code>HepPlanner</code></a>. It
remembers transformation results so that the planner can choose which one (if
any) should replace the original expression.</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="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.plan.RelOptRuleCall">Fields inherited from class&nbsp;org.apache.calcite.plan.<a href="../RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a></h3>
<code><a href="../RelOptRuleCall.html#id">id</a>, <a href="../RelOptRuleCall.html#LOGGER">LOGGER</a>, <a href="../RelOptRuleCall.html#nodeInputs">nodeInputs</a>, <a href="../RelOptRuleCall.html#operand0">operand0</a>, <a href="../RelOptRuleCall.html#rels">rels</a>, <a href="../RelOptRuleCall.html#rule">rule</a></code></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="#transformTo(org.apache.calcite.rel.RelNode,java.util.Map,org.apache.calcite.plan.RelHintsPropagator)" class="member-name-link">transformTo</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;equiv,
<a href="../RelHintsPropagator.html" title="interface in org.apache.calcite.plan">RelHintsPropagator</a>&nbsp;handler)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Registers that a rule has produced an equivalent relational expression.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelOptRuleCall">Methods inherited from class&nbsp;org.apache.calcite.plan.<a href="../RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a></h3>
<code><a href="../RelOptRuleCall.html#builder()">builder</a>, <a href="../RelOptRuleCall.html#getChildRels(org.apache.calcite.rel.RelNode)">getChildRels</a>, <a href="../RelOptRuleCall.html#getMetadataQuery()">getMetadataQuery</a>, <a href="../RelOptRuleCall.html#getOperand0()">getOperand0</a>, <a href="../RelOptRuleCall.html#getParents()">getParents</a>, <a href="../RelOptRuleCall.html#getPlanner()">getPlanner</a>, <a href="../RelOptRuleCall.html#getRelList()">getRelList</a>, <a href="../RelOptRuleCall.html#getRels()">getRels</a>, <a href="../RelOptRuleCall.html#getRule()">getRule</a>, <a href="../RelOptRuleCall.html#isRuleExcluded()">isRuleExcluded</a>, <a href="../RelOptRuleCall.html#rel(int)">rel</a>, <a href="../RelOptRuleCall.html#setChildRels(org.apache.calcite.rel.RelNode,java.util.List)">setChildRels</a>, <a href="../RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode)">transformTo</a>, <a href="../RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode,java.util.Map)">transformTo</a>, <a href="../RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelHintsPropagator)">transformTo</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="transformTo(org.apache.calcite.rel.RelNode,java.util.Map,org.apache.calcite.plan.RelHintsPropagator)">
<h3>transformTo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">transformTo</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;equiv,
<a href="../RelHintsPropagator.html" title="interface in org.apache.calcite.plan">RelHintsPropagator</a>&nbsp;handler)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode,java.util.Map,org.apache.calcite.plan.RelHintsPropagator)">RelOptRuleCall</a></code></span></div>
<div class="block">Registers that a rule has produced an equivalent relational expression.
<p>Called by the rule whenever it finds a match. The implementation of
this method guarantees that the original relational expression (that is,
<code>this.rels[0]</code>) has its traits propagated to the new
relational expression (<code>rel</code>) and its unregistered children.
Any trait not specifically set in the RelTraitSet returned by <code>
rel.getTraits()</code> will be copied from <code>
this.rels[0].getTraitSet()</code>.
<p>The hints of the root relational expression of
the rule call(<code>this.rels[0]</code>)
are copied to the new relational expression(<code>rel</code>)
with specified handler <code>handler</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode,java.util.Map,org.apache.calcite.plan.RelHintsPropagator)">transformTo</a></code>&nbsp;in class&nbsp;<code><a href="../RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a></code></dd>
<dt>Parameters:</dt>
<dd><code>rel</code> - Relational expression equivalent to the root relational
expression of the rule call, <code>call.rels(0)</code></dd>
<dd><code>equiv</code> - Map of other equivalences</dd>
<dd><code>handler</code> - Handler to customize the relational expression that registers
into the planner, the first parameter is the root relational expression
and the second parameter is the new relational expression</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>