| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AggFinder (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AggFinder (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AggFinder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.sql.validate</a></div> |
| <h2 title="Class AggFinder" class="title">Class AggFinder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../util/SqlBasicVisitor.html" title="class in org.apache.calcite.sql.util">org.apache.calcite.sql.util.SqlBasicVisitor</a><java.lang.Void></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="AggVisitor.html" title="class in org.apache.calcite.sql.validate">org.apache.calcite.sql.validate.AggVisitor</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.sql.validate.AggFinder</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><java.lang.Void></code></dd> |
| </dl> |
| <hr> |
| <pre>class <span class="typeNameLabel">AggFinder</span> |
| extends <a href="AggVisitor.html" title="class in org.apache.calcite.sql.validate">AggVisitor</a></pre> |
| <div class="block">Visitor that looks for an aggregate function inside a tree of |
| <a href="../SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> objects and throws <a href="../../util/Util.FoundOne.html" title="class in org.apache.calcite.util"><code>Util.FoundOne</code></a> when it finds |
| one.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>(package private) static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AggFinder.AggIterable.html" title="class in org.apache.calcite.sql.validate">AggFinder.AggIterable</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Iterates over all aggregates.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.sql.util.SqlBasicVisitor"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.calcite.sql.util.<a href="../util/SqlBasicVisitor.html" title="class in org.apache.calcite.sql.util">SqlBasicVisitor</a></h3> |
| <code><a href="../util/SqlBasicVisitor.ArgHandler.html" title="interface in org.apache.calcite.sql.util">SqlBasicVisitor.ArgHandler</a><<a href="../util/SqlBasicVisitor.ArgHandler.html" title="type parameter in SqlBasicVisitor.ArgHandler">R</a>>, <a href="../util/SqlBasicVisitor.ArgHandlerImpl.html" title="class in org.apache.calcite.sql.util">SqlBasicVisitor.ArgHandlerImpl</a><<a href="../util/SqlBasicVisitor.ArgHandlerImpl.html" title="type parameter in SqlBasicVisitor.ArgHandlerImpl">R</a>></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.sql.validate.AggVisitor"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.calcite.sql.validate.<a href="AggVisitor.html" title="class in org.apache.calcite.sql.validate">AggVisitor</a></h3> |
| <code><a href="AggVisitor.html#aggregate">aggregate</a>, <a href="AggVisitor.html#delegate">delegate</a>, <a href="AggVisitor.html#group">group</a>, <a href="AggVisitor.html#nameMatcher">nameMatcher</a>, <a href="AggVisitor.html#opTab">opTab</a>, <a href="AggVisitor.html#over">over</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlOperatorTable,boolean,boolean,boolean,org.apache.calcite.sql.validate.AggFinder,org.apache.calcite.sql.validate.SqlNameMatcher)">AggFinder</a></span>​(<a href="../SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| boolean over, |
| boolean aggregate, |
| boolean group, |
| <a href="AggFinder.html" title="class in org.apache.calcite.sql.validate">AggFinder</a> delegate, |
| <a href="SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an AggFinder.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findAgg(java.util.List)">findAgg</a></span>​(java.util.List<<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> nodes)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findAgg(org.apache.calcite.sql.SqlNode)">findAgg</a></span>​(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></th> |
| <td class="colLast"> |
| <div class="block">Finds an aggregate.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>(package private) java.lang.Iterable<<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findAll(java.lang.Iterable)">findAll</a></span>​(java.lang.Iterable<<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> nodes)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a copy of this finder that has the same parameters as this, |
| then returns the list of all aggregates found.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected java.lang.Void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#found(org.apache.calcite.sql.SqlCall)">found</a></span>​(<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.sql.validate.AggVisitor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.calcite.sql.validate.<a href="AggVisitor.html" title="class in org.apache.calcite.sql.validate">AggVisitor</a></h3> |
| <code><a href="AggVisitor.html#visit(org.apache.calcite.sql.SqlCall)">visit</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.sql.util.SqlBasicVisitor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.calcite.sql.util.<a href="../util/SqlBasicVisitor.html" title="class in org.apache.calcite.sql.util">SqlBasicVisitor</a></h3> |
| <code><a href="../util/SqlBasicVisitor.html#visit(org.apache.calcite.sql.SqlDataTypeSpec)">visit</a>, <a href="../util/SqlBasicVisitor.html#visit(org.apache.calcite.sql.SqlDynamicParam)">visit</a>, <a href="../util/SqlBasicVisitor.html#visit(org.apache.calcite.sql.SqlIdentifier)">visit</a>, <a href="../util/SqlBasicVisitor.html#visit(org.apache.calcite.sql.SqlIntervalQualifier)">visit</a>, <a href="../util/SqlBasicVisitor.html#visit(org.apache.calcite.sql.SqlLiteral)">visit</a>, <a href="../util/SqlBasicVisitor.html#visit(org.apache.calcite.sql.SqlNodeList)">visit</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.calcite.sql.SqlOperatorTable,boolean,boolean,boolean,org.apache.calcite.sql.validate.AggFinder,org.apache.calcite.sql.validate.SqlNameMatcher)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AggFinder</h4> |
| <pre>AggFinder​(<a href="../SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a> opTab, |
| boolean over, |
| boolean aggregate, |
| boolean group, |
| <a href="AggFinder.html" title="class in org.apache.calcite.sql.validate">AggFinder</a> delegate, |
| <a href="SqlNameMatcher.html" title="interface in org.apache.calcite.sql.validate">SqlNameMatcher</a> nameMatcher)</pre> |
| <div class="block">Creates an AggFinder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>opTab</code> - Operator table</dd> |
| <dd><code>over</code> - Whether to find windowed function calls <code>agg(x) OVER |
| windowSpec</code></dd> |
| <dd><code>aggregate</code> - Whether to find non-windowed aggregate calls</dd> |
| <dd><code>group</code> - Whether to find group functions (e.g. <code>TUMBLE</code>)</dd> |
| <dd><code>delegate</code> - Finder to which to delegate when processing the arguments</dd> |
| <dd><code>nameMatcher</code> - Whether to match the agg function case-sensitively</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="findAgg(org.apache.calcite.sql.SqlNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findAgg</h4> |
| <pre class="methodSignature">public <a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> findAgg​(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</pre> |
| <div class="block">Finds an aggregate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>node</code> - Parse tree to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>First aggregate function in parse tree, or null if not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="findAgg(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>findAgg</h4> |
| <pre class="methodSignature">public <a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> findAgg​(java.util.List<<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> nodes)</pre> |
| </li> |
| </ul> |
| <a id="found(org.apache.calcite.sql.SqlCall)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>found</h4> |
| <pre class="methodSignature">protected java.lang.Void found​(<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="AggVisitor.html#found(org.apache.calcite.sql.SqlCall)">found</a></code> in class <code><a href="AggVisitor.html" title="class in org.apache.calcite.sql.validate">AggVisitor</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="findAll(java.lang.Iterable)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>findAll</h4> |
| <pre class="methodSignature">java.lang.Iterable<<a href="../SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>> findAll​(java.lang.Iterable<<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> nodes)</pre> |
| <div class="block">Creates a copy of this finder that has the same parameters as this, |
| then returns the list of all aggregates found.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AggFinder.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |