blob: 675bd35292b23857694d7b9c7bdd1773900e8674 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>WinAggResetContext (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: WinAggResetContext">
<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 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:&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="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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>&nbsp;<a href="package-summary.html">org.apache.calcite.adapter.enumerable</a></div>
<h1 title="Interface WinAggResetContext" class="title">Interface WinAggResetContext</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="NestedBlockBuilder.html" title="interface in org.apache.calcite.adapter.enumerable">NestedBlockBuilder</a></code>, <code><a href="WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/WinAggResetContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResetContextImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">WinAggResetContext</span><span class="extends-implements">
extends <a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a>, <a href="WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</a></span></div>
<div class="block">Information for a call to
<a href="AggImplementor.html#implementReset(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggResetContext)"><code>AggImplementor.implementReset(AggContext, AggResetContext)</code></a>.
<p>The <a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable"><code>AggResetContext</code></a> provides access to the accumulator variables
that should be reset.
<p>Note: the very first reset of windowed aggregates is performed with null
knowledge of indices and row count in the partition.
In other words, the implementation should treat indices and partition row
count as a hint to pre-size the collections.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.adapter.enumerable.AggResetContext">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></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.adapter.enumerable.NestedBlockBuilder">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#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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.adapter.enumerable.WinAggFrameContext">Methods inherited from interface&nbsp;org.apache.calcite.adapter.enumerable.<a href="WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</a></h3>
<code><a href="WinAggFrameContext.html#endIndex()">endIndex</a>, <a href="WinAggFrameContext.html#getFrameRowCount()">getFrameRowCount</a>, <a href="WinAggFrameContext.html#getPartitionRowCount()">getPartitionRowCount</a>, <a href="WinAggFrameContext.html#hasRows()">hasRows</a>, <a href="WinAggFrameContext.html#index()">index</a>, <a href="WinAggFrameContext.html#startIndex()">startIndex</a></code></div>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>