Google Git
Sign in
apache / calcite-site / ea7bd59de63e44ef822bd3c62faa848069cf4d92 / . / apidocs / org / apache / calcite / rel / RelNode.html
blob: a9b22594a8555fb2df3a5981844bbcf997c557ba [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelNode (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RelNode (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6,"i8":6,"i9":6,"i10":38,"i11":38,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":38,"i18":6,"i19":38,"i20":6,"i21":6,"i22":6,"i23":38,"i24":38,"i25":38,"i26":38,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RelNode.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rel</a></div>
<h2 title="Interface RelNode" class="title">Interface RelNode</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code>java.lang.Cloneable</code>, <code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../interpreter/BindableRel.html" title="interface in org.apache.calcite.interpreter">BindableRel</a></code>, <code><a href="../adapter/cassandra/CassandraRel.html" title="interface in org.apache.calcite.adapter.cassandra">CassandraRel</a></code>, <code><a href="convert/Converter.html" title="interface in org.apache.calcite.rel.convert">Converter</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchRel.html" title="interface in org.apache.calcite.adapter.elasticsearch">ElasticsearchRel</a></code>, <code><a href="../adapter/enumerable/EnumerableRel.html" title="interface in org.apache.calcite.adapter.enumerable">EnumerableRel</a></code>, <code><a href="../adapter/geode/rel/GeodeRel.html" title="interface in org.apache.calcite.adapter.geode.rel">GeodeRel</a></code>, <code><a href="../interpreter/InterpretableRel.html" title="interface in org.apache.calcite.interpreter">InterpretableRel</a></code>, <code><a href="../adapter/jdbc/JdbcRel.html" title="interface in org.apache.calcite.adapter.jdbc">JdbcRel</a></code>, <code><a href="../adapter/mongodb/MongoRel.html" title="interface in org.apache.calcite.adapter.mongodb">MongoRel</a></code>, <code><a href="../adapter/pig/PigRel.html" title="interface in org.apache.calcite.adapter.pig">PigRel</a></code>, <code><a href="../sql2rel/RelStructuredTypeFlattener.SelfFlatteningRel.html" title="interface in org.apache.calcite.sql2rel">RelStructuredTypeFlattener.SelfFlatteningRel</a></code>, <code><a href="../adapter/spark/SparkRel.html" title="interface in org.apache.calcite.adapter.spark">SparkRel</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../plan/volcano/AbstractConverter.html" title="class in org.apache.calcite.plan.volcano">AbstractConverter</a></code>, <code><a href="AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code>, <code><a href="core/Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></code>, <code><a href="../interpreter/Bindables.BindableAggregate.html" title="class in org.apache.calcite.interpreter">Bindables.BindableAggregate</a></code>, <code><a href="../interpreter/Bindables.BindableFilter.html" title="class in org.apache.calcite.interpreter">Bindables.BindableFilter</a></code>, <code><a href="../interpreter/Bindables.BindableJoin.html" title="class in org.apache.calcite.interpreter">Bindables.BindableJoin</a></code>, <code><a href="../interpreter/Bindables.BindableProject.html" title="class in org.apache.calcite.interpreter">Bindables.BindableProject</a></code>, <code><a href="../interpreter/Bindables.BindableSort.html" title="class in org.apache.calcite.interpreter">Bindables.BindableSort</a></code>, <code><a href="../interpreter/Bindables.BindableTableScan.html" title="class in org.apache.calcite.interpreter">Bindables.BindableTableScan</a></code>, <code><a href="../interpreter/Bindables.BindableUnion.html" title="class in org.apache.calcite.interpreter">Bindables.BindableUnion</a></code>, <code><a href="../interpreter/Bindables.BindableValues.html" title="class in org.apache.calcite.interpreter">Bindables.BindableValues</a></code>, <code><a href="../interpreter/Bindables.BindableWindow.html" title="class in org.apache.calcite.interpreter">Bindables.BindableWindow</a></code>, <code><a href="BiRel.html" title="class in org.apache.calcite.rel">BiRel</a></code>, <code><a href="core/Calc.html" title="class in org.apache.calcite.rel.core">Calc</a></code>, <code><a href="../adapter/cassandra/CassandraFilter.html" title="class in org.apache.calcite.adapter.cassandra">CassandraFilter</a></code>, <code><a href="../adapter/cassandra/CassandraLimit.html" title="class in org.apache.calcite.adapter.cassandra">CassandraLimit</a></code>, <code><a href="../adapter/cassandra/CassandraProject.html" title="class in org.apache.calcite.adapter.cassandra">CassandraProject</a></code>, <code><a href="../adapter/cassandra/CassandraSort.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSort</a></code>, <code><a href="../adapter/cassandra/CassandraTableScan.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTableScan</a></code>, <code><a href="../adapter/cassandra/CassandraToEnumerableConverter.html" title="class in org.apache.calcite.adapter.cassandra">CassandraToEnumerableConverter</a></code>, <code><a href="stream/Chi.html" title="class in org.apache.calcite.rel.stream">Chi</a></code>, <code><a href="core/Collect.html" title="class in org.apache.calcite.rel.core">Collect</a></code>, <code><a href="convert/ConverterImpl.html" title="class in org.apache.calcite.rel.convert">ConverterImpl</a></code>, <code><a href="core/Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></code>, <code><a href="../adapter/csv/CsvTableScan.html" title="class in org.apache.calcite.adapter.csv">CsvTableScan</a></code>, <code><a href="stream/Delta.html" title="class in org.apache.calcite.rel.stream">Delta</a></code>, <code><a href="../adapter/druid/DruidQuery.html" title="class in org.apache.calcite.adapter.druid">DruidQuery</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchAggregate.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchAggregate</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchFilter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchFilter</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchProject.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchProject</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchSort.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSort</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchTableScan.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTableScan</a></code>, <code><a href="../adapter/elasticsearch/ElasticsearchToEnumerableConverter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchToEnumerableConverter</a></code>, <code><a href="../adapter/enumerable/EnumerableAggregate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregate</a></code>, <code><a href="../adapter/enumerable/EnumerableBindable.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableBindable</a></code>, <code><a href="../adapter/enumerable/EnumerableCalc.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCalc</a></code>, <code><a href="../adapter/enumerable/EnumerableCollect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCollect</a></code>, <code><a href="../adapter/enumerable/EnumerableCorrelate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCorrelate</a></code>, <code><a href="../adapter/enumerable/EnumerableFilter.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableFilter</a></code>, <code><a href="../adapter/enumerable/EnumerableHashJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableHashJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableInterpretable.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableInterpretable</a></code>, <code><a href="../adapter/enumerable/EnumerableInterpreter.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableInterpreter</a></code>, <code><a href="../adapter/enumerable/EnumerableIntersect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableIntersect</a></code>, <code><a href="../adapter/enumerable/EnumerableLimit.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableLimit</a></code>, <code><a href="../adapter/enumerable/EnumerableMergeJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMergeJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableMinus.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMinus</a></code>, <code><a href="../adapter/enumerable/EnumerableNestedLoopJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableNestedLoopJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableProject.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableProject</a></code>, <code><a href="../adapter/enumerable/EnumerableRepeatUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRepeatUnion</a></code>, <code><a href="../adapter/enumerable/EnumerableSemiJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSemiJoin</a></code>, <code><a href="../adapter/enumerable/EnumerableSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSort</a></code>, <code><a href="../adapter/enumerable/EnumerableTableFunctionScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableFunctionScan</a></code>, <code><a href="../adapter/enumerable/EnumerableTableModify.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableModify</a></code>, <code><a href="../adapter/enumerable/EnumerableTableScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableScan</a></code>, <code><a href="../adapter/enumerable/EnumerableTableSpool.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableSpool</a></code>, <code><a href="../adapter/spark/EnumerableToSparkConverter.html" title="class in org.apache.calcite.adapter.spark">EnumerableToSparkConverter</a></code>, <code><a href="../adapter/enumerable/EnumerableUncollect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUncollect</a></code>, <code><a href="../adapter/enumerable/EnumerableUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUnion</a></code>, <code><a href="../adapter/enumerable/EnumerableValues.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableValues</a></code>, <code><a href="../adapter/enumerable/EnumerableWindow.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableWindow</a></code>, <code><a href="core/EquiJoin.html" title="class in org.apache.calcite.rel.core">EquiJoin</a></code>, <code><a href="rules/EquiJoin.html" title="class in org.apache.calcite.rel.rules">EquiJoin</a></code>, <code><a href="core/Exchange.html" title="class in org.apache.calcite.rel.core">Exchange</a></code>, <code><a href="../adapter/file/FileTableScan.html" title="class in org.apache.calcite.adapter.file">FileTableScan</a></code>, <code><a href="core/Filter.html" title="class in org.apache.calcite.rel.core">Filter</a></code>, <code><a href="../adapter/geode/rel/GeodeAggregate.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeAggregate</a></code>, <code><a href="../adapter/geode/rel/GeodeFilter.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeFilter</a></code>, <code><a href="../adapter/geode/rel/GeodeProject.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeProject</a></code>, <code><a href="../adapter/geode/rel/GeodeSort.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeSort</a></code>, <code><a href="../adapter/geode/rel/GeodeTableScan.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeTableScan</a></code>, <code><a href="../adapter/geode/rel/GeodeToEnumerableConverter.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeToEnumerableConverter</a></code>, <code><a href="../plan/hep/HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a></code>, <code><a href="../interpreter/InterpretableConverter.html" title="class in org.apache.calcite.interpreter">InterpretableConverter</a></code>, <code><a href="core/Intersect.html" title="class in org.apache.calcite.rel.core">Intersect</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcAggregate.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcAggregate</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcCalc.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcCalc</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcFilter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcFilter</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcIntersect.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcIntersect</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcJoin.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcJoin</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcMinus.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcMinus</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcProject.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcProject</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcSort.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcSort</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcTableModify.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcTableModify</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcUnion.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcUnion</a></code>, <code><a href="../adapter/jdbc/JdbcRules.JdbcValues.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcValues</a></code>, <code><a href="../adapter/jdbc/JdbcTableScan.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTableScan</a></code>, <code><a href="../adapter/jdbc/JdbcToEnumerableConverter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcToEnumerableConverter</a></code>, <code><a href="../adapter/spark/JdbcToSparkConverter.html" title="class in org.apache.calcite.adapter.spark">JdbcToSparkConverter</a></code>, <code><a href="core/Join.html" title="class in org.apache.calcite.rel.core">Join</a></code>, <code><a href="logical/LogicalAggregate.html" title="class in org.apache.calcite.rel.logical">LogicalAggregate</a></code>, <code><a href="logical/LogicalCalc.html" title="class in org.apache.calcite.rel.logical">LogicalCalc</a></code>, <code><a href="stream/LogicalChi.html" title="class in org.apache.calcite.rel.stream">LogicalChi</a></code>, <code><a href="logical/LogicalCorrelate.html" title="class in org.apache.calcite.rel.logical">LogicalCorrelate</a></code>, <code><a href="stream/LogicalDelta.html" title="class in org.apache.calcite.rel.stream">LogicalDelta</a></code>, <code><a href="logical/LogicalExchange.html" title="class in org.apache.calcite.rel.logical">LogicalExchange</a></code>, <code><a href="logical/LogicalFilter.html" title="class in org.apache.calcite.rel.logical">LogicalFilter</a></code>, <code><a href="logical/LogicalIntersect.html" title="class in org.apache.calcite.rel.logical">LogicalIntersect</a></code>, <code><a href="logical/LogicalJoin.html" title="class in org.apache.calcite.rel.logical">LogicalJoin</a></code>, <code><a href="logical/LogicalMatch.html" title="class in org.apache.calcite.rel.logical">LogicalMatch</a></code>, <code><a href="logical/LogicalMinus.html" title="class in org.apache.calcite.rel.logical">LogicalMinus</a></code>, <code><a href="logical/LogicalProject.html" title="class in org.apache.calcite.rel.logical">LogicalProject</a></code>, <code><a href="logical/LogicalRepeatUnion.html" title="class in org.apache.calcite.rel.logical">LogicalRepeatUnion</a></code>, <code><a href="logical/LogicalSnapshot.html" title="class in org.apache.calcite.rel.logical">LogicalSnapshot</a></code>, <code><a href="logical/LogicalSort.html" title="class in org.apache.calcite.rel.logical">LogicalSort</a></code>, <code><a href="logical/LogicalSortExchange.html" title="class in org.apache.calcite.rel.logical">LogicalSortExchange</a></code>, <code><a href="logical/LogicalTableFunctionScan.html" title="class in org.apache.calcite.rel.logical">LogicalTableFunctionScan</a></code>, <code><a href="logical/LogicalTableModify.html" title="class in org.apache.calcite.rel.logical">LogicalTableModify</a></code>, <code><a href="logical/LogicalTableScan.html" title="class in org.apache.calcite.rel.logical">LogicalTableScan</a></code>, <code><a href="logical/LogicalTableSpool.html" title="class in org.apache.calcite.rel.logical">LogicalTableSpool</a></code>, <code><a href="logical/LogicalUnion.html" title="class in org.apache.calcite.rel.logical">LogicalUnion</a></code>, <code><a href="logical/LogicalValues.html" title="class in org.apache.calcite.rel.logical">LogicalValues</a></code>, <code><a href="logical/LogicalWindow.html" title="class in org.apache.calcite.rel.logical">LogicalWindow</a></code>, <code><a href="core/Match.html" title="class in org.apache.calcite.rel.core">Match</a></code>, <code><a href="core/Minus.html" title="class in org.apache.calcite.rel.core">Minus</a></code>, <code><a href="../adapter/mongodb/MongoAggregate.html" title="class in org.apache.calcite.adapter.mongodb">MongoAggregate</a></code>, <code><a href="../adapter/mongodb/MongoFilter.html" title="class in org.apache.calcite.adapter.mongodb">MongoFilter</a></code>, <code><a href="../adapter/mongodb/MongoProject.html" title="class in org.apache.calcite.adapter.mongodb">MongoProject</a></code>, <code><a href="../adapter/mongodb/MongoSort.html" title="class in org.apache.calcite.adapter.mongodb">MongoSort</a></code>, <code><a href="../adapter/mongodb/MongoTableScan.html" title="class in org.apache.calcite.adapter.mongodb">MongoTableScan</a></code>, <code><a href="../adapter/mongodb/MongoToEnumerableConverter.html" title="class in org.apache.calcite.adapter.mongodb">MongoToEnumerableConverter</a></code>, <code><a href="rules/MultiJoin.html" title="class in org.apache.calcite.rel.rules">MultiJoin</a></code>, <code><a href="convert/NoneConverter.html" title="class in org.apache.calcite.rel.convert">NoneConverter</a></code>, <code><a href="../adapter/pig/PigAggregate.html" title="class in org.apache.calcite.adapter.pig">PigAggregate</a></code>, <code><a href="../adapter/pig/PigFilter.html" title="class in org.apache.calcite.adapter.pig">PigFilter</a></code>, <code><a href="../adapter/pig/PigJoin.html" title="class in org.apache.calcite.adapter.pig">PigJoin</a></code>, <code><a href="../adapter/pig/PigProject.html" title="class in org.apache.calcite.adapter.pig">PigProject</a></code>, <code><a href="../adapter/pig/PigTableScan.html" title="class in org.apache.calcite.adapter.pig">PigTableScan</a></code>, <code><a href="../adapter/pig/PigToEnumerableConverter.html" title="class in org.apache.calcite.adapter.pig">PigToEnumerableConverter</a></code>, <code><a href="core/Project.html" title="class in org.apache.calcite.rel.core">Project</a></code>, <code><a href="../plan/volcano/RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a></code>, <code><a href="core/RepeatUnion.html" title="class in org.apache.calcite.rel.core">RepeatUnion</a></code>, <code><a href="core/Sample.html" title="class in org.apache.calcite.rel.core">Sample</a></code>, <code><a href="core/SemiJoin.html" title="class in org.apache.calcite.rel.core">SemiJoin</a></code>, <code><a href="core/SetOp.html" title="class in org.apache.calcite.rel.core">SetOp</a></code>, <code><a href="SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></code>, <code><a href="core/Snapshot.html" title="class in org.apache.calcite.rel.core">Snapshot</a></code>, <code><a href="core/Sort.html" title="class in org.apache.calcite.rel.core">Sort</a></code>, <code><a href="core/SortExchange.html" title="class in org.apache.calcite.rel.core">SortExchange</a></code>, <code><a href="../adapter/spark/SparkRules.SparkCalc.html" title="class in org.apache.calcite.adapter.spark">SparkRules.SparkCalc</a></code>, <code><a href="../adapter/spark/SparkRules.SparkValues.html" title="class in org.apache.calcite.adapter.spark">SparkRules.SparkValues</a></code>, <code><a href="../adapter/spark/SparkToEnumerableConverter.html" title="class in org.apache.calcite.adapter.spark">SparkToEnumerableConverter</a></code>, <code><a href="../adapter/splunk/SplunkTableScan.html" title="class in org.apache.calcite.adapter.splunk">SplunkTableScan</a></code>, <code><a href="core/Spool.html" title="class in org.apache.calcite.rel.core">Spool</a></code>, <code><a href="../schema/impl/StarTable.StarTableScan.html" title="class in org.apache.calcite.schema.impl">StarTable.StarTableScan</a></code>, <code><a href="core/TableFunctionScan.html" title="class in org.apache.calcite.rel.core">TableFunctionScan</a></code>, <code><a href="core/TableModify.html" title="class in org.apache.calcite.rel.core">TableModify</a></code>, <code><a href="core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a></code>, <code><a href="core/TableSpool.html" title="class in org.apache.calcite.rel.core">TableSpool</a></code>, <code><a href="core/Uncollect.html" title="class in org.apache.calcite.rel.core">Uncollect</a></code>, <code><a href="core/Union.html" title="class in org.apache.calcite.rel.core">Union</a></code>, <code><a href="core/Values.html" title="class in org.apache.calcite.rel.core">Values</a></code>, <code><a href="core/Window.html" title="class in org.apache.calcite.rel.core">Window</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">RelNode</span>
extends <a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a>, java.lang.Cloneable</pre>
<div class="block">A <code>RelNode</code> is a relational expression.
<p>Relational expressions process data, so their names are typically verbs:
Sort, Join, Project, Filter, Scan, Sample.
<p>A relational expression is not a scalar expression; see
<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> and <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a>.</p>
<p>If this type of relational expression has some particular planner rules,
it should implement the <em>public static</em> method
<a href="AbstractRelNode.html#register(org.apache.calcite.plan.RelOptPlanner)"><code>AbstractRelNode.register(org.apache.calcite.plan.RelOptPlanner)</code></a>.</p>
<p>When a relational expression comes to be implemented, the system allocates
a <a href="../plan/RelImplementor.html" title="interface in org.apache.calcite.plan"><code>RelImplementor</code></a> to manage the process. Every
implementable relational expression has a <a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan"><code>RelTraitSet</code></a> describing its
physical attributes. The RelTraitSet always contains a <a href="../plan/Convention.html" title="interface in org.apache.calcite.plan"><code>Convention</code></a>
describing how the expression passes data to its consuming
relational expression, but may contain other traits, including some applied
externally. Because traits can be applied externally, implementations of
RelNode should never assume the size or contents of their trait set (beyond
those traits configured by the RelNode itself).</p>
<p>For each calling-convention, there is a corresponding sub-interface of
RelNode. For example,
<code>org.apache.calcite.adapter.enumerable.EnumerableRel</code>
has operations to manage the conversion to a graph of
<code>org.apache.calcite.adapter.enumerable.EnumerableConvention</code>
calling-convention, and it interacts with a
<code>EnumerableRelImplementor</code>.</p>
<p>A relational expression is only required to implement its
calling-convention's interface when it is actually implemented, that is,
converted into a plan/program. This means that relational expressions which
cannot be implemented, such as converters, are not required to implement
their convention's interface.</p>
<p>Every relational expression must derive from <a href="AbstractRelNode.html" title="class in org.apache.calcite.rel"><code>AbstractRelNode</code></a>. (Why
have the <code>RelNode</code> interface, then? We need a root interface,
because an interface can only derive from an interface.)</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></span></code></th>
<td class="colLast">
<div class="block">Context of a relational expression, for purposes of checking validity.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.apache.calcite.rel.RelShuttle)">accept</a></span>&#8203;(<a href="RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a>&nbsp;shuttle)</code></th>
<td class="colLast">
<div class="block">Accepts a visit from a shuttle.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.apache.calcite.rex.RexShuttle)">accept</a></span>&#8203;(<a href="../rex/RexShuttle.html" title="class in org.apache.calcite.rex">RexShuttle</a>&nbsp;shuttle)</code></th>
<td class="colLast">
<div class="block">Accepts a visit from a shuttle.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a></span>&#8203;(<a href="RelVisitor.html" title="class in org.apache.calcite.rel">RelVisitor</a>&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Interacts with the <a href="RelVisitor.html" title="class in org.apache.calcite.rel"><code>RelVisitor</code></a> in a
<a href="../util/Glossary.html#VISITOR_PATTERN"><code>visitor pattern</code></a> to
traverse the tree of relational expressions.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectVariablesSet(java.util.Set)">collectVariablesSet</a></span>&#8203;(java.util.Set&lt;<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</code></th>
<td class="colLast">
<div class="block">Collects variables set by this expression.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a></span>&#8203;(java.util.Set&lt;<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</code></th>
<td class="colLast">
<div class="block">Collects variables known to be used by this expression or its
descendants.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner)">computeSelfCost</a></span>&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Call <a href="metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(RelNode)</code></a>;
if you wish to override the default cost formula, override the
<a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>computeSelfCost(RelOptPlanner, RelMetadataQuery)</code></a> method.</div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></span>&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Returns the cost of this plan (not including children).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></span>&#8203;(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;traitSet,
java.util.List&lt;<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;inputs)</code></th>
<td class="colLast">
<div class="block">Creates a copy of this relational expression, perhaps changing traits and
inputs.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></span>&#8203;(<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Returns an estimate of the number of rows this relational expression will
return.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#explain(org.apache.calcite.rel.RelWriter)">explain</a></span>&#8203;(<a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a>&nbsp;pw)</code></th>
<td class="colLast">
<div class="block">Describes the inputs and attributes of this relational expression.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChildExps()">getChildExps</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use #accept(org.apache.calcite.rex.RexShuttle)</div>
</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollationList()">getCollationList</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="metadata/RelMetadataQuery.html#distribution(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.distribution(RelNode)</code></a></div>
</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConvention()">getConvention</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the CallingConvention trait from this RelNode's
<a href="../plan/RelOptNode.html#getTraitSet()"><code>trait set</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCorrelVariable()">getCorrelVariable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of the variable which is to be implicitly set at runtime
each time a row is returned from the first input of this relational
expression; or null if there is no variable.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpectedInputRowType(int)">getExpectedInputRowType</a></span>&#8203;(int&nbsp;ordinalInParent)</code></th>
<td class="colLast">
<div class="block">Returns the type of the rows expected for an input.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInput(int)">getInput</a></span>&#8203;(int&nbsp;i)</code></th>
<td class="colLast">
<div class="block">Returns the <code>i</code><sup>th</sup> input relational expression.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInputs()">getInputs</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array of this relational expression's inputs.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../plan/RelOptQuery.html" title="class in org.apache.calcite.plan">RelOptQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuery()">getQuery</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelTypeName()">getRelTypeName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of this relational expression's class, sans package
name, for use in explain.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRows()">getRows</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Call <a href="metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(RelNode)</code></a>;
if you wish to override the default row count formula, override the
<a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>estimateRowCount(RelMetadataQuery)</code></a> method.</div>
</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRowType()">getRowType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type of the rows returned by this relational expression.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTable()">getTable</a></span>()</code></th>
<td class="colLast">
<div class="block">If this relational expression represents an access to a table, returns
that table, otherwise returns null.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVariablesSet()">getVariablesSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the variables that are set in this relational
expression but also used and therefore not available to parents of this
relational expression.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVariablesStopped()">getVariablesStopped</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#getVariablesSet()"><code>getVariablesSet()</code></a>
and <a href="core/CorrelationId.html#names(java.util.Set)"><code>CorrelationId.names(Set)</code></a></div>
</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDistinct()">isDistinct</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="metadata/RelMetadataQuery.html#areRowsUnique(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.areRowsUnique(RelNode)</code></a></div>
</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isKey(org.apache.calcite.util.ImmutableBitSet)">isKey</a></span>&#8203;(<a href="../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&nbsp;columns)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="metadata/RelMetadataQuery.html#areColumnsUnique(org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet)"><code>RelMetadataQuery.areColumnsUnique(RelNode, ImmutableBitSet)</code></a></div>
</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid(boolean)">isValid</a></span>&#8203;(boolean&nbsp;fail)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></span>&#8203;(<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus,
<a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Returns whether this relational expression is valid.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>&lt;M extends <a href="metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>&gt;<br>M</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a></span>&#8203;(java.lang.Class&lt;M&gt;&nbsp;metadataClass,
<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Returns a metadata interface.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a></span>&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block">Receives notification that this expression is about to be registered.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recomputeDigest()">recomputeDigest</a></span>()</code></th>
<td class="colLast">
<div class="block">Computes the digest, assigns it, and returns it.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(org.apache.calcite.plan.RelOptPlanner)">register</a></span>&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block">Registers any special rules specific to this kind of relational
expression.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></span>&#8203;(int&nbsp;ordinalInParent,
<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;p)</code></th>
<td class="colLast">
<div class="block">Replaces the <code>ordinalInParent</code><sup>th</sup> input.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.plan.RelOptNode">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.plan.<a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></h3>
<code><a href="../plan/RelOptNode.html#getCluster()">getCluster</a>, <a href="../plan/RelOptNode.html#getDescription()">getDescription</a>, <a href="../plan/RelOptNode.html#getDigest()">getDigest</a>, <a href="../plan/RelOptNode.html#getId()">getId</a>, <a href="../plan/RelOptNode.html#getTraitSet()">getTraitSet</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getChildExps()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildExps</h4>
<pre class="methodSignature">@Deprecated
java.util.List&lt;<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;getChildExps()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use #accept(org.apache.calcite.rex.RexShuttle)</div>
</div>
<div class="block">Returns a list of this relational expression's child expressions.
(These are scalar expressions, and so do not include the relational
inputs that are returned by <a href="#getInputs()"><code>getInputs()</code></a>.
<p>The caller should treat the list as unmodifiable; typical
implementations will return an immutable list. If there are no
child expressions, returns an empty list, not <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of this relational expression's child expressions</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#accept(org.apache.calcite.rex.RexShuttle)"><code>accept(org.apache.calcite.rex.RexShuttle)</code></a></dd>
</dl>
</li>
</ul>
<a id="getConvention()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConvention</h4>
<pre class="methodSignature"><a href="../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;getConvention()</pre>
<div class="block">Return the CallingConvention trait from this RelNode's
<a href="../plan/RelOptNode.html#getTraitSet()"><code>trait set</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this RelNode's CallingConvention</dd>
</dl>
</li>
</ul>
<a id="getCorrelVariable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCorrelVariable</h4>
<pre class="methodSignature">java.lang.String&nbsp;getCorrelVariable()</pre>
<div class="block">Returns the name of the variable which is to be implicitly set at runtime
each time a row is returned from the first input of this relational
expression; or null if there is no variable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of correlating variable, or null</dd>
</dl>
</li>
</ul>
<a id="isDistinct()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDistinct</h4>
<pre class="methodSignature">@Deprecated
boolean&nbsp;isDistinct()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="metadata/RelMetadataQuery.html#areRowsUnique(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.areRowsUnique(RelNode)</code></a></div>
</div>
<div class="block">Returns whether the same value will not come out twice. Default value is
<code>false</code>, derived classes should override.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the same value will not come out twice</dd>
</dl>
</li>
</ul>
<a id="getInput(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInput</h4>
<pre class="methodSignature"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;getInput&#8203;(int&nbsp;i)</pre>
<div class="block">Returns the <code>i</code><sup>th</sup> input relational expression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>i</code> - Ordinal of input</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>i</code><sup>th</sup> input</dd>
</dl>
</li>
</ul>
<a id="getQuery()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQuery</h4>
<pre class="methodSignature">@Deprecated
<a href="../plan/RelOptQuery.html" title="class in org.apache.calcite.plan">RelOptQuery</a>&nbsp;getQuery()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns the sub-query this relational expression belongs to.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Sub-query</dd>
</dl>
</li>
</ul>
<a id="getRowType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowType</h4>
<pre class="methodSignature"><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;getRowType()</pre>
<div class="block">Returns the type of the rows returned by this relational expression.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelOptNode.html#getRowType()">getRowType</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd>
</dl>
</li>
</ul>
<a id="getExpectedInputRowType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpectedInputRowType</h4>
<pre class="methodSignature"><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;getExpectedInputRowType&#8203;(int&nbsp;ordinalInParent)</pre>
<div class="block">Returns the type of the rows expected for an input. Defaults to
<a href="#getRowType()"><code>getRowType()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinalInParent</code> - input's 0-based ordinal with respect to this
parent rel</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>expected row type</dd>
</dl>
</li>
</ul>
<a id="getInputs()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputs</h4>
<pre class="methodSignature">java.util.List&lt;<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;getInputs()</pre>
<div class="block">Returns an array of this relational expression's inputs. If there are no
inputs, returns an empty list, not <code>null</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelOptNode.html#getInputs()">getInputs</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of this relational expression's inputs</dd>
</dl>
</li>
</ul>
<a id="estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimateRowCount</h4>
<pre class="methodSignature">double&nbsp;estimateRowCount&#8203;(<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</pre>
<div class="block">Returns an estimate of the number of rows this relational expression will
return.
<p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use
<a href="metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a chance to
override the rel's default ideas about row count.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mq</code> - Metadata query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimate of the number of rows this relational expression will
return</dd>
</dl>
</li>
</ul>
<a id="getRows()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRows</h4>
<pre class="methodSignature">@Deprecated
double&nbsp;getRows()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Call <a href="metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(RelNode)</code></a>;
if you wish to override the default row count formula, override the
<a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>estimateRowCount(RelMetadataQuery)</code></a> method.</div>
</div>
</li>
</ul>
<a id="getVariablesStopped()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariablesStopped</h4>
<pre class="methodSignature">@Deprecated
java.util.Set&lt;java.lang.String&gt;&nbsp;getVariablesStopped()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="#getVariablesSet()"><code>getVariablesSet()</code></a>
and <a href="core/CorrelationId.html#names(java.util.Set)"><code>CorrelationId.names(Set)</code></a></div>
</div>
<div class="block">Returns the names of variables that are set in this relational
expression but also used and therefore not available to parents of this
relational expression.
<p>Note: only <a href="core/Correlate.html" title="class in org.apache.calcite.rel.core"><code>Correlate</code></a> should set
variables.
<p>Note: <a href="#getVariablesSet()"><code>getVariablesSet()</code></a> is equivalent but returns
<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core"><code>CorrelationId</code></a> rather than their names. It is preferable except for
calling old methods that require a set of strings.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Names of variables which are set in this relational
expression</dd>
</dl>
</li>
</ul>
<a id="getVariablesSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariablesSet</h4>
<pre class="methodSignature">java.util.Set&lt;<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;getVariablesSet()</pre>
<div class="block">Returns the variables that are set in this relational
expression but also used and therefore not available to parents of this
relational expression.
<p>Note: only <a href="core/Correlate.html" title="class in org.apache.calcite.rel.core"><code>Correlate</code></a> should set
variables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Names of variables which are set in this relational
expression</dd>
</dl>
</li>
</ul>
<a id="collectVariablesUsed(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectVariablesUsed</h4>
<pre class="methodSignature">void&nbsp;collectVariablesUsed&#8203;(java.util.Set&lt;<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</pre>
<div class="block">Collects variables known to be used by this expression or its
descendants. By default, no such information is available and must be
derived by analyzing sub-expressions, but some optimizer implementations
may insert special expressions which remember such information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableSet</code> - receives variables used</dd>
</dl>
</li>
</ul>
<a id="collectVariablesSet(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectVariablesSet</h4>
<pre class="methodSignature">void&nbsp;collectVariablesSet&#8203;(java.util.Set&lt;<a href="core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</pre>
<div class="block">Collects variables set by this expression.
TODO: is this required?</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableSet</code> - receives variables known to be set by</dd>
</dl>
</li>
</ul>
<a id="childrenAccept(org.apache.calcite.rel.RelVisitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>childrenAccept</h4>
<pre class="methodSignature">void&nbsp;childrenAccept&#8203;(<a href="RelVisitor.html" title="class in org.apache.calcite.rel">RelVisitor</a>&nbsp;visitor)</pre>
<div class="block">Interacts with the <a href="RelVisitor.html" title="class in org.apache.calcite.rel"><code>RelVisitor</code></a> in a
<a href="../util/Glossary.html#VISITOR_PATTERN"><code>visitor pattern</code></a> to
traverse the tree of relational expressions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - Visitor that will traverse the tree of relational
expressions</dd>
</dl>
</li>
</ul>
<a id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeSelfCost</h4>
<pre class="methodSignature"><a href="../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;computeSelfCost&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</pre>
<div class="block">Returns the cost of this plan (not including children). The base
implementation throws an error; derived classes should override.
<p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use
<a href="metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a
chance to override the rel's default ideas about cost.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planner</code> - Planner for cost calculation</dd>
<dd><code>mq</code> - Metadata query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cost of this plan (not including children)</dd>
</dl>
</li>
</ul>
<a id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeSelfCost</h4>
<pre class="methodSignature">@Deprecated
<a href="../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;computeSelfCost&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Call <a href="metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(RelNode)</code></a>;
if you wish to override the default cost formula, override the
<a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>computeSelfCost(RelOptPlanner, RelMetadataQuery)</code></a> method.</div>
</div>
</li>
</ul>
<a id="metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metadata</h4>
<pre class="methodSignature">&lt;M extends <a href="metadata/Metadata.html" title="interface in org.apache.calcite.rel.metadata">Metadata</a>&gt;&nbsp;M&nbsp;metadata&#8203;(java.lang.Class&lt;M&gt;&nbsp;metadataClass,
<a href="metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</pre>
<div class="block">Returns a metadata interface.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>M</code> - Type of metadata being requested</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>metadataClass</code> - Metadata interface</dd>
<dd><code>mq</code> - Metadata query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Metadata object that supplies the desired metadata (never null,
although if the information is not present the metadata object may
return null from all methods)</dd>
</dl>
</li>
</ul>
<a id="explain(org.apache.calcite.rel.RelWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explain</h4>
<pre class="methodSignature">void&nbsp;explain&#8203;(<a href="RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a>&nbsp;pw)</pre>
<div class="block">Describes the inputs and attributes of this relational expression.
Each node should call <code>super.explain</code>, then call the
<a href="RelWriter.html#input(java.lang.String,org.apache.calcite.rel.RelNode)"><code>RelWriter.input(String, RelNode)</code></a>
and
<a href="externalize/RelWriterImpl.html#item(java.lang.String,java.lang.Object)"><code>RelWriterImpl.item(String, Object)</code></a>
methods for each input and attribute.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pw</code> - Plan writer</dd>
</dl>
</li>
</ul>
<a id="onRegister(org.apache.calcite.plan.RelOptPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onRegister</h4>
<pre class="methodSignature"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;onRegister&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</pre>
<div class="block">Receives notification that this expression is about to be registered. The
implementation of this method must at least register all child
expressions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planner</code> - Planner that plans this relational node</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Relational expression that should be used by the planner</dd>
</dl>
</li>
</ul>
<a id="recomputeDigest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recomputeDigest</h4>
<pre class="methodSignature">java.lang.String&nbsp;recomputeDigest()</pre>
<div class="block">Computes the digest, assigns it, and returns it. For planner use only.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Digest of this relational expression</dd>
</dl>
</li>
</ul>
<a id="replaceInput(int,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>replaceInput</h4>
<pre class="methodSignature">void&nbsp;replaceInput&#8203;(int&nbsp;ordinalInParent,
<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;p)</pre>
<div class="block">Replaces the <code>ordinalInParent</code><sup>th</sup> input. You must
override this method if you override <a href="#getInputs()"><code>getInputs()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinalInParent</code> - Position of the child input, 0 is the first</dd>
<dd><code>p</code> - New node that should be put at position <code>ordinalInParent</code></dd>
</dl>
</li>
</ul>
<a id="getTable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTable</h4>
<pre class="methodSignature"><a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a>&nbsp;getTable()</pre>
<div class="block">If this relational expression represents an access to a table, returns
that table, otherwise returns null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If this relational expression represents an access to a table,
returns that table, otherwise returns null</dd>
</dl>
</li>
</ul>
<a id="getRelTypeName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelTypeName</h4>
<pre class="methodSignature">java.lang.String&nbsp;getRelTypeName()</pre>
<div class="block">Returns the name of this relational expression's class, sans package
name, for use in explain. For example, for a <code>
org.apache.calcite.rel.ArrayRel.ArrayReader</code>, this method returns
"ArrayReader".</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of this relational expression's class, sans package name,
for use in explain</dd>
</dl>
</li>
</ul>
<a id="isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre class="methodSignature">boolean&nbsp;isValid&#8203;(<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus,
<a href="RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a>&nbsp;context)</pre>
<div class="block">Returns whether this relational expression is valid.
<p>If assertions are enabled, this method is typically called with <code>
litmus</code> = <code>THROW</code>, as follows:
<blockquote>
<pre>assert rel.isValid(Litmus.THROW)</pre>
</blockquote>
<p>This signals that the method can throw an <code>AssertionError</code> if it
is not valid.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>litmus</code> - What to do if invalid</dd>
<dd><code>context</code> - Context for validity checking</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether relational expression is valid</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.AssertionError</code> - if this relational expression is invalid and
litmus is THROW</dd>
</dl>
</li>
</ul>
<a id="isValid(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre class="methodSignature">@Deprecated
boolean&nbsp;isValid&#8203;(boolean&nbsp;fail)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="getCollationList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollationList</h4>
<pre class="methodSignature">@Deprecated
java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;getCollationList()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="metadata/RelMetadataQuery.html#distribution(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.distribution(RelNode)</code></a></div>
</div>
<div class="block">Returns a description of the physical ordering (or orderings) of this
relational expression. Never null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Description of the physical ordering (or orderings) of this
relational expression. Never null</dd>
</dl>
</li>
</ul>
<a id="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre class="methodSignature"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;copy&#8203;(<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;traitSet,
java.util.List&lt;<a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;inputs)</pre>
<div class="block">Creates a copy of this relational expression, perhaps changing traits and
inputs.
<p>Sub-classes with other important attributes are encouraged to create
variants of this method with more parameters.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>traitSet</code> - Trait set</dd>
<dd><code>inputs</code> - Inputs</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Copy of this relational expression, substituting traits and
inputs</dd>
</dl>
</li>
</ul>
<a id="register(org.apache.calcite.plan.RelOptPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">void&nbsp;register&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</pre>
<div class="block">Registers any special rules specific to this kind of relational
expression.
<p>The planner calls this method this first time that it sees a
relational expression of this class. The derived class should call
<a href="../plan/RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)"><code>RelOptPlanner.addRule(org.apache.calcite.plan.RelOptRule)</code></a> for each rule, and
then call <code>super.register</code>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planner</code> - Planner to be used to register additional relational
expressions</dd>
</dl>
</li>
</ul>
<a id="isKey(org.apache.calcite.util.ImmutableBitSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isKey</h4>
<pre class="methodSignature">@Deprecated
boolean&nbsp;isKey&#8203;(<a href="../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&nbsp;columns)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="metadata/RelMetadataQuery.html#areColumnsUnique(org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet)"><code>RelMetadataQuery.areColumnsUnique(RelNode, ImmutableBitSet)</code></a></div>
</div>
<div class="block">Returns whether the result of this relational expression is uniquely
identified by this columns with the given ordinals.
<p>For example, if this relational expression is a LogicalTableScan to
T(A, B, C, D) whose key is (A, B), then isKey([0, 1]) yields true,
and isKey([0]) and isKey([0, 2]) yields false.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columns</code> - Ordinals of key columns</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the given columns are a key or a superset of a key</dd>
</dl>
</li>
</ul>
<a id="accept(org.apache.calcite.rel.RelShuttle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre class="methodSignature"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;accept&#8203;(<a href="RelShuttle.html" title="interface in org.apache.calcite.rel">RelShuttle</a>&nbsp;shuttle)</pre>
<div class="block">Accepts a visit from a shuttle.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shuttle</code> - Shuttle</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A copy of this node incorporating changes made by the shuttle to
this node's children</dd>
</dl>
</li>
</ul>
<a id="accept(org.apache.calcite.rex.RexShuttle)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>accept</h4>
<pre class="methodSignature"><a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;accept&#8203;(<a href="../rex/RexShuttle.html" title="class in org.apache.calcite.rex">RexShuttle</a>&nbsp;shuttle)</pre>
<div class="block">Accepts a visit from a shuttle. If the shuttle updates expression, then
a copy of the relation should be created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shuttle</code> - Shuttle</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A copy of this node incorporating changes made by the shuttle to
this node's children</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RelNode.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>