Google Git
Sign in
apache / calcite-site / refs/heads/1.24 / . / javadocAggregate / org / apache / calcite / adapter / enumerable / WinAggAddContext.html
blob: b4fcae40f6a6719dce0881cbfcf231125ed492b4 [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>WinAggAddContext (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="WinAggAddContext (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/TableFunctionCallImplementor.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/WinAggContext.html" title="interface 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/WinAggAddContext.html" target="_top">Frames</a></li>
<li><a href="WinAggAddContext.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 WinAggAddContext" class="title">Interface WinAggAddContext</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/AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a>, <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/AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a>, <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/WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameResultContext</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/WinAggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggAddContextImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">WinAggAddContext</span>
extends <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/WinAggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResultContext</a></pre>
<div class="block">Information for a call to
<a href="../../../../../org/apache/calcite/adapter/enumerable/AggImplementor.html#implementAdd-org.apache.calcite.adapter.enumerable.AggContext-org.apache.calcite.adapter.enumerable.AggAddContext-"><code>AggImplementor.implementAdd(AggContext, AggAddContext)</code></a>.
<p><a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable"><code>WinAggAddContext</code></a> is used when implementing windowed aggregate.
Typically, the aggregation implementation will use <a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html#arguments--"><code>AggAddContext.arguments()</code></a>
or <a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html#rexArguments--"><code>AggAddContext.rexArguments()</code></a> to update aggregate value.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable"><code>AggAddContext</code></a></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="../../../../../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/WinAggAddContext.html#currentPosition--">currentPosition</a></span>()</code>
<div class="block">Returns current position inside for-loop of window aggregate.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.AggAddContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html#arguments--">arguments</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html#rexArguments--">rexArguments</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html#rexFilterArgument--">rexFilterArgument</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/AggAddContext.html#rowTranslator--">rowTranslator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.WinAggResultContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResultContext</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggResultContext.html#arguments-org.apache.calcite.linq4j.tree.Expression-">arguments</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggResultContext.html#rexArguments--">rexArguments</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.AggResultContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html#call--">call</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html#key--">key</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/AggResultContext.html#keyField-int-">keyField</a></code></li>
</ul>
<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.WinAggFrameResultContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameResultContext</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html#compareRows-org.apache.calcite.linq4j.tree.Expression-org.apache.calcite.linq4j.tree.Expression-">compareRows</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html#computeIndex-org.apache.calcite.linq4j.tree.Expression-org.apache.calcite.adapter.enumerable.WinAggImplementor.SeekType-">computeIndex</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html#rowInFrame-org.apache.calcite.linq4j.tree.Expression-">rowInFrame</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html#rowInPartition-org.apache.calcite.linq4j.tree.Expression-">rowInPartition</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameResultContext.html#rowTranslator-org.apache.calcite.linq4j.tree.Expression-">rowTranslator</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.WinAggFrameContext">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</a></h3>
<code><a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#endIndex--">endIndex</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#getFrameRowCount--">getFrameRowCount</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#getPartitionRowCount--">getPartitionRowCount</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#hasRows--">hasRows</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#index--">index</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#startIndex--">startIndex</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="currentPosition--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>currentPosition</h4>
<pre><a href="../../../../../org/apache/calcite/linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;currentPosition()</pre>
<div class="block">Returns current position inside for-loop of window aggregate.
Note, the position is relative to <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#startIndex--"><code>WinAggFrameContext.startIndex()</code></a>.
This is NOT current row as in "rows between current row".
If you need to know the relative index of the current row in the partition,
use <a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#index--"><code>WinAggFrameContext.index()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current position inside for-loop of window aggregate.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#index--"><code>WinAggFrameContext.index()</code></a>,
<a href="../../../../../org/apache/calcite/adapter/enumerable/WinAggFrameContext.html#startIndex--"><code>WinAggFrameContext.startIndex()</code></a></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/TableFunctionCallImplementor.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/WinAggContext.html" title="interface 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/WinAggAddContext.html" target="_top">Frames</a></li>
<li><a href="WinAggAddContext.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>