blob: e41c55c9324c3a53efd33ff253d34a352ea139fd [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AggResultContext (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AggResultContext (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/adapter/enumerable/BasicAggregateLambdaFactory.html" title="class in org.apache.calcite.adapter.enumerable"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/adapter/enumerable/AggResultContext.html" target="_top">Frames</a></li>
<li><a href="AggResultContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.adapter.enumerable</div>
<h2 title="Interface AggResultContext" class="title">Interface AggResultContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html" title="interface in org.apache.calcite.adapter.enumerable">NestedBlockBuilder</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggAddContext</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResultContext</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/calcite/adapter/enumerable/impl/AggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">AggAddContextImpl</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/impl/AggResultContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">AggResultContextImpl</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/impl/WinAggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggAddContextImpl</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/impl/WinAggResultContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResultContextImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">AggResultContext</span>
extends <a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html" title="interface in org.apache.calcite.adapter.enumerable">NestedBlockBuilder</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a></pre>
<div class="block">Information for a call to
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggImplementor.html#implementResult-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggResultContext-"><code>AggImplementor.implementResult(AggContext, AggResultContext)</code></a>
<p>Typically, the aggregation implementation will convert
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html#accumulator--"><code>AggResetContext.accumulator()</code></a> to the resulting value of the aggregation. The
implementation MUST NOT destroy the contents of <a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html#accumulator--"><code>AggResetContext.accumulator()</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html#call--">call</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html#key--">key</a></span>()</code>
<div class="block">Expression by which to reference the key upon which the values in the
accumulator were aggregated.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html#keyField-int-">keyField</a></span>(int&nbsp;i)</code>
<div class="block">Returns an expression that references the <code>i</code>th field of the key,
cast to the appropriate type.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.AggResetContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html#accumulator--">accumulator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.NestedBlockBuilder">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html" title="interface in org.apache.calcite.adapter.enumerable">NestedBlockBuilder</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html#currentBlock--">currentBlock</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html#exitBlock--">exitBlock</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html#nestBlock--">nestBlock</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/NestedBlockBuilder.html#nestBlock-org.apache.calcite.linq4j.tree.BlockBuilder-">nestBlock</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="key--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>key</h4>
<pre><a href="../../../../../org/apache/calcite/linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;key()</pre>
<div class="block">Expression by which to reference the key upon which the values in the
accumulator were aggregated. Most aggregate functions depend on only the
accumulator, but quasi-aggregate functions such as GROUPING access at the
key.</div>
</li>
</ul>
<a name="keyField-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyField</h4>
<pre><a href="../../../../../org/apache/calcite/linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;keyField(int&nbsp;i)</pre>
<div class="block">Returns an expression that references the <code>i</code>th field of the key,
cast to the appropriate type.</div>
</li>
</ul>
<a name="call--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>call</h4>
<pre><a href="../../../../../org/apache/calcite/rel/core/AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>&nbsp;call()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/calcite/adapter/enumerable/BasicAggregateLambdaFactory.html" title="class in org.apache.calcite.adapter.enumerable"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/adapter/enumerable/AggResultContext.html" target="_top">Frames</a></li>
<li><a href="AggResultContext.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>