blob: 055dacf5891cf21a4a65b8293fdfd5ce25027a2b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>WinAggFrameResultContext (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="WinAggFrameResultContext (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/WinAggFrameResultContext.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 WinAggFrameResultContext" class="title">Interface WinAggFrameResultContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</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>, <code><a href="WinAggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResultContext</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/WinAggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggAddContextImpl</a></code>, <code><a href="impl/WinAggResultContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResultContextImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">WinAggFrameResultContext</span>
extends <a href="WinAggFrameContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameContext</a></pre>
<div class="block">Provides information on the current window when computing the result of
the aggregation.</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><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareRows(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.linq4j.tree.Expression)">compareRows</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;a,
<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;b)</code></th>
<td class="colLast">
<div class="block">Compares two rows given by absolute positions according to the order
collation of the current window.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeIndex(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.WinAggImplementor.SeekType)">computeIndex</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;offset,
<a href="WinAggImplementor.SeekType.html" title="enum in org.apache.calcite.adapter.enumerable">WinAggImplementor.SeekType</a>&nbsp;seekType)</code></th>
<td class="colLast">
<div class="block">Converts absolute index position of the given relative position.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rowInFrame(org.apache.calcite.linq4j.tree.Expression)">rowInFrame</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowIndex)</code></th>
<td class="colLast">
<div class="block">Returns boolean the expression that checks if the given index is in
the frame bounds.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rowInPartition(org.apache.calcite.linq4j.tree.Expression)">rowInPartition</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowIndex)</code></th>
<td class="colLast">
<div class="block">Returns boolean the expression that checks if the given index is in
the partition bounds.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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(org.apache.calcite.linq4j.tree.Expression)">rowTranslator</a></span>&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowIndex)</code></th>
<td class="colLast">
<div class="block">Returns row translator for given absolute row position.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.adapter.enumerable.WinAggFrameContext">
<!-- -->
</a>
<h3>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></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="computeIndex(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.adapter.enumerable.WinAggImplementor.SeekType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeIndex</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;computeIndex&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;offset,
<a href="WinAggImplementor.SeekType.html" title="enum in org.apache.calcite.adapter.enumerable">WinAggImplementor.SeekType</a>&nbsp;seekType)</pre>
<div class="block">Converts absolute index position of the given relative position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offset</code> - offset of the requested row</dd>
<dd><code>seekType</code> - the type of offset (start of window, end of window, etc)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>absolute position of the requested row</dd>
</dl>
</li>
</ul>
<a id="rowInFrame(org.apache.calcite.linq4j.tree.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rowInFrame</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowInFrame&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowIndex)</pre>
<div class="block">Returns boolean the expression that checks if the given index is in
the frame bounds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowIndex</code> - index if the row to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>expression that validates frame bounds for the given index</dd>
</dl>
</li>
</ul>
<a id="rowInPartition(org.apache.calcite.linq4j.tree.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rowInPartition</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowInPartition&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowIndex)</pre>
<div class="block">Returns boolean the expression that checks if the given index is in
the partition bounds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowIndex</code> - index if the row to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>expression that validates partition bounds for the given index</dd>
</dl>
</li>
</ul>
<a id="rowTranslator(org.apache.calcite.linq4j.tree.Expression)">
<!-- -->
</a>
<ul class="blockList">
<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&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;rowIndex)</pre>
<div class="block">Returns row translator for given absolute row position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowIndex</code> - absolute index of the row.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>translator for the requested row</dd>
</dl>
</li>
</ul>
<a id="compareRows(org.apache.calcite.linq4j.tree.Expression,org.apache.calcite.linq4j.tree.Expression)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compareRows</h4>
<pre class="methodSignature"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;compareRows&#8203;(<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;a,
<a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a>&nbsp;b)</pre>
<div class="block">Compares two rows given by absolute positions according to the order
collation of the current window.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>a</code> - absolute index of the first row</dd>
<dd><code>b</code> - absolute index of the second row</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>result of comparison as as in <code>Comparable.compareTo(T)</code></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/WinAggFrameResultContext.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>