blob: 545ad513aabb43e8225e45343fe10238bdc88e26 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_181-google-v7) on Wed Aug 14 17:37:11 PDT 2019 -->
<title>JoinRelOptRuleCall (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JoinRelOptRuleCall (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamValuesRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.JoinChecker.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rule"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html" target="_top">Frames</a></li>
<li><a href="JoinRelOptRuleCall.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.calcite.plan.RelOptRuleCall">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.extensions.sql.impl.rule</div>
<h2 title="Class JoinRelOptRuleCall" class="title">Class JoinRelOptRuleCall</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.plan.RelOptRuleCall</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.impl.rule.JoinRelOptRuleCall</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JoinRelOptRuleCall</span>
extends org.apache.calcite.plan.RelOptRuleCall</pre>
<div class="block">This is a class to catch the built join and check if it is a legal join before passing it to the
actual RelOptRuleCall.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.JoinChecker.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rule">JoinRelOptRuleCall.JoinChecker</a></span></code>
<div class="block">This is a function gets the output relation and checks if it is a legal relational node.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.calcite.plan.RelOptRuleCall">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.calcite.plan.RelOptRuleCall</h3>
<code>id, LOGGER, nodeInputs, operand0, rels, rule</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.calcite.tools.RelBuilder</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#builder--">builder</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;org.apache.calcite.rel.RelNode&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getChildRels-org.apache.calcite.rel.RelNode-">getChildRels</a></span>(org.apache.calcite.rel.RelNode&nbsp;rel)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.apache.calcite.rel.metadata.RelMetadataQuery</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getMetadataQuery--">getMetadataQuery</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.plan.RelOptRuleOperand</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getOperand0--">getOperand0</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;org.apache.calcite.rel.RelNode&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getParents--">getParents</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.plan.RelOptPlanner</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getPlanner--">getPlanner</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.List&lt;org.apache.calcite.rel.RelNode&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getRelList--">getRelList</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.plan.RelOptRule</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#getRule--">getRule</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>&lt;T extends org.apache.calcite.rel.RelNode&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#rel-int-">rel</a></span>(int&nbsp;ordinal)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html#transformTo-org.apache.calcite.rel.RelNode-java.util.Map-">transformTo</a></span>(org.apache.calcite.rel.RelNode&nbsp;rel,
java.util.Map&lt;org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode&gt;&nbsp;equiv)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.plan.RelOptRuleCall">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.plan.RelOptRuleCall</h3>
<code>getRels, setChildRels, transformTo</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="transformTo-org.apache.calcite.rel.RelNode-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transformTo</h4>
<pre>public&nbsp;void&nbsp;transformTo(org.apache.calcite.rel.RelNode&nbsp;rel,
java.util.Map&lt;org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode&gt;&nbsp;equiv)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>transformTo</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getOperand0--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperand0</h4>
<pre>public&nbsp;org.apache.calcite.plan.RelOptRuleOperand&nbsp;getOperand0()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getOperand0</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getRule--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRule</h4>
<pre>public&nbsp;org.apache.calcite.plan.RelOptRule&nbsp;getRule()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getRule</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getRelList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelList</h4>
<pre>public&nbsp;java.util.List&lt;org.apache.calcite.rel.RelNode&gt;&nbsp;getRelList()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getRelList</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="rel-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rel</h4>
<pre>public&nbsp;&lt;T extends org.apache.calcite.rel.RelNode&gt;&nbsp;T&nbsp;rel(int&nbsp;ordinal)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>rel</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getChildRels-org.apache.calcite.rel.RelNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildRels</h4>
<pre>public&nbsp;java.util.List&lt;org.apache.calcite.rel.RelNode&gt;&nbsp;getChildRels(org.apache.calcite.rel.RelNode&nbsp;rel)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getChildRels</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getPlanner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlanner</h4>
<pre>public&nbsp;org.apache.calcite.plan.RelOptPlanner&nbsp;getPlanner()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getPlanner</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getMetadataQuery--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadataQuery</h4>
<pre>public&nbsp;org.apache.calcite.rel.metadata.RelMetadataQuery&nbsp;getMetadataQuery()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getMetadataQuery</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="getParents--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParents</h4>
<pre>public&nbsp;java.util.List&lt;org.apache.calcite.rel.RelNode&gt;&nbsp;getParents()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>getParents</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
<a name="builder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>builder</h4>
<pre>public&nbsp;org.apache.calcite.tools.RelBuilder&nbsp;builder()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>builder</code>&nbsp;in class&nbsp;<code>org.apache.calcite.plan.RelOptRuleCall</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/BeamValuesRule.html" title="class in org.apache.beam.sdk.extensions.sql.impl.rule"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.JoinChecker.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.rule"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/rule/JoinRelOptRuleCall.html" target="_top">Frames</a></li>
<li><a href="JoinRelOptRuleCall.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.calcite.plan.RelOptRuleCall">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>