Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / sql / util / SqlVisitor.html
blob: a0e9127c3d5f8c52e317b3e3b86ac5059fe6f730 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>SqlVisitor (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.sql.util, interface: SqlVisitor">
<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.sql.util</a></div>
<h1 title="Interface SqlVisitor" class="title">Interface SqlVisitor&lt;R&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>R</code> - Return type</dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="SqlBasicVisitor.html" title="class in org.apache.calcite.sql.util">SqlBasicVisitor</a></code>, <code><a href="../validate/SqlScopedShuttle.html" title="class in org.apache.calcite.sql.validate">SqlScopedShuttle</a></code>, <code><a href="SqlShuttle.html" title="class in org.apache.calcite.sql.util">SqlShuttle</a></code>, <code><a href="../../sql2rel/SqlToRelConverter.AggConverter.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter.AggConverter</a></code>, <code><a href="../../sql2rel/SqlToRelConverter.Blackboard.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter.Blackboard</a></code>, <code><a href="../../sql2rel/SqlToRelConverter.SqlIdentifierFinder.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter.SqlIdentifierFinder</a></code>, <code><a href="../validate/SqlValidatorUtil.DeepCopier.html" title="class in org.apache.calcite.sql.validate">SqlValidatorUtil.DeepCopier</a></code>, <code><a href="../../util/Util.OverFinder.html" title="class in org.apache.calcite.util">Util.OverFinder</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SqlVisitor&lt;R&gt;</span></div>
<div class="block">Visitor class, follows the
<a href="../../util/Glossary.html#VISITOR_PATTERN"><code>visitor pattern</code></a>.
<p>The type parameter <code>R</code> is the return type of each <code>
visit()</code> method. If the methods do not need to return a value, use
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link"><code>Void</code></a>.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="SqlBasicVisitor.html" title="class in org.apache.calcite.sql.util"><code>SqlBasicVisitor</code></a></li>
<li><a href="../SqlNode.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlNode.accept(SqlVisitor)</code></a></li>
<li><a href="../SqlOperator.html#acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall)"><code>SqlOperator.acceptCall(org.apache.calcite.sql.util.SqlVisitor&lt;R&gt;, org.apache.calcite.sql.SqlCall)</code></a></li>
</ul>
</dd>
</dl>
</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><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlCall)" class="member-name-link">visit</a><wbr>(<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</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">Visits a call to a <a href="../SqlOperator.html" title="class in org.apache.calcite.sql"><code>SqlOperator</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlDataTypeSpec)" class="member-name-link">visit</a><wbr>(<a href="../SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Visits a datatype specification.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlDynamicParam)" class="member-name-link">visit</a><wbr>(<a href="../SqlDynamicParam.html" title="class in org.apache.calcite.sql">SqlDynamicParam</a>&nbsp;param)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Visits a dynamic parameter.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlIdentifier)" class="member-name-link">visit</a><wbr>(<a href="../SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a>&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Visits an identifier.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlIntervalQualifier)" class="member-name-link">visit</a><wbr>(<a href="../SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a>&nbsp;intervalQualifier)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Visits an interval qualifier.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlLiteral)" class="member-name-link">visit</a><wbr>(<a href="../SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a>&nbsp;literal)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Visits a literal.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#visit(org.apache.calcite.sql.SqlNodeList)" class="member-name-link">visit</a><wbr>(<a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>&nbsp;nodeList)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Visits a list of <a href="../SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> objects.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#visitNode(org.apache.calcite.sql.SqlNode)" class="member-name-link">visitNode</a><wbr>(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;n)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Asks a <code>SqlNode</code> to accept this visitor.</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="visit(org.apache.calcite.sql.SqlLiteral)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a>&nbsp;literal)</span></div>
<div class="block">Visits a literal.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>literal</code> - Literal</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../SqlLiteral.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlLiteral.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.sql.SqlCall)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;call)</span></div>
<div class="block">Visits a call to a <a href="../SqlOperator.html" title="class in org.apache.calcite.sql"><code>SqlOperator</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>call</code> - Call</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../SqlCall.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlCall.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.sql.SqlNodeList)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>&nbsp;nodeList)</span></div>
<div class="block">Visits a list of <a href="../SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> objects.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>nodeList</code> - list of nodes</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../SqlNodeList.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlNodeList.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.sql.SqlIdentifier)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a>&nbsp;id)</span></div>
<div class="block">Visits an identifier.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - identifier</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../SqlIdentifier.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlIdentifier.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.sql.SqlDataTypeSpec)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a>&nbsp;type)</span></div>
<div class="block">Visits a datatype specification.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - datatype specification</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../SqlDataTypeSpec.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlDataTypeSpec.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.sql.SqlDynamicParam)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlDynamicParam.html" title="class in org.apache.calcite.sql">SqlDynamicParam</a>&nbsp;param)</span></div>
<div class="block">Visits a dynamic parameter.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>param</code> - Dynamic parameter</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../SqlDynamicParam.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlDynamicParam.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visit(org.apache.calcite.sql.SqlIntervalQualifier)">
<h3>visit</h3>
<div class="member-signature"><span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visit</span><wbr><span class="parameters">(<a href="../SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a>&nbsp;intervalQualifier)</span></div>
<div class="block">Visits an interval qualifier.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>intervalQualifier</code> - Interval qualifier</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../SqlIntervalQualifier.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlIntervalQualifier.accept(SqlVisitor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visitNode(org.apache.calcite.sql.SqlNode)">
<h3>visitNode</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="SqlVisitor.html" title="type parameter in SqlVisitor">R</a></span>&nbsp;<span class="element-name">visitNode</span><wbr><span class="parameters">(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;n)</span></div>
<div class="block">Asks a <code>SqlNode</code> to accept this visitor.</div>
</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>