blob: 803509ccc154d6d265008af1efd205335ad2ccdf [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RexWindowBound (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="RexWindowBound (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/RexWindowBound.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.rex</a></div>
<h2 title="Class RexWindowBound" class="title">Class RexWindowBound</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.rex.RexWindowBound</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="RexWindowBound.RexWindowBoundBounded.html" title="class in org.apache.calcite.rex">RexWindowBound.RexWindowBoundBounded</a></code>, <code><a href="RexWindowBound.RexWindowBoundCurrentRow.html" title="class in org.apache.calcite.rex">RexWindowBound.RexWindowBoundCurrentRow</a></code>, <code><a href="RexWindowBound.RexWindowBoundUnbounded.html" title="class in org.apache.calcite.rex">RexWindowBound.RexWindowBoundUnbounded</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">RexWindowBound</span>
extends java.lang.Object</pre>
<div class="block">Abstracts "XX PRECEDING/FOLLOWING" and "CURRENT ROW" bounds for windowed
aggregates.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RexWindowBound.RexWindowBoundBounded.html" title="class in org.apache.calcite.rex">RexWindowBound.RexWindowBoundBounded</a></span></code></th>
<td class="colLast">
<div class="block">Implements XX PRECEDING/FOLLOWING bound where XX is not UNBOUNDED.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RexWindowBound.RexWindowBoundCurrentRow.html" title="class in org.apache.calcite.rex">RexWindowBound.RexWindowBoundCurrentRow</a></span></code></th>
<td class="colLast">
<div class="block">Implements CURRENT ROW bound.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RexWindowBound.RexWindowBoundUnbounded.html" title="class in org.apache.calcite.rex">RexWindowBound.RexWindowBoundUnbounded</a></span></code></th>
<td class="colLast">
<div class="block">Implements UNBOUNDED PRECEDING/FOLLOWING bound.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RexWindowBound</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>&lt;R&gt;&nbsp;<a href="RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(org.apache.calcite.rex.RexVisitor)">accept</a></span>&#8203;(<a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;R&gt;&nbsp;visitor)</code></th>
<td class="colLast">
<div class="block">Transforms the bound via <a href="RexVisitor.html" title="interface in org.apache.calcite.rex"><code>RexVisitor</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(org.apache.calcite.sql.SqlNode,org.apache.calcite.rex.RexNode)">create</a></span>&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;node,
<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;rexNode)</code></th>
<td class="colLast">
<div class="block">Creates window bound.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOffset()">getOffset</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns offset from XX PRECEDING/FOLLOWING.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrderKey()">getOrderKey</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns relative sort offset when known at compile time.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCurrentRow()">isCurrentRow</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns if the bound is CURRENT ROW.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFollowing()">isFollowing</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns if the bound is FOLLOWING.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPreceding()">isPreceding</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns if the bound is PRECEDING.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUnbounded()">isUnbounded</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns if the bound is unbounded.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RexWindowBound</h4>
<pre>public&nbsp;RexWindowBound()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="create(org.apache.calcite.sql.SqlNode,org.apache.calcite.rex.RexNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;create&#8203;(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;node,
<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;rexNode)</pre>
<div class="block">Creates window bound.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - SqlNode of the bound</dd>
<dd><code>rexNode</code> - offset value when bound is not UNBOUNDED/CURRENT ROW</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>window bound</dd>
</dl>
</li>
</ul>
<a id="isUnbounded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUnbounded</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isUnbounded()</pre>
<div class="block">Returns if the bound is unbounded.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the bound is unbounded</dd>
</dl>
</li>
</ul>
<a id="isPreceding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPreceding</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isPreceding()</pre>
<div class="block">Returns if the bound is PRECEDING.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the bound is PRECEDING</dd>
</dl>
</li>
</ul>
<a id="isFollowing()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFollowing</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFollowing()</pre>
<div class="block">Returns if the bound is FOLLOWING.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the bound is FOLLOWING</dd>
</dl>
</li>
</ul>
<a id="isCurrentRow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCurrentRow</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isCurrentRow()</pre>
<div class="block">Returns if the bound is CURRENT ROW.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>if the bound is CURRENT ROW</dd>
</dl>
</li>
</ul>
<a id="getOffset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffset</h4>
<pre class="methodSignature">public&nbsp;<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;getOffset()</pre>
<div class="block">Returns offset from XX PRECEDING/FOLLOWING.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>offset from XX PRECEDING/FOLLOWING</dd>
</dl>
</li>
</ul>
<a id="getOrderKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrderKey</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOrderKey()</pre>
<div class="block">Returns relative sort offset when known at compile time.
For instance, UNBOUNDED PRECEDING is less than CURRENT ROW.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>relative order or -1 when order is not known</dd>
</dl>
</li>
</ul>
<a id="accept(org.apache.calcite.rex.RexVisitor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>accept</h4>
<pre class="methodSignature">public&nbsp;&lt;R&gt;&nbsp;<a href="RexWindowBound.html" title="class in org.apache.calcite.rex">RexWindowBound</a>&nbsp;accept&#8203;(<a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;R&gt;&nbsp;visitor)</pre>
<div class="block">Transforms the bound via <a href="RexVisitor.html" title="interface in org.apache.calcite.rex"><code>RexVisitor</code></a>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>R</code> - return type of the visitor</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visitor</code> - visitor to accept</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>transformed bound</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/RexWindowBound.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>