blob: ba5473de8c4ffac51b4d362986301b1f8a21fedb [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>AggContext (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="AggContext (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/AggContext.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 AggContext" class="title">Interface AggContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="WinAggContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggContext</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="EnumerableAggregate.AggContextImpl.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregate.AggContextImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">AggContext</span></pre>
<div class="block">Information on the aggregate calculation context.
<a href="AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable"><code>AggAddContext</code></a> provides basic static information on types of arguments
and the return value of the aggregate being implemented.</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="../../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aggregation()">aggregation</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the aggregation being implemented.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupSets()">groupSets</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the grouping sets we are aggregating on.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Integer&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyOrdinals()">keyOrdinals</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the ordinals of the input fields that make up the key.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyRelTypes()">keyRelTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the types of the group key as
<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends java.lang.reflect.Type&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyTypes()">keyTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the types of the group key as
<code>Type</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parameterRelTypes()">parameterRelTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parameter types of the aggregate as
<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends java.lang.reflect.Type&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parameterTypes()">parameterTypes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the parameter types of the aggregate as
<code>Type</code>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#returnRelType()">returnRelType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the return type of the aggregate as
<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.reflect.Type</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#returnType()">returnType</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the return type of the aggregate as <code>Type</code>.</div>
</td>
</tr>
</table>
</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="aggregation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aggregation</h4>
<pre class="methodSignature"><a href="../../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a>&nbsp;aggregation()</pre>
<div class="block">Returns the aggregation being implemented.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>aggregation being implemented.</dd>
</dl>
</li>
</ul>
<a id="returnRelType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>returnRelType</h4>
<pre class="methodSignature"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;returnRelType()</pre>
<div class="block">Returns the return type of the aggregate as
<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.
This can be helpful to test
<a href="../../rel/type/RelDataType.html#isNullable()"><code>RelDataType.isNullable()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return type of the aggregate</dd>
</dl>
</li>
</ul>
<a id="returnType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>returnType</h4>
<pre class="methodSignature">java.lang.reflect.Type&nbsp;returnType()</pre>
<div class="block">Returns the return type of the aggregate as <code>Type</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return type of the aggregate as <code>Type</code></dd>
</dl>
</li>
</ul>
<a id="parameterRelTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterRelTypes</h4>
<pre class="methodSignature">java.util.List&lt;? extends <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;parameterRelTypes()</pre>
<div class="block">Returns the parameter types of the aggregate as
<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.
This can be helpful to test
<a href="../../rel/type/RelDataType.html#isNullable()"><code>RelDataType.isNullable()</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Parameter types of the aggregate</dd>
</dl>
</li>
</ul>
<a id="parameterTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parameterTypes</h4>
<pre class="methodSignature">java.util.List&lt;? extends java.lang.reflect.Type&gt;&nbsp;parameterTypes()</pre>
<div class="block">Returns the parameter types of the aggregate as
<code>Type</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Parameter types of the aggregate</dd>
</dl>
</li>
</ul>
<a id="keyOrdinals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyOrdinals</h4>
<pre class="methodSignature">java.util.List&lt;java.lang.Integer&gt;&nbsp;keyOrdinals()</pre>
<div class="block">Returns the ordinals of the input fields that make up the key.</div>
</li>
</ul>
<a id="keyRelTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyRelTypes</h4>
<pre class="methodSignature">java.util.List&lt;? extends <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;keyRelTypes()</pre>
<div class="block">Returns the types of the group key as
<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.</div>
</li>
</ul>
<a id="keyTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyTypes</h4>
<pre class="methodSignature">java.util.List&lt;? extends java.lang.reflect.Type&gt;&nbsp;keyTypes()</pre>
<div class="block">Returns the types of the group key as
<code>Type</code>.</div>
</li>
</ul>
<a id="groupSets()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>groupSets</h4>
<pre class="methodSignature">java.util.List&lt;<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&gt;&nbsp;groupSets()</pre>
<div class="block">Returns the grouping sets we are aggregating on.</div>
</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/AggContext.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>