blob: ecb4ae792aa92a6f8f852902d2b4eff4effb5971 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RexToSqlNodeConverter (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.rex, interface: RexToSqlNodeConverter">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rex</a></div>
<h1 title="Interface RexToSqlNodeConverter" class="title">Interface RexToSqlNodeConverter</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="RexToSqlNodeConverterImpl.html" title="class in org.apache.calcite.rex">RexToSqlNodeConverterImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RexToSqlNodeConverter</span></div>
<div class="block">Converts expressions from <a href="RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> to <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a>.
<p>For most purposes, <a href="../rel/rel2sql/SqlImplementor.html" title="class in org.apache.calcite.rel.rel2sql"><code>SqlImplementor</code></a>
is superior. See in particular
<a href="../rel/rel2sql/SqlImplementor.Context.html#toSql(org.apache.calcite.rex.RexProgram,org.apache.calcite.rex.RexNode)"><code>SqlImplementor.Context.toSql(RexProgram, RexNode)</code></a>.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convertCall(org.apache.calcite.rex.RexCall)" class="member-name-link">convertCall</a><wbr>(<a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts a <a href="RexCall.html" title="class in org.apache.calcite.rex"><code>RexCall</code></a> to a <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> expression.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convertInputRef(org.apache.calcite.rex.RexInputRef)" class="member-name-link">convertInputRef</a><wbr>(<a href="RexInputRef.html" title="class in org.apache.calcite.rex">RexInputRef</a>&nbsp;ref)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts a <a href="RexInputRef.html" title="class in org.apache.calcite.rex"><code>RexInputRef</code></a> to a <a href="../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convertLiteral(org.apache.calcite.rex.RexLiteral)" class="member-name-link">convertLiteral</a><wbr>(<a href="RexLiteral.html" title="class in org.apache.calcite.rex">RexLiteral</a>&nbsp;literal)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts a <a href="RexLiteral.html" title="class in org.apache.calcite.rex"><code>RexLiteral</code></a> to a <a href="../sql/SqlLiteral.html" title="class in org.apache.calcite.sql"><code>SqlLiteral</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convertNode(org.apache.calcite.rex.RexNode)" class="member-name-link">convertNode</a><wbr>(<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Converts a <a href="RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> to a <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> expression,
typically by dispatching to one of the other interface methods.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="convertNode(org.apache.calcite.rex.RexNode)">
<h3>convertNode</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span>&nbsp;<span class="element-name">convertNode</span><wbr><span class="parameters">(<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node)</span></div>
<div class="block">Converts a <a href="RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> to a <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> expression,
typically by dispatching to one of the other interface methods.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>node</code> - RexNode to translate</dd>
<dt>Returns:</dt>
<dd>SqlNode, or null if no translation was available</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="convertCall(org.apache.calcite.rex.RexCall)">
<h3>convertCall</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span>&nbsp;<span class="element-name">convertCall</span><wbr><span class="parameters">(<a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</span></div>
<div class="block">Converts a <a href="RexCall.html" title="class in org.apache.calcite.rex"><code>RexCall</code></a> to a <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> expression.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>call</code> - RexCall to translate</dd>
<dt>Returns:</dt>
<dd>SqlNode, or null if no translation was available</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="convertLiteral(org.apache.calcite.rex.RexLiteral)">
<h3>convertLiteral</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span>&nbsp;<span class="element-name">convertLiteral</span><wbr><span class="parameters">(<a href="RexLiteral.html" title="class in org.apache.calcite.rex">RexLiteral</a>&nbsp;literal)</span></div>
<div class="block">Converts a <a href="RexLiteral.html" title="class in org.apache.calcite.rex"><code>RexLiteral</code></a> to a <a href="../sql/SqlLiteral.html" title="class in org.apache.calcite.sql"><code>SqlLiteral</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>literal</code> - RexLiteral to translate</dd>
<dt>Returns:</dt>
<dd>SqlNode, or null if no translation was available</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="convertInputRef(org.apache.calcite.rex.RexInputRef)">
<h3>convertInputRef</h3>
<div class="member-signature"><span class="return-type">@Nullable <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span>&nbsp;<span class="element-name">convertInputRef</span><wbr><span class="parameters">(<a href="RexInputRef.html" title="class in org.apache.calcite.rex">RexInputRef</a>&nbsp;ref)</span></div>
<div class="block">Converts a <a href="RexInputRef.html" title="class in org.apache.calcite.rex"><code>RexInputRef</code></a> to a <a href="../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ref</code> - RexInputRef to translate</dd>
<dt>Returns:</dt>
<dd>SqlNode, or null if no translation was available</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>