| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SqlNode (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":42,"i2":9,"i3":6,"i4":41,"i5":9,"i6":9,"i7":42,"i8":6,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":10,"i17":10,"i18":10,"i19":10,"i20":6,"i21":10,"i22":6,"i23":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">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="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.SqlNode</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code></dd> |
| </dl> |
| <dl> |
| <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> |
| <pre>public abstract class <span class="typeNameLabel">SqlNode</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></pre> |
| <div class="block">A <code>SqlNode</code> is a SQL parse tree. |
| |
| <p>It may be an |
| <a href="SqlOperator.html" title="class in org.apache.calcite.sql"><code>operator</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="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMPTY_ARRAY">EMPTY_ARRAY</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pos">pos</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>abstract <R> R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.apache.calcite.sql.util.SqlVisitor)">accept</a></span>​(<a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor)</code></th> |
| <td class="colLast"> |
| <div class="block">Accepts a generic visitor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">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> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>static <E extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>><br>E</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone(E)">clone</a></span>​(E e)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a copy of a SqlNode.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>abstract <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone(org.apache.calcite.sql.parser.SqlParserPos)">clone</a></span>​(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos)</code></th> |
| <td class="colLast"> |
| <div class="block">Clones a SqlNode with a different position.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>static <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cloneArray(org.apache.calcite.sql.SqlNode%5B%5D)">cloneArray</a></span>​(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[] nodes)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equalDeep(java.util.List,java.util.List,org.apache.calcite.util.Litmus)">equalDeep</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands0, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<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></th> |
| <td class="colLast"> |
| <div class="block">Returns whether two lists of operands are equal.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equalDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)">equalDeep</a></span>​(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node1, |
| <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></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equalsDeep(org.apache.calcite.sql.SqlNode,boolean)">equalsDeep</a></span>​(<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean fail)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)">equalsDeep</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this node is structurally equivalent to another node.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findValidOptions(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.parser.SqlParserPos,java.util.Collection)">findValidOptions</a></span>​(<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/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="validate/SqlMoniker.html" title="interface in org.apache.calcite.sql.validate">SqlMoniker</a>> hintList)</code></th> |
| <td class="colLast"> |
| <div class="block">Lists all the valid alternatives for this node if the parse position of |
| the node matches that of pos.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKind()">getKind</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code><a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMonotonicity(org.apache.calcite.sql.validate.SqlValidatorScope)">getMonotonicity</a></span>​(<a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether expression is always ascending, descending or constant.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParserPosition()">getParserPosition</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isA(java.util.Set)">isA</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a>> category)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this node is a member of an aggregate category.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>static <T extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>><br><a href="https://docs.oracle.com/javase/9/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><T,​<a href="https://docs.oracle.com/javase/9/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a><T>,​<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toList()">toList</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>static <T extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>><br><a href="https://docs.oracle.com/javase/9/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><T,​<a href="https://docs.oracle.com/javase/9/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a><T>,​<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toList(org.apache.calcite.sql.parser.SqlParserPos)">toList</a></span>​(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSqlString(java.util.function.UnaryOperator)">toSqlString</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/UnaryOperator.html?is-external=true" title="class or interface in java.util.function" class="externalLink">UnaryOperator</a><<a href="SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a>> transform)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the SQL text of the tree of which this <code>SqlNode</code> is |
| the root.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSqlString(org.apache.calcite.sql.SqlDialect)">toSqlString</a></span>​(<a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSqlString(org.apache.calcite.sql.SqlDialect,boolean)">toSqlString</a></span>​(<a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean forceParens)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the SQL text of the tree of which this <code>SqlNode</code> is |
| the root.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unparse(org.apache.calcite.sql.SqlWriter,int,int)">unparse</a></span>​(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a SQL representation of this node to a writer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unparseWithParentheses(org.apache.calcite.sql.SqlWriter,int,int,boolean)">unparseWithParentheses</a></span>​(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| int leftPrec, |
| int rightPrec, |
| boolean parentheses)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">validate</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Validates this node.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">validateExpr</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Validates this node in an expression context.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="EMPTY_ARRAY">EMPTY_ARRAY</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</span> <span class="memberName">EMPTY_ARRAY</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="pos">pos</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType"><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></span> <span class="memberName">pos</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clone()">clone</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></span> <span class="memberName">clone</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">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> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clone(org.apache.calcite.sql.SqlNode)"> |
| <!-- --> |
| </a><a id="clone(E)">clone</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><E extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> <span class="returnType">E</span> <span class="memberName">clone</span>​(<span class="arguments">E e)</span></div> |
| <div class="block">Creates a copy of a SqlNode.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clone(org.apache.calcite.sql.parser.SqlParserPos)">clone</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="memberName">clone</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="getKind()">getKind</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a> |
| </span><span class="modifiers">public</span> <span class="returnType"><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></span> <span class="memberName">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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="SqlKind.html" title="enum in org.apache.calcite.sql"><code>SqlKind</code></a> value, never null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isA(java.util.Set)"><code>isA(java.util.Set<org.apache.calcite.sql.SqlKind>)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isA(java.util.Set)">isA</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType">boolean</span> <span class="memberName">isA</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>category</code> - Category</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether this node belongs to the given category.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cloneArray(org.apache.calcite.sql.SqlNode[])">cloneArray</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[]</span> <span class="memberName">cloneArray</span>​(<span class="arguments"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>[] nodes)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSqlString(java.util.function.UnaryOperator)">toSqlString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="memberName">toSqlString</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/UnaryOperator.html?is-external=true" title="class or interface in java.util.function" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>transform</code> - Transform that sets desired writer configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSqlString(org.apache.calcite.sql.SqlDialect,boolean)">toSqlString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="memberName">toSqlString</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSqlString(org.apache.calcite.sql.SqlDialect)">toSqlString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="memberName">toSqlString</span>​(<span class="arguments"><a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="unparse(org.apache.calcite.sql.SqlWriter,int,int)">unparse</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType">void</span> <span class="memberName">unparse</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="unparseWithParentheses(org.apache.calcite.sql.SqlWriter,int,int,boolean)">unparseWithParentheses</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">unparseWithParentheses</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="getParserPosition()">getParserPosition</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a></span> <span class="memberName">getParserPosition</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">validate</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType">void</span> <span class="memberName">validate</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - Validator</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="findValidOptions(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.parser.SqlParserPos,java.util.Collection)">findValidOptions</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">findValidOptions</span>​(<span class="arguments"><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/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)">validateExpr</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">validateExpr</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="accept(org.apache.calcite.sql.util.SqlVisitor)">accept</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="typeParameters"><R></span> <span class="returnType">R</span> <span class="memberName">accept</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="equalsDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)">equalsDeep</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType">boolean</span> <span class="memberName">equalsDeep</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="equalsDeep(org.apache.calcite.sql.SqlNode,boolean)">equalsDeep</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public final</span> <span class="returnType">boolean</span> <span class="memberName">equalsDeep</span>​(<span class="arguments"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| boolean fail)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equalDeep(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode,org.apache.calcite.util.Litmus)">equalDeep</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">equalDeep</span>​(<span class="arguments"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node1, |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="getMonotonicity(org.apache.calcite.sql.validate.SqlValidatorScope)">getMonotonicity</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="memberName">getMonotonicity</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - Scope</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equalDeep(java.util.List,java.util.List,org.apache.calcite.util.Litmus)">equalDeep</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">equalDeep</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operands0, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<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.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toList()">toList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> |
| <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><T,​<a href="https://docs.oracle.com/javase/9/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a><T>,​<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></span> <span class="memberName">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> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the input elements</dd> |
| <dt><span class="returnLabel">Returns:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="toList(org.apache.calcite.sql.parser.SqlParserPos)">toList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> |
| <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><T,​<a href="https://docs.oracle.com/javase/9/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink">ArrayList</a><T>,​<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a>></span> <span class="memberName">toList</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the input elements</dd> |
| <dt><span class="returnLabel">Returns:</span></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> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
