Google Git
Sign in
apache / calcite-site / refs/heads/1.24 / . / javadocAggregate / org / apache / calcite / adapter / enumerable / AggImplementor.html
blob: bb62af670f41904c36efbaddbcefbbcfc9a9e270 [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>AggImplementor (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="AggImplementor (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</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/AggContext.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/AggImpState.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/AggImplementor.html" target="_top">Frames</a></li>
<li><a href="AggImplementor.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 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><a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggImplementor.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggImplementor</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/calcite/adapter/enumerable/RexImpTable.LagImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.LagImplementor</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/RexImpTable.LeadImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.LeadImplementor</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/RexImpTable.UserDefinedAggReflectiveImplementor.html" title="class in org.apache.calcite.adapter.enumerable">RexImpTable.UserDefinedAggReflectiveImplementor</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/StrictAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">StrictAggImplementor</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/StrictWinAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable">StrictWinAggImplementor</a></dd>
</dl>
<hr>
<br>
<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="../../../../../org/apache/calcite/adapter/enumerable/StrictAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable"><code>StrictAggImplementor</code></a>,
<a href="../../../../../org/apache/calcite/adapter/enumerable/StrictWinAggImplementor.html" title="class in org.apache.calcite.adapter.enumerable"><code>StrictWinAggImplementor</code></a>,
<code>RexImpTable.CountImplementor</code>,
<code>RexImpTable.SumImplementor</code></dd>
</dl>
</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="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/enumerable/AggImplementor.html#getStateType-org.apache.calcite.adapter.enumerable.AggContext-">getStateType</a></span>(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/enumerable/AggImplementor.html#implementAdd-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggAddContext-">implementAdd</a></span>(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info,
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a>&nbsp;add)</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/adapter/enumerable/AggImplementor.html#implementReset-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggResetContext-">implementReset</a></span>(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info,
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a>&nbsp;reset)</code>
<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="../../../../../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/AggImplementor.html#implementResult-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggResultContext-">implementResult</a></span>(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info,
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a>&nbsp;result)</code>
<div class="block">Calculates the resulting value based on the intermediate variables.</div>
</td>
</tr>
</table>
</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="getStateType-org.apache.calcite.adapter.enumerable.AggContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStateType</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect">Type</a>&gt;&nbsp;getStateType(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;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
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang"><code>StringBuilder</code></a>.
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 name="implementReset-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggResetContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>implementReset</h4>
<pre>void&nbsp;implementReset(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info,
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a>&nbsp;reset)</pre>
<div class="block">Implements reset of the intermediate variables to the initial state.
<a href="../../../../../org/apache/calcite/adapter/enumerable/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 name="implementAdd-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggAddContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>implementAdd</h4>
<pre>void&nbsp;implementAdd(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info,
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a>&nbsp;add)</pre>
<div class="block">Updates intermediate values to account for the newly added value.
<a href="../../../../../org/apache/calcite/adapter/enumerable/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 name="implementResult-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggResultContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>implementResult</h4>
<pre><a href="../../../../../org/apache/calcite/linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;implementResult(<a href="../../../../../org/apache/calcite/adapter/enumerable/AggContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggContext</a>&nbsp;info,
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a>&nbsp;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="../../../../../org/apache/calcite/adapter/enumerable/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>
</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/AggContext.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/AggImpState.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/AggImplementor.html" target="_top">Frames</a></li>
<li><a href="AggImplementor.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>