| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>AggImplementor (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="AggImplementor (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AggImplementor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.adapter.enumerable</a></div> |
| <h2 title="Interface AggImplementor" class="title">Interface AggImplementor</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="WinAggImplementor.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggImplementor</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="RexImpTable.BitOpImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.BitOpImplementor</a></code>, <code><a href="RexImpTable.CollectImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.CollectImplementor</a></code>, <code><a href="RexImpTable.CountImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.CountImplementor</a></code>, <code><a href="RexImpTable.CountWinImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.CountWinImplementor</a></code>, <code><a href="RexImpTable.DenseRankImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.DenseRankImplementor</a></code>, <code><a href="RexImpTable.FirstLastValueImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.FirstLastValueImplementor</a></code>, <code><a href="RexImpTable.FirstValueImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.FirstValueImplementor</a></code>, <code><a href="RexImpTable.FusionImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.FusionImplementor</a></code>, <code><a href="RexImpTable.GroupingImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.GroupingImplementor</a></code>, <code><a href="RexImpTable.JsonArrayAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.JsonArrayAggImplementor</a></code>, <code><a href="RexImpTable.JsonObjectAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.JsonObjectAggImplementor</a></code>, <code><a href="RexImpTable.LagImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.LagImplementor</a></code>, <code><a href="RexImpTable.LastValueImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.LastValueImplementor</a></code>, <code><a href="RexImpTable.LeadImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.LeadImplementor</a></code>, <code><a href="RexImpTable.LeadLagImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.LeadLagImplementor</a></code>, <code><a href="RexImpTable.ListaggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.ListaggImplementor</a></code>, <code><a href="RexImpTable.MinMaxImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.MinMaxImplementor</a></code>, <code><a href="RexImpTable.NthValueImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.NthValueImplementor</a></code>, <code><a href="RexImpTable.NtileImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.NtileImplementor</a></code>, <code><a href="RexImpTable.RankImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.RankImplementor</a></code>, <code><a href="RexImpTable.RowNumberImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.RowNumberImplementor</a></code>, <code><a href="RexImpTable.SingleValueImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.SingleValueImplementor</a></code>, <code><a href="RexImpTable.SumImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.SumImplementor</a></code>, <code><a href="RexImpTable.UserDefinedAggReflectiveImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.UserDefinedAggReflectiveImplementor</a></code>, <code><a href="StrictAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">StrictAggImplementor</a></code>, <code><a href="StrictWinAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">StrictWinAggImplementor</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">AggImplementor</span></pre> |
| <div class="block">Implements an aggregate function by generating expressions to |
| initialize, add to, and get a result from, an accumulator.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="StrictAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable"><code>StrictAggImplementor</code></a>, |
| <a href="StrictWinAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable"><code>StrictWinAggImplementor</code></a>, |
| <a href="RexImpTable.CountImplementor.html" title="class in org.apache.calcite.adapter.enumerable"><code>RexImpTable.CountImplementor</code></a>, |
| <a href="RexImpTable.SumImplementor.html" title="class in org.apache.calcite.adapter.enumerable"><code>RexImpTable.SumImplementor</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>java.util.List<java.lang.reflect.Type></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStateType(org.apache.calcite.adapter.enumerable.AggContext)">getStateType</a></span>​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the types of the intermediate variables used by the aggregate |
| implementation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#implementAdd(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggAddContext)">implementAdd</a></span>​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info, |
| <a href="AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a> add)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates intermediate values to account for the newly added value.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#implementReset(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggResetContext)">implementReset</a></span>​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info, |
| <a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a> reset)</code></th> |
| <td class="colLast"> |
| <div class="block">Implements reset of the intermediate variables to the initial state.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#implementResult(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggResultContext)">implementResult</a></span>​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info, |
| <a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a> result)</code></th> |
| <td class="colLast"> |
| <div class="block">Calculates the resulting value based on the intermediate variables.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getStateType(org.apache.calcite.adapter.enumerable.AggContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStateType</h4> |
| <pre class="methodSignature">java.util.List<java.lang.reflect.Type> getStateType​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info)</pre> |
| <div class="block">Returns the types of the intermediate variables used by the aggregate |
| implementation. |
| |
| <p>For instance, for "concatenate to string" this can be |
| <code>StringBuilder</code>. |
| Calcite calls this method before all other <code>implement*</code> methods.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - Aggregate context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Types of the intermediate variables used by the aggregate |
| implementation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="implementReset(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggResetContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>implementReset</h4> |
| <pre class="methodSignature">void implementReset​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info, |
| <a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a> reset)</pre> |
| <div class="block">Implements reset of the intermediate variables to the initial state. |
| <a href="AggResetContext.html#accumulator()"><code>AggResetContext.accumulator()</code></a> should be used to reference |
| the state variables. |
| For instance, to zero the count, use the following code: |
| |
| <blockquote><code>reset.currentBlock().add(<br> |
| Expressions.statement(<br> |
| Expressions.assign(reset.accumulator().get(0),<br> |
| Expressions.constant(0)));</code></blockquote></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - Aggregate context</dd> |
| <dd><code>reset</code> - Reset context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="implementAdd(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggAddContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>implementAdd</h4> |
| <pre class="methodSignature">void implementAdd​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info, |
| <a href="AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a> add)</pre> |
| <div class="block">Updates intermediate values to account for the newly added value. |
| <a href="AggResetContext.html#accumulator()"><code>AggResetContext.accumulator()</code></a> should be used to reference |
| the state variables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - Aggregate context</dd> |
| <dd><code>add</code> - Add context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="implementResult(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggResultContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>implementResult</h4> |
| <pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> implementResult​(<a href="AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a> info, |
| <a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a> result)</pre> |
| <div class="block">Calculates the resulting value based on the intermediate variables. |
| Note: this method must NOT destroy the intermediate variables as |
| calcite might reuse the state when calculating sliding aggregates. |
| <a href="AggResetContext.html#accumulator()"><code>AggResetContext.accumulator()</code></a> should be used to reference |
| the state variables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>info</code> - Aggregate context</dd> |
| <dd><code>result</code> - Result context</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Expression that is a result of calculating final value of |
| the aggregate being implemented</dd> |
| </dl> |
| </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/AggImplementor.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
