blob: a7bd336a431ecfbc5d7f6c1317ff700caaadd50c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Aggregate.AggCallBinding (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.rel.core, class: Aggregate, class: AggCallBinding">
<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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.rel.core</a></div>
<h1 title="Class Aggregate.AggCallBinding" class="title">Class Aggregate.AggCallBinding</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlOperatorBinding</a>
<div class="inheritance">org.apache.calcite.rel.core.Aggregate.AggCallBinding</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="Aggregate.PercentileDiscAggCallBinding.html" title="class in org.apache.calcite.rel.core">Aggregate.PercentileDiscAggCallBinding</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">Aggregate.AggCallBinding</span>
<span class="extends-implements">extends <a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></span></div>
<div class="block">Implementation of the <a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql"><code>SqlOperatorBinding</code></a> interface for an
<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core"><code>aggregate call</code></a> applied to a set of operands in the
context of a <a href="../logical/LogicalAggregate.html" title="class in org.apache.calcite.rel.logical"><code>LogicalAggregate</code></a>.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.sql.SqlOperatorBinding">Fields inherited from class&nbsp;org.apache.calcite.sql.<a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></h3>
<code><a href="../../sql/SqlOperatorBinding.html#typeFactory">typeFactory</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlAggFunction,java.util.List,int,boolean)" class="member-name-link">AggCallBinding</a><wbr>(<a href="../type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a>&nbsp;aggFunction,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;operands,
int&nbsp;groupCount,
boolean&nbsp;filter)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates an AggCallBinding.</div>
</div>
</div>
</section>
</li>
<!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGroupCount()" class="member-name-link">getGroupCount</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">If the operator call occurs in an aggregate query, returns the number of
columns in the GROUP BY clause.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperandCount()" class="member-name-link">getOperandCount</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the number of bound operands.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperandType(int)" class="member-name-link">getOperandType</a><wbr>(int&nbsp;ordinal)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the type of a bound operand.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasFilter()" class="member-name-link">hasFilter</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns whether the operator is an aggregate function with a filter.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newError(org.apache.calcite.runtime.Resources.ExInst)" class="member-name-link">newError</a><wbr>(org.apache.calcite.runtime.Resources.ExInst&lt;<a href="../../sql/validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>&gt;&nbsp;e)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Wraps a validation error with context appropriate to this operator call.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.sql.SqlOperatorBinding">Methods inherited from class&nbsp;org.apache.calcite.sql.<a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></h3>
<code><a href="../../sql/SqlOperatorBinding.html#collectOperandTypes()">collectOperandTypes</a>, <a href="../../sql/SqlOperatorBinding.html#getCollationType()">getCollationType</a>, <a href="../../sql/SqlOperatorBinding.html#getColumnListParamInfo(int,java.lang.String,java.util.List)">getColumnListParamInfo</a>, <a href="../../sql/SqlOperatorBinding.html#getCursorOperand(int)">getCursorOperand</a>, <a href="../../sql/SqlOperatorBinding.html#getIntLiteralOperand(int)">getIntLiteralOperand</a>, <a href="../../sql/SqlOperatorBinding.html#getOperandLiteralValue(int)">getOperandLiteralValue</a>, <a href="../../sql/SqlOperatorBinding.html#getOperandLiteralValue(int,java.lang.Class)">getOperandLiteralValue</a>, <a href="../../sql/SqlOperatorBinding.html#getOperandLiteralValue(int,org.apache.calcite.rel.type.RelDataType)">getOperandLiteralValue</a>, <a href="../../sql/SqlOperatorBinding.html#getOperandMonotonicity(int)">getOperandMonotonicity</a>, <a href="../../sql/SqlOperatorBinding.html#getOperator()">getOperator</a>, <a href="../../sql/SqlOperatorBinding.html#getStringLiteralOperand(int)">getStringLiteralOperand</a>, <a href="../../sql/SqlOperatorBinding.html#getTypeFactory()">getTypeFactory</a>, <a href="../../sql/SqlOperatorBinding.html#isOperandLiteral(int,boolean)">isOperandLiteral</a>, <a href="../../sql/SqlOperatorBinding.html#isOperandNull(int,boolean)">isOperandNull</a>, <a href="../../sql/SqlOperatorBinding.html#isOperandTimeFrame(int)">isOperandTimeFrame</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlAggFunction,java.util.List,int,boolean)">
<h3>AggCallBinding</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">AggCallBinding</span><wbr><span class="parameters">(<a href="../type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a>&nbsp;aggFunction,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;operands,
int&nbsp;groupCount,
boolean&nbsp;filter)</span></div>
<div class="block">Creates an AggCallBinding.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>typeFactory</code> - Type factory</dd>
<dd><code>aggFunction</code> - Aggregate function</dd>
<dd><code>operands</code> - Data types of operands</dd>
<dd><code>groupCount</code> - Number of columns in the GROUP BY clause</dd>
<dd><code>filter</code> - Whether the aggregate function has a FILTER clause</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getGroupCount()">
<h3>getGroupCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getGroupCount</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../sql/SqlOperatorBinding.html#getGroupCount()">SqlOperatorBinding</a></code></span></div>
<div class="block">If the operator call occurs in an aggregate query, returns the number of
columns in the GROUP BY clause. For example, for "SELECT count(*) FROM emp
GROUP BY deptno, gender", returns 2.
<p>Returns 0 if the query is implicitly "GROUP BY ()" because of an
aggregate expression. For example, "SELECT sum(sal) FROM emp".</p>
<p>Returns -1 if the query is not an aggregate query.</p></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../sql/SqlOperatorBinding.html#getGroupCount()">getGroupCount</a></code>&nbsp;in class&nbsp;<code><a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasFilter()">
<h3>hasFilter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasFilter</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../sql/SqlOperatorBinding.html#hasFilter()">SqlOperatorBinding</a></code></span></div>
<div class="block">Returns whether the operator is an aggregate function with a filter.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../../sql/SqlOperatorBinding.html#hasFilter()">hasFilter</a></code>&nbsp;in class&nbsp;<code><a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOperandCount()">
<h3>getOperandCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getOperandCount</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../sql/SqlOperatorBinding.html#getOperandCount()">SqlOperatorBinding</a></code></span></div>
<div class="block">Returns the number of bound operands.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../sql/SqlOperatorBinding.html#getOperandCount()">getOperandCount</a></code>&nbsp;in class&nbsp;<code><a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOperandType(int)">
<h3>getOperandType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="element-name">getOperandType</span><wbr><span class="parameters">(int&nbsp;ordinal)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../sql/SqlOperatorBinding.html#getOperandType(int)">SqlOperatorBinding</a></code></span></div>
<div class="block">Gets the type of a bound operand.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../sql/SqlOperatorBinding.html#getOperandType(int)">getOperandType</a></code>&nbsp;in class&nbsp;<code><a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt>Parameters:</dt>
<dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd>
<dt>Returns:</dt>
<dd>bound operand type</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="newError(org.apache.calcite.runtime.Resources.ExInst)">
<h3>newError</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></span>&nbsp;<span class="element-name">newError</span><wbr><span class="parameters">(org.apache.calcite.runtime.Resources.ExInst&lt;<a href="../../sql/validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>&gt;&nbsp;e)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../../sql/SqlOperatorBinding.html#newError(org.apache.calcite.runtime.Resources.ExInst)">SqlOperatorBinding</a></code></span></div>
<div class="block">Wraps a validation error with context appropriate to this operator call.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../sql/SqlOperatorBinding.html#newError(org.apache.calcite.runtime.Resources.ExInst)">newError</a></code>&nbsp;in class&nbsp;<code><a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt>Parameters:</dt>
<dd><code>e</code> - Validation error, not null</dd>
<dt>Returns:</dt>
<dd>Error wrapped, if possible, with positional information</dd>
</dl>
</section>
</li>
</ul>
</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>