blob: 6ff12c8fd266d6973c82bcc187e78c40cc192c44 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AggAddContext (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="AggAddContext (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/AggAddContext.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.adapter.enumerable</a></div>
<h2 title="Interface AggAddContext" class="title">Interface AggAddContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<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>
<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>
<pre>public interface <span class="typeNameLabel">AggAddContext</span>
extends <a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a></pre>
<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>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#arguments()">arguments</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns Linq4j form of arguments.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rexArguments()">rexArguments</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of arguments.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rexFilterArgument()">rexFilterArgument</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable">RexToLixTranslator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rowTranslator()">rowTranslator</a></span>()</code></th>
<td class="colLast">
<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>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.AggResetContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.AggResultContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.NestedBlockBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;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#currentNullables()">currentNullables</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>, <a href="NestedBlockBuilder.html#nestBlock(org.apache.calcite.linq4j.tree.BlockBuilder,java.util.Map)">nestBlock</a></code></li>
</ul>
</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="rexArguments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rexArguments</h4>
<pre class="methodSignature">java.util.List&lt;<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;rexArguments()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> representation of arguments</dd>
</dl>
</li>
</ul>
<a id="rexFilterArgument()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rexFilterArgument</h4>
<pre class="methodSignature"><a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;rexFilterArgument()</pre>
<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>
</li>
</ul>
<a id="arguments()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>arguments</h4>
<pre class="methodSignature">java.util.List&lt;<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&gt;&nbsp;arguments()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Linq4j form of arguments.</dd>
</dl>
</li>
</ul>
<a id="rowTranslator()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rowTranslator</h4>
<pre class="methodSignature"><a href="RexToLixTranslator.html" title="class in org.apache.calcite.adapter.enumerable">RexToLixTranslator</a>&nbsp;rowTranslator()</pre>
<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>
<dt><span class="returnLabel">Returns:</span></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>
</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/AggAddContext.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>