| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlNode (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, class: SqlNode"> |
| <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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.calcite.sql</a></div> |
| <h1 title="Class SqlNode" class="title">Class SqlNode</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.SqlNode</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code>, <code><a href="SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a></code>, <code><a href="SqlDynamicParam.html" title="class in org.apache.calcite.sql">SqlDynamicParam</a></code>, <code><a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code>, <code><a href="SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></code>, <code><a href="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a></code>, <code><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SqlNode</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></span></div> |
| <div class="block">A <code>SqlNode</code> is a SQL parse tree. |
| |
| <p>It may be a |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>call</code></a>, <a href="SqlLiteral.html" title="class in org.apache.calcite.sql"><code>literal</code></a>, |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>identifier</code></a>, and so forth.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#EMPTY_ARRAY" class="member-name-link">EMPTY_ARRAY</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#pos" class="member-name-link">pos</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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>abstract <R> R</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#accept(org.apache.calcite.sql.util.SqlVisitor)" class="member-name-link">accept</a><wbr>(<a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Accepts a generic visitor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Please use <a href="#clone(E)"><code>clone(SqlNode)</code></a>; this method brings |
| along too much baggage from early versions of Java</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <E extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>><br>E</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#clone(E)" class="member-name-link">clone</a><wbr>(E e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a copy of a SqlNode.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="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="#clone(org.apache.calcite.sql.parser.SqlParserPos)" class="member-name-link">clone</a><wbr>(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Clones a SqlNode with a different position.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="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-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#cloneArray(org.apache.calcite.sql.SqlNode%5B%5D)" class="member-name-link">cloneArray</a><wbr>(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[] nodes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equalDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)" class="member-name-link">equalDeep</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node1, |
| @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node2, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether two nodes are equal (using |
| <a href="#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"><code>equalsDeep(SqlNode, Litmus)</code></a>) or are both null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equalDeep(java.util.List,java.util.List,org.apache.calcite.util.Litmus)" class="member-name-link">equalDeep</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands0, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands1, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether two lists of operands are equal, comparing using |
| <a href="#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"><code>equalsDeep(SqlNode, Litmus)</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>final boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#equalsDeep(org.apache.calcite.sql.SqlNode,boolean)" class="member-name-link">equalsDeep</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean fail)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)" class="member-name-link">equalsDeep</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this node is structurally equivalent to another node.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findValidOptions(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.parser.SqlParserPos,java.util.Collection)" class="member-name-link">findValidOptions</a><wbr>(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="validate/SqlMoniker.html" title="interface in org.apache.calcite.sql.validate">SqlMoniker</a>> hintList)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Lists all the valid alternatives for this node if the parse position of |
| the node matches that of pos.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKind()" class="member-name-link">getKind</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the type of node this is, or |
| <a href="SqlKind.html#OTHER"><code>SqlKind.OTHER</code></a> if it's nothing special.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMonotonicity(org.apache.calcite.sql.validate.SqlValidatorScope)" class="member-name-link">getMonotonicity</a><wbr>(@Nullable <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether expression is always ascending, descending or constant.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParserPosition()" class="member-name-link">getParserPosition</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isA(java.util.Set)" class="member-name-link">isA</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a>> category)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this node is a member of an aggregate category.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>><br><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Collector.html" title="class or interface in java.util.stream" class="external-link">Collector</a><T,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>>,<wbr><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toList()" class="member-name-link">toList</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a <code>Collector</code> that accumulates the input elements into a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>, with zero position.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <T extends @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>><br><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Collector.html" title="class or interface in java.util.stream" class="external-link">Collector</a><T,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>>,<wbr><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toList(org.apache.calcite.sql.parser.SqlParserPos)" class="member-name-link">toList</a><wbr>(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a <code>Collector</code> that accumulates the input elements into a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSqlString(org.apache.calcite.sql.SqlDialect)" class="member-name-link">toSqlString</a><wbr>(@Nullable <a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSqlString(org.apache.calcite.sql.SqlDialect,boolean)" class="member-name-link">toSqlString</a><wbr>(@Nullable <a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean forceParens)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the SQL text of the tree of which this <code>SqlNode</code> is |
| the root.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSqlString(java.util.function.UnaryOperator)" class="member-name-link">toSqlString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a>> transform)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the SQL text of the tree of which this <code>SqlNode</code> is |
| the root.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unparse(org.apache.calcite.sql.SqlWriter,int,int)" class="member-name-link">unparse</a><wbr>(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a SQL representation of this node to a writer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unparseWithParentheses(org.apache.calcite.sql.SqlWriter,int,int,boolean)" class="member-name-link">unparseWithParentheses</a><wbr>(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec, |
| boolean parentheses)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)" class="member-name-link">validate</a><wbr>(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Validates this node.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)" class="member-name-link">validateExpr</a><wbr>(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validates this node in an expression context.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="EMPTY_ARRAY"> |
| <h3>EMPTY_ARRAY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</span> <span class="element-name">EMPTY_ARRAY</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="pos"> |
| <h3>pos</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></span> <span class="element-name">pos</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">clone</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Please use <a href="#clone(E)"><code>clone(SqlNode)</code></a>; this method brings |
| along too much baggage from early versions of Java</div> |
| </div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone(E)"> |
| <h3 id="clone(org.apache.calcite.sql.SqlNode)">clone</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><E extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> <span class="return-type">E</span> <span class="element-name">clone</span><wbr><span class="parameters">(E e)</span></div> |
| <div class="block">Creates a copy of a SqlNode.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone(org.apache.calcite.sql.parser.SqlParserPos)"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">clone</span><wbr><span class="parameters">(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos)</span></div> |
| <div class="block">Clones a SqlNode with a different position.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKind()"> |
| <h3>getKind</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></span> <span class="element-name">getKind</span>()</div> |
| <div class="block">Returns the type of node this is, or |
| <a href="SqlKind.html#OTHER"><code>SqlKind.OTHER</code></a> if it's nothing special.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a <a href="SqlKind.html" title="enum in org.apache.calcite.sql"><code>SqlKind</code></a> value, never null</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#isA(java.util.Set)"><code>isA(java.util.Set<org.apache.calcite.sql.SqlKind>)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isA(java.util.Set)"> |
| <h3>isA</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isA</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a>> category)</span></div> |
| <div class="block">Returns whether this node is a member of an aggregate category. |
| |
| <p>For example, <code>node.isA(SqlKind.QUERY)</code> returns <code>true</code> |
| if the node is a SELECT, INSERT, UPDATE etc. |
| |
| <p>This method is shorthand: <code>node.isA(category)</code> is always |
| equivalent to <code>node.getKind().belongsTo(category)</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>category</code> - Category</dd> |
| <dt>Returns:</dt> |
| <dd>Whether this node belongs to the given category.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cloneArray(org.apache.calcite.sql.SqlNode[])"> |
| <h3>cloneArray</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</span> <span class="element-name">cloneArray</span><wbr><span class="parameters">(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[] nodes)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSqlString(java.util.function.UnaryOperator)"> |
| <h3>toSqlString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="element-name">toSqlString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a><<a href="SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a>> transform)</span></div> |
| <div class="block">Returns the SQL text of the tree of which this <code>SqlNode</code> is |
| the root. |
| |
| <p>Typical return values are: |
| |
| <ul> |
| <li>'It''s a bird!' |
| <li>NULL |
| <li>12.3 |
| <li>DATE '1969-04-29' |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>transform</code> - Transform that sets desired writer configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSqlString(org.apache.calcite.sql.SqlDialect,boolean)"> |
| <h3>toSqlString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="element-name">toSqlString</span><wbr><span class="parameters">(@Nullable <a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean forceParens)</span></div> |
| <div class="block">Returns the SQL text of the tree of which this <code>SqlNode</code> is |
| the root. |
| |
| <p>Typical return values are: |
| |
| <ul> |
| <li>'It''s a bird!' |
| <li>NULL |
| <li>12.3 |
| <li>DATE '1969-04-29' |
| </ul></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dialect</code> - Dialect (null for ANSI SQL)</dd> |
| <dd><code>forceParens</code> - Whether to wrap all expressions in parentheses; |
| useful for parse test, but false by default</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSqlString(org.apache.calcite.sql.SqlDialect)"> |
| <h3>toSqlString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="element-name">toSqlString</span><wbr><span class="parameters">(@Nullable <a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparse(org.apache.calcite.sql.SqlWriter,int,int)"> |
| <h3>unparse</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">unparse</span><wbr><span class="parameters">(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</span></div> |
| <div class="block">Writes a SQL representation of this node to a writer. |
| |
| <p>The <code>leftPrec</code> and <code>rightPrec</code> parameters give |
| us enough context to decide whether we need to enclose the expression in |
| parentheses. For example, we need parentheses around "2 + 3" if preceded |
| by "5 *". This is because the precedence of the "*" operator is greater |
| than the precedence of the "+" operator. |
| |
| <p>The algorithm handles left- and right-associative operators by giving |
| them slightly different left- and right-precedence. |
| |
| <p>If <a href="SqlWriter.html#isAlwaysUseParentheses()"><code>SqlWriter.isAlwaysUseParentheses()</code></a> is true, we use |
| parentheses even when they are not required by the precedence rules. |
| |
| <p>For the details of this algorithm, see <a href="SqlCall.html#unparse(org.apache.calcite.sql.SqlWriter,int,int)"><code>SqlCall.unparse(org.apache.calcite.sql.SqlWriter, int, int)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>writer</code> - Target writer</dd> |
| <dd><code>leftPrec</code> - The precedence of the <a href="SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> immediately |
| preceding this node in a depth-first scan of the parse |
| tree</dd> |
| <dd><code>rightPrec</code> - The precedence of the <a href="SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> immediately</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unparseWithParentheses(org.apache.calcite.sql.SqlWriter,int,int,boolean)"> |
| <h3>unparseWithParentheses</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unparseWithParentheses</span><wbr><span class="parameters">(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec, |
| boolean parentheses)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParserPosition()"> |
| <h3>getParserPosition</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></span> <span class="element-name">getParserPosition</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">validate</span><wbr><span class="parameters">(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</span></div> |
| <div class="block">Validates this node. |
| |
| <p>The typical implementation of this method will make a callback to the |
| validator appropriate to the node type and context. The validator has |
| methods such as <a href="validate/SqlValidator.html#validateLiteral(org.apache.calcite.sql.SqlLiteral)"><code>SqlValidator.validateLiteral(org.apache.calcite.sql.SqlLiteral)</code></a> for these purposes.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scope</code> - Validator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findValidOptions(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.parser.SqlParserPos,java.util.Collection)"> |
| <h3>findValidOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">findValidOptions</span><wbr><span class="parameters">(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="validate/SqlMoniker.html" title="interface in org.apache.calcite.sql.validate">SqlMoniker</a>> hintList)</span></div> |
| <div class="block">Lists all the valid alternatives for this node if the parse position of |
| the node matches that of pos. Only implemented now for SqlCall and |
| SqlOperator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>validator</code> - Validator</dd> |
| <dd><code>scope</code> - Validation scope</dd> |
| <dd><code>pos</code> - SqlParserPos indicating the cursor position at which |
| completion hints are requested for</dd> |
| <dd><code>hintList</code> - list of valid options</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"> |
| <h3>validateExpr</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">validateExpr</span><wbr><span class="parameters">(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</span></div> |
| <div class="block">Validates this node in an expression context. |
| |
| <p>Usually, this method does much the same as <a href="#validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"><code>validate(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope)</code></a>, but a |
| <a href="SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a> can occur in expression and non-expression |
| contexts.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="accept(org.apache.calcite.sql.util.SqlVisitor)"> |
| <h3>accept</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="type-parameters"><R></span> <span class="return-type">R</span> <span class="element-name">accept</span><wbr><span class="parameters">(<a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor)</span></div> |
| <div class="block">Accepts a generic visitor. |
| |
| <p>Implementations of this method in subtypes simply call the appropriate |
| <code>visit</code> method on the |
| <a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util"><code>visitor object</code></a>. |
| |
| <p>The type parameter <code>R</code> must be consistent with the type |
| parameter of the visitor.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"> |
| <h3>equalsDeep</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">equalsDeep</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</span></div> |
| <div class="block">Returns whether this node is structurally equivalent to another node. |
| Some examples: |
| |
| <ul> |
| <li>1 + 2 is structurally equivalent to 1 + 2</li> |
| <li>1 + 2 + 3 is structurally equivalent to (1 + 2) + 3, but not to 1 + |
| (2 + 3), because the '+' operator is left-associative</li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equalsDeep(org.apache.calcite.sql.SqlNode,boolean)"> |
| <h3>equalsDeep</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">equalsDeep</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean fail)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equalDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"> |
| <h3>equalDeep</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">equalDeep</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node1, |
| @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node2, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</span></div> |
| <div class="block">Returns whether two nodes are equal (using |
| <a href="#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"><code>equalsDeep(SqlNode, Litmus)</code></a>) or are both null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>node1</code> - First expression</dd> |
| <dd><code>node2</code> - Second expression</dd> |
| <dd><code>litmus</code> - What to do if an error is detected (expressions are |
| not equal)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonotonicity(org.apache.calcite.sql.validate.SqlValidatorScope)"> |
| <h3>getMonotonicity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="element-name">getMonotonicity</span><wbr><span class="parameters">(@Nullable <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</span></div> |
| <div class="block">Returns whether expression is always ascending, descending or constant. |
| This property is useful because it allows to safely aggregate infinite |
| streams of values. |
| |
| <p>The default implementation returns |
| <a href="validate/SqlMonotonicity.html#NOT_MONOTONIC"><code>SqlMonotonicity.NOT_MONOTONIC</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scope</code> - Scope</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equalDeep(java.util.List,java.util.List,org.apache.calcite.util.Litmus)"> |
| <h3>equalDeep</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">equalDeep</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands0, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands1, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</span></div> |
| <div class="block">Returns whether two lists of operands are equal, comparing using |
| <a href="#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)"><code>equalsDeep(SqlNode, Litmus)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toList()"> |
| <h3>toList</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> |
| <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Collector.html" title="class or interface in java.util.stream" class="external-link">Collector</a><T,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>>,<wbr><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></span> <span class="element-name">toList</span>()</div> |
| <div class="block">Returns a <code>Collector</code> that accumulates the input elements into a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>, with zero position.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - Type of the input elements</dd> |
| <dt>Returns:</dt> |
| <dd>a <code>Collector</code> that collects all the input elements into a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>, in encounter order</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toList(org.apache.calcite.sql.parser.SqlParserPos)"> |
| <h3>toList</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><T extends @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> |
| <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/stream/Collector.html" title="class or interface in java.util.stream" class="external-link">Collector</a><T,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a><@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>>,<wbr><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></span> <span class="element-name">toList</span><wbr><span class="parameters">(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos)</span></div> |
| <div class="block">Returns a <code>Collector</code> that accumulates the input elements into a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - Type of the input elements</dd> |
| <dt>Returns:</dt> |
| <dd>a <code>Collector</code> that collects all the input elements into a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>, in encounter order</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
