blob: ac30c65ee883df45fd66a56a14cdec83d2940fcb [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>PlannerImpl (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="PlannerImpl (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/PlannerImpl.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.prepare</a></div>
<h2 title="Class PlannerImpl" class="title">Class PlannerImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.prepare.PlannerImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.AutoCloseable</code>, <code><a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></code>, <code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PlannerImpl</span>
extends java.lang.Object
implements <a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a>, <a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></pre>
<div class="block">Implementation of <a href="../tools/Planner.html" title="interface in org.apache.calcite.tools"><code>Planner</code></a>.</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">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PlannerImpl.State.html" title="enum in org.apache.calcite.prepare">PlannerImpl.State</a></span></code></th>
<td class="colLast">
<div class="block">Stage of a statement in the query-preparation lifecycle.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PlannerImpl.ViewExpanderImpl.html" title="class in org.apache.calcite.prepare">PlannerImpl.ViewExpanderImpl</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Now <a href="PlannerImpl.html" title="class in org.apache.calcite.prepare"><code>PlannerImpl</code></a> implements <a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan"><code>RelOptTable.ViewExpander</code></a>
directly.</div>
</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectionConfig">connectionConfig</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#context">context</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertletTable">convertletTable</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#defaultSchema">defaultSchema</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executor">executor</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#frameworkConfig">frameworkConfig</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#open">open</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operatorTable">operatorTable</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parserConfig">parserConfig</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#planner">planner</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private com.google.common.collect.ImmutableList&lt;<a href="../tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#programs">programs</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#root">root</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sqlToRelConverterConfig">sqlToRelConverterConfig</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="PlannerImpl.State.html" title="enum in org.apache.calcite.prepare">PlannerImpl.State</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#state">state</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private com.google.common.collect.ImmutableList&lt;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#traitDefs">traitDefs</a></span></code></th>
<td class="colLast">
<div class="block">Holds the trait definitions to be registered with planner.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java">JavaTypeFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#typeFactory">typeFactory</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validatedSqlNode">validatedSqlNode</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validator">validator</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.tools.FrameworkConfig)">PlannerImpl</a></span>&#8203;(<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Creates a planner.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Releases all internal resources utilized while this <code>Planner</code>
exists.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>private <a href="../sql/validate/SqlConformance.html" title="interface in org.apache.calcite.sql.validate">SqlConformance</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conformance()">conformance</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>private <a href="../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connConfig()">connConfig</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convert(org.apache.calcite.sql.SqlNode)">convert</a></span>&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sql)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>private <a href="CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">CalciteCatalogReader</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCatalogReader()">createCatalogReader</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>private <a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRexBuilder()">createRexBuilder</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ensure(org.apache.calcite.prepare.PlannerImpl.State)">ensure</a></span>&#8203;(<a href="PlannerImpl.State.html" title="enum in org.apache.calcite.prepare">PlannerImpl.State</a>&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Makes sure that the state is at least the given state.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">expandView</a></span>&#8203;(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType,
java.lang.String&nbsp;queryString,
java.util.List&lt;java.lang.String&gt;&nbsp;schemaPath,
java.util.List&lt;java.lang.String&gt;&nbsp;viewPath)</code></th>
<td class="colLast">
<div class="block">Returns a relational expression that is to be substituted for an access
to a SQL view.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEmptyTraitSet()">getEmptyTraitSet</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java">JavaTypeFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeFactory()">getTypeFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the type factory.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parse(java.io.Reader)">parse</a></span>&#8203;(java.io.Reader&nbsp;reader)</code></th>
<td class="colLast">
<div class="block">Parses and validates a SQL statement.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ready()">ready</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rel(org.apache.calcite.sql.SqlNode)">rel</a></span>&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sql)</code></th>
<td class="colLast">
<div class="block">Converts a SQL parse tree into a tree of relational expressions.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
<td class="colLast">
<div class="block">Resets this <code>Planner</code> to be used with a new query.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>private static <a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rootSchema(org.apache.calcite.schema.SchemaPlus)">rootSchema</a></span>&#8203;(<a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;schema)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)">transform</a></span>&#8203;(int&nbsp;ruleSetIndex,
<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;requiredOutputTraits,
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
<td class="colLast">
<div class="block">Converts one relational expression tree into another relational expression
based on a particular rule set and requires set of traits.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(org.apache.calcite.sql.SqlNode)">validate</a></span>&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sqlNode)</code></th>
<td class="colLast">
<div class="block">Validates a SQL statement.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,&#8203;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateAndGetType(org.apache.calcite.sql.SqlNode)">validateAndGetType</a></span>&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sqlNode)</code></th>
<td class="colLast">
<div class="block">Validates a SQL statement.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.tools.Planner">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.tools.<a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></h3>
<code><a href="../tools/Planner.html#parse(java.lang.String)">parse</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="operatorTable">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operatorTable</h4>
<pre>private final&nbsp;<a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> operatorTable</pre>
</li>
</ul>
<a id="programs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>programs</h4>
<pre>private final&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../tools/Program.html" title="interface in org.apache.calcite.tools">Program</a>&gt; programs</pre>
</li>
</ul>
<a id="frameworkConfig">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>frameworkConfig</h4>
<pre>private final&nbsp;<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a> frameworkConfig</pre>
</li>
</ul>
<a id="context">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>context</h4>
<pre>private final&nbsp;<a href="../plan/Context.html" title="interface in org.apache.calcite.plan">Context</a> context</pre>
</li>
</ul>
<a id="connectionConfig">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionConfig</h4>
<pre>private final&nbsp;<a href="../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a> connectionConfig</pre>
</li>
</ul>
<a id="traitDefs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>traitDefs</h4>
<pre>private final&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&gt; traitDefs</pre>
<div class="block">Holds the trait definitions to be registered with planner. May be null.</div>
</li>
</ul>
<a id="parserConfig">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parserConfig</h4>
<pre>private final&nbsp;<a href="../sql/parser/SqlParser.Config.html" title="interface in org.apache.calcite.sql.parser">SqlParser.Config</a> parserConfig</pre>
</li>
</ul>
<a id="sqlToRelConverterConfig">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sqlToRelConverterConfig</h4>
<pre>private final&nbsp;<a href="../sql2rel/SqlToRelConverter.Config.html" title="interface in org.apache.calcite.sql2rel">SqlToRelConverter.Config</a> sqlToRelConverterConfig</pre>
</li>
</ul>
<a id="convertletTable">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convertletTable</h4>
<pre>private final&nbsp;<a href="../sql2rel/SqlRexConvertletTable.html" title="interface in org.apache.calcite.sql2rel">SqlRexConvertletTable</a> convertletTable</pre>
</li>
</ul>
<a id="state">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>private&nbsp;<a href="PlannerImpl.State.html" title="enum in org.apache.calcite.prepare">PlannerImpl.State</a> state</pre>
</li>
</ul>
<a id="open">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>private&nbsp;boolean open</pre>
</li>
</ul>
<a id="defaultSchema">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultSchema</h4>
<pre>private&nbsp;<a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a> defaultSchema</pre>
</li>
</ul>
<a id="typeFactory">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typeFactory</h4>
<pre>private&nbsp;<a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java">JavaTypeFactory</a> typeFactory</pre>
</li>
</ul>
<a id="planner">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>planner</h4>
<pre>private&nbsp;<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner</pre>
</li>
</ul>
<a id="executor">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executor</h4>
<pre>private&nbsp;<a href="../rex/RexExecutor.html" title="interface in org.apache.calcite.rex">RexExecutor</a> executor</pre>
</li>
</ul>
<a id="validator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validator</h4>
<pre>private&nbsp;<a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator</pre>
</li>
</ul>
<a id="validatedSqlNode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validatedSqlNode</h4>
<pre>private&nbsp;<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> validatedSqlNode</pre>
</li>
</ul>
<a id="root">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>root</h4>
<pre>private&nbsp;<a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a> root</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.calcite.tools.FrameworkConfig)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlannerImpl</h4>
<pre>public&nbsp;PlannerImpl&#8203;(<a href="../tools/FrameworkConfig.html" title="interface in org.apache.calcite.tools">FrameworkConfig</a>&nbsp;config)</pre>
<div class="block">Creates a planner. Not a public API; call
<a href="../tools/Frameworks.html#getPlanner(org.apache.calcite.tools.FrameworkConfig)"><code>Frameworks.getPlanner(org.apache.calcite.tools.FrameworkConfig)</code></a> instead.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="connConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connConfig</h4>
<pre class="methodSignature">private&nbsp;<a href="../config/CalciteConnectionConfig.html" title="interface in org.apache.calcite.config">CalciteConnectionConfig</a>&nbsp;connConfig()</pre>
</li>
</ul>
<a id="ensure(org.apache.calcite.prepare.PlannerImpl.State)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ensure</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;ensure&#8203;(<a href="PlannerImpl.State.html" title="enum in org.apache.calcite.prepare">PlannerImpl.State</a>&nbsp;state)</pre>
<div class="block">Makes sure that the state is at least the given state.</div>
</li>
</ul>
<a id="getEmptyTraitSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEmptyTraitSet</h4>
<pre class="methodSignature">public&nbsp;<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;getEmptyTraitSet()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#getEmptyTraitSet()">getEmptyTraitSet</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#close()">Planner</a></code></span></div>
<div class="block">Releases all internal resources utilized while this <code>Planner</code>
exists. Once called, this Planner object is no longer valid.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
</dl>
</li>
</ul>
<a id="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;reset()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#reset()">Planner</a></code></span></div>
<div class="block">Resets this <code>Planner</code> to be used with a new query. This
should be called between each new query.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#reset()">reset</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
</dl>
</li>
</ul>
<a id="ready()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ready</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;ready()</pre>
</li>
</ul>
<a id="parse(java.io.Reader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parse</h4>
<pre class="methodSignature">public&nbsp;<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;parse&#8203;(java.io.Reader&nbsp;reader)
throws <a href="../sql/parser/SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#parse(java.io.Reader)">Planner</a></code></span></div>
<div class="block">Parses and validates a SQL statement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#parse(java.io.Reader)">parse</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reader</code> - A reader which will provide the SQL statement to parse.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The root node of the SQL parse tree.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../sql/parser/SqlParseException.html" title="class in org.apache.calcite.sql.parser">SqlParseException</a></code> - on parse error</dd>
</dl>
</li>
</ul>
<a id="validate(org.apache.calcite.sql.SqlNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validate</h4>
<pre class="methodSignature">public&nbsp;<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;validate&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sqlNode)
throws <a href="../tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#validate(org.apache.calcite.sql.SqlNode)">Planner</a></code></span></div>
<div class="block">Validates a SQL statement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#validate(org.apache.calcite.sql.SqlNode)">validate</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sqlNode</code> - Root node of the SQL parse tree.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Validated node</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></code> - if not valid</dd>
</dl>
</li>
</ul>
<a id="conformance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conformance</h4>
<pre class="methodSignature">private&nbsp;<a href="../sql/validate/SqlConformance.html" title="interface in org.apache.calcite.sql.validate">SqlConformance</a>&nbsp;conformance()</pre>
</li>
</ul>
<a id="validateAndGetType(org.apache.calcite.sql.SqlNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateAndGetType</h4>
<pre class="methodSignature">public&nbsp;<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,&#8203;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;validateAndGetType&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sqlNode)
throws <a href="../tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#validateAndGetType(org.apache.calcite.sql.SqlNode)">Planner</a></code></span></div>
<div class="block">Validates a SQL statement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#validateAndGetType(org.apache.calcite.sql.SqlNode)">validateAndGetType</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sqlNode</code> - Root node of the SQL parse tree.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Validated node and its validated type.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../tools/ValidationException.html" title="class in org.apache.calcite.tools">ValidationException</a></code> - if not valid</dd>
</dl>
</li>
</ul>
<a id="convert(org.apache.calcite.sql.SqlNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public final&nbsp;<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;convert&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sql)
throws <a href="../tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#convert(org.apache.calcite.sql.SqlNode)">convert</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></code></dd>
</dl>
</li>
</ul>
<a id="rel(org.apache.calcite.sql.SqlNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rel</h4>
<pre class="methodSignature">public&nbsp;<a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a>&nbsp;rel&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;sql)
throws <a href="../tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#rel(org.apache.calcite.sql.SqlNode)">Planner</a></code></span></div>
<div class="block">Converts a SQL parse tree into a tree of relational expressions.
<p>You must call <a href="../tools/Planner.html#validate(org.apache.calcite.sql.SqlNode)"><code>Planner.validate(org.apache.calcite.sql.SqlNode)</code></a> first.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#rel(org.apache.calcite.sql.SqlNode)">rel</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sql</code> - The root node of the SQL parse tree.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The root node of the newly generated RelNode tree.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></code> - if the node
cannot be converted or has not been validated</dd>
</dl>
</li>
</ul>
<a id="expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expandView</h4>
<pre class="methodSignature">public&nbsp;<a href="../rel/RelRoot.html" title="class in org.apache.calcite.rel">RelRoot</a>&nbsp;expandView&#8203;(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType,
java.lang.String&nbsp;queryString,
java.util.List&lt;java.lang.String&gt;&nbsp;schemaPath,
java.util.List&lt;java.lang.String&gt;&nbsp;viewPath)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelOptTable.ViewExpander.html#expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">RelOptTable.ViewExpander</a></code></span></div>
<div class="block">Returns a relational expression that is to be substituted for an access
to a SQL view.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelOptTable.ViewExpander.html#expandView(org.apache.calcite.rel.type.RelDataType,java.lang.String,java.util.List,java.util.List)">expandView</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelOptTable.ViewExpander.html" title="interface in org.apache.calcite.plan">RelOptTable.ViewExpander</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowType</code> - Row type of the view</dd>
<dd><code>queryString</code> - Body of the view</dd>
<dd><code>schemaPath</code> - Path of a schema wherein to find referenced tables</dd>
<dd><code>viewPath</code> - Path of the view, ending with its name; may be null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Relational expression</dd>
</dl>
</li>
</ul>
<a id="createCatalogReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCatalogReader</h4>
<pre class="methodSignature">private&nbsp;<a href="CalciteCatalogReader.html" title="class in org.apache.calcite.prepare">CalciteCatalogReader</a>&nbsp;createCatalogReader()</pre>
</li>
</ul>
<a id="rootSchema(org.apache.calcite.schema.SchemaPlus)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rootSchema</h4>
<pre class="methodSignature">private static&nbsp;<a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;rootSchema&#8203;(<a href="../schema/SchemaPlus.html" title="interface in org.apache.calcite.schema">SchemaPlus</a>&nbsp;schema)</pre>
</li>
</ul>
<a id="createRexBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createRexBuilder</h4>
<pre class="methodSignature">private&nbsp;<a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;createRexBuilder()</pre>
</li>
</ul>
<a id="getTypeFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java">JavaTypeFactory</a>&nbsp;getTypeFactory()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#getTypeFactory()">Planner</a></code></span></div>
<div class="block">Returns the type factory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#getTypeFactory()">getTypeFactory</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
</dl>
</li>
</ul>
<a id="transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transform</h4>
<pre class="methodSignature">public&nbsp;<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;transform&#8203;(int&nbsp;ruleSetIndex,
<a href="../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;requiredOutputTraits,
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)
throws <a href="../tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../tools/Planner.html#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)">Planner</a></code></span></div>
<div class="block">Converts one relational expression tree into another relational expression
based on a particular rule set and requires set of traits.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../tools/Planner.html#transform(int,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode)">transform</a></code>&nbsp;in interface&nbsp;<code><a href="../tools/Planner.html" title="interface in org.apache.calcite.tools">Planner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ruleSetIndex</code> - The RuleSet to use for conversion purposes. Note that
this is zero-indexed and is based on the list and order
of RuleSets provided in the construction of this
Planner.</dd>
<dd><code>requiredOutputTraits</code> - The set of RelTraits required of the root node
at the termination of the planning cycle.</dd>
<dd><code>rel</code> - The root of the RelNode tree to convert.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The root of the new RelNode tree.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../tools/RelConversionException.html" title="class in org.apache.calcite.tools">RelConversionException</a></code> - on conversion
error</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/PlannerImpl.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>