Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / sql2rel / CorrelationReferenceFinder.html
blob: 1a2ddcb994a1d661e37f209e22e3539ba56f1ad5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>CorrelationReferenceFinder (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.sql2rel, class: CorrelationReferenceFinder">
<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><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&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.sql2rel</a></div>
<h1 title="Class CorrelationReferenceFinder" class="title">Class CorrelationReferenceFinder</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="../rel/RelShuttleImpl.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.RelShuttleImpl</a>
<div class="inheritance"><a href="../rel/RelHomogeneousShuttle.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.RelHomogeneousShuttle</a>
<div class="inheritance">org.apache.calcite.sql2rel.CorrelationReferenceFinder</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../rel/RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">CorrelationReferenceFinder</span>
<span class="extends-implements">extends <a href="../rel/RelHomogeneousShuttle.html" title="class in org.apache.calcite.rel">RelHomogeneousShuttle</a></span></div>
<div class="block">Shuttle that finds references to a given <a href="../rel/core/CorrelationId.html" title="class in org.apache.calcite.rel.core"><code>CorrelationId</code></a> within a tree
of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>s.</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.rel.RelShuttleImpl">Fields inherited from class&nbsp;org.apache.calcite.rel.<a href="../rel/RelShuttleImpl.html" title="class in org.apache.calcite.rel">RelShuttleImpl</a></h3>
<code><a href="../rel/RelShuttleImpl.html#stack">stack</a></code></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()" class="member-name-link">CorrelationReferenceFinder</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates CorrelationReferenceFinder.</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><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-tab3"><code>protected abstract <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#handle(org.apache.calcite.rex.RexFieldAccess)" class="member-name-link">handle</a><wbr>(<a href="../rex/RexFieldAccess.html" title="class in org.apache.calcite.rex">RexFieldAccess</a>&nbsp;fieldAccess)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.rel.RelNode)" class="member-name-link">visit</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelHomogeneousShuttle">Methods inherited from class&nbsp;org.apache.calcite.rel.<a href="../rel/RelHomogeneousShuttle.html" title="class in org.apache.calcite.rel">RelHomogeneousShuttle</a></h3>
<code><a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.core.TableFunctionScan)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.core.TableScan)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalAggregate)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalCalc)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalCorrelate)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalExchange)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalFilter)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalIntersect)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalJoin)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalMatch)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalMinus)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalProject)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalSort)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalTableModify)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalUnion)">visit</a>, <a href="../rel/RelHomogeneousShuttle.html#visit(org.apache.calcite.rel.logical.LogicalValues)">visit</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelShuttleImpl">Methods inherited from class&nbsp;org.apache.calcite.rel.<a href="../rel/RelShuttleImpl.html" title="class in org.apache.calcite.rel">RelShuttleImpl</a></h3>
<code><a href="../rel/RelShuttleImpl.html#visitChild(org.apache.calcite.rel.RelNode,int,org.apache.calcite.rel.RelNode)">visitChild</a>, <a href="../rel/RelShuttleImpl.html#visitChildren(org.apache.calcite.rel.RelNode)">visitChildren</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>CorrelationReferenceFinder</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">CorrelationReferenceFinder</span>()</div>
<div class="block">Creates CorrelationReferenceFinder.</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="handle(org.apache.calcite.rex.RexFieldAccess)">
<h3>handle</h3>
<div class="member-signature"><span class="modifiers">protected abstract</span>&nbsp;<span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span>&nbsp;<span class="element-name">handle</span><wbr><span class="parameters">(<a href="../rex/RexFieldAccess.html" title="class in org.apache.calcite.rex">RexFieldAccess</a>&nbsp;fieldAccess)</span></div>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.rel.RelNode)">
<h3>visit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;other)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../rel/RelShuttle.html#visit(org.apache.calcite.rel.RelNode)">visit</a></code>&nbsp;in interface&nbsp;<code><a href="../rel/RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="../rel/RelShuttleImpl.html#visit(org.apache.calcite.rel.RelNode)">visit</a></code>&nbsp;in class&nbsp;<code><a href="../rel/RelShuttleImpl.html" title="class in org.apache.calcite.rel">RelShuttleImpl</a></code></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>