| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AggAddContext (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.adapter.enumerable, interface: AggAddContext"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.adapter.enumerable</a></div> |
| <h1 title="Interface AggAddContext" class="title">Interface AggAddContext</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a></code>, <code><a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a></code>, <code><a href="NestedBlockBuilder.html" title="interface in org.apache.calcite.adapter.enumerable">NestedBlockBuilder</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="WinAggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggAddContext</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/AggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">AggAddContextImpl</a></code>, <code><a href="impl/WinAggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggAddContextImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">AggAddContext</span><span class="extends-implements"> |
| extends <a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a></span></div> |
| <div class="block">Information for a call to |
| <a href="AggImplementor.html#implementAdd(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggAddContext)"><code>AggImplementor.implementAdd(AggContext, AggAddContext)</code></a>. |
| |
| <p>Typically, the aggregation implementation will use <a href="#arguments()"><code>arguments()</code></a> |
| or <a href="#rexArguments()"><code>rexArguments()</code></a> to update aggregate value.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#arguments()" class="member-name-link">arguments</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Linq4j form of arguments.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rexArguments()" class="member-name-link">rexArguments</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of arguments.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rexFilterArgument()" class="member-name-link">rexFilterArgument</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of the |
| filter, or null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable">RexToLixTranslator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#rowTranslator()" class="member-name-link">rowTranslator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns a |
| <a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable"><code>RexToLixTranslator</code></a> |
| suitable to transform the arguments.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.adapter.enumerable.AggResetContext">Methods inherited from interface org.apache.calcite.adapter.enumerable.<a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a></h3> |
| <code><a href="AggResetContext.html#accumulator()">accumulator</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.adapter.enumerable.AggResultContext">Methods inherited from interface org.apache.calcite.adapter.enumerable.<a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a></h3> |
| <code><a href="AggResultContext.html#call()">call</a>, <a href="AggResultContext.html#key()">key</a>, <a href="AggResultContext.html#keyField(int)">keyField</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.adapter.enumerable.NestedBlockBuilder">Methods inherited from interface org.apache.calcite.adapter.enumerable.<a href="NestedBlockBuilder.html" title="interface in org.apache.calcite.adapter.enumerable">NestedBlockBuilder</a></h3> |
| <code><a href="NestedBlockBuilder.html#currentBlock()">currentBlock</a>, <a href="NestedBlockBuilder.html#exitBlock()">exitBlock</a>, <a href="NestedBlockBuilder.html#nestBlock()">nestBlock</a>, <a href="NestedBlockBuilder.html#nestBlock(org.apache.calcite.linq4j.tree.BlockBuilder)">nestBlock</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="rexArguments()"> |
| <h3>rexArguments</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></span> <span class="element-name">rexArguments</span>()</div> |
| <div class="block">Returns <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of arguments. |
| This can be useful for manual translation of required arguments with |
| different <a href="NullPolicy.html" title="enum in org.apache.calcite.adapter.enumerable"><code>NullPolicy</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of arguments</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rexFilterArgument()"> |
| <h3>rexFilterArgument</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">rexFilterArgument</span>()</div> |
| <div class="block">Returns <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of the |
| filter, or null.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="arguments()"> |
| <h3>arguments</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>></span> <span class="element-name">arguments</span>()</div> |
| <div class="block">Returns Linq4j form of arguments. |
| The resulting value is equivalent to |
| <code>rowTranslator().translateList(rexArguments())</code>. |
| This is handy if you need just operate on argument.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Linq4j form of arguments.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowTranslator()"> |
| <h3>rowTranslator</h3> |
| <div class="member-signature"><span class="return-type"><a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable">RexToLixTranslator</a></span> <span class="element-name">rowTranslator</span>()</div> |
| <div class="block">Returns a |
| <a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable"><code>RexToLixTranslator</code></a> |
| suitable to transform the arguments.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable"><code>RexToLixTranslator</code></a> suitable to transform the arguments</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
