| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>WinAggFrameContext (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: WinAggFrameContext"> |
| <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 evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></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> <a href="package-summary.html">org.apache.calcite.adapter.enumerable</a></div> |
| <h1 title="Interface WinAggFrameContext" class="title">Interface WinAggFrameContext</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <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="WinAggFrameResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggFrameResultContext</a></code>, <code><a href="WinAggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResetContext</a></code>, <code><a href="WinAggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResultContext</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <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/WinAggResetContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResetContextImpl</a></code>, <code><a href="impl/WinAggResultContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResultContextImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">WinAggFrameContext</span></div> |
| <div class="block">Provides information on the current window. |
| |
| <p>All the indexes are ready to be used in |
| <a href="WinAggResultContext.html#arguments(org.apache.calcite.linq4j.tree.Expression)"><code>WinAggResultContext.arguments(org.apache.calcite.linq4j.tree.Expression)</code></a>, |
| <a href="WinAggFrameResultContext.html#rowTranslator(org.apache.calcite.linq4j.tree.Expression)"><code>WinAggFrameResultContext.rowTranslator(org.apache.calcite.linq4j.tree.Expression)</code></a> |
| and similar methods.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#endIndex()" class="member-name-link">endIndex</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the index of the very last row in partition.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFrameRowCount()" class="member-name-link">getFrameRowCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of rows in the current frame (subject to framing |
| clause).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPartitionRowCount()" class="member-name-link">getPartitionRowCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of rows in the current partition (as determined by |
| PARTITION BY clause).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasRows()" class="member-name-link">hasRows</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the boolean expression that tells if the partition has rows.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#index()" class="member-name-link">index</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the index of the current row in the partition.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startIndex()" class="member-name-link">startIndex</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the index of the very first row in partition.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="index()"> |
| <h3>index</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">index</span>()</div> |
| <div class="block">Returns the index of the current row in the partition. |
| In other words, it is close to ~ROWS BETWEEN CURRENT ROW. |
| Note to use <a href="#startIndex()"><code>startIndex()</code></a> when you need zero-based row position.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the index of the very first row in partition</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startIndex()"> |
| <h3>startIndex</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">startIndex</span>()</div> |
| <div class="block">Returns the index of the very first row in partition.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>index of the very first row in partition</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="endIndex()"> |
| <h3>endIndex</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">endIndex</span>()</div> |
| <div class="block">Returns the index of the very last row in partition.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>index of the very last row in partition</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasRows()"> |
| <h3>hasRows</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">hasRows</span>()</div> |
| <div class="block">Returns the boolean expression that tells if the partition has rows. |
| The partition might lack rows in cases like ROWS BETWEEN 1000 PRECEDING |
| AND 900 PRECEDING.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>boolean expression that tells if the partition has rows</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFrameRowCount()"> |
| <h3>getFrameRowCount</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">getFrameRowCount</span>()</div> |
| <div class="block">Returns the number of rows in the current frame (subject to framing |
| clause).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of rows in the current partition or 0 if the partition |
| is empty</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPartitionRowCount()"> |
| <h3>getPartitionRowCount</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a></span> <span class="element-name">getPartitionRowCount</span>()</div> |
| <div class="block">Returns the number of rows in the current partition (as determined by |
| PARTITION BY clause).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of rows in the current partition or 0 if the partition |
| is empty</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
