blob: 9cf21eb9fd3a6055b5e0619e71abe9e9cace6bd0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>AggregatingScope (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.sql.validate, interface: AggregatingScope">
<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><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.sql.validate</a></div>
<h1 title="Interface AggregatingScope" class="title">Interface AggregatingScope</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AggregatingSelectScope.html" title="class in org.apache.calcite.sql.validate">AggregatingSelectScope</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">AggregatingScope</span><span class="extends-implements">
extends <a href="SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></span></div>
<div class="block">An extension to the <a href="SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidatorScope</code></a> interface which indicates that
the scope is aggregating.
<p>A scope which is aggregating must implement this interface. Such a scope
will return the same set of identifiers as its parent scope, but some of
those identifiers may not be accessible because they are not in the GROUP BY
clause.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.calcite.sql.validate.SqlValidatorScope">Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.sql.validate.<a href="SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></h2>
<code><a href="SqlValidatorScope.EmptyPath.html" title="class in org.apache.calcite.sql.validate">SqlValidatorScope.EmptyPath</a>, <a href="SqlValidatorScope.Path.html" title="class in org.apache.calcite.sql.validate">SqlValidatorScope.Path</a>, <a href="SqlValidatorScope.Resolve.html" title="class in org.apache.calcite.sql.validate">SqlValidatorScope.Resolve</a>, <a href="SqlValidatorScope.Resolved.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope.Resolved</a>, <a href="SqlValidatorScope.ResolvedImpl.html" title="class in org.apache.calcite.sql.validate">SqlValidatorScope.ResolvedImpl</a>, <a href="SqlValidatorScope.Step.html" title="class in org.apache.calcite.sql.validate">SqlValidatorScope.Step</a></code></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-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>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#checkAggregateExpr(org.apache.calcite.sql.SqlNode,boolean)" class="member-name-link">checkAggregateExpr</a><wbr>(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;expr,
boolean&nbsp;deep)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Checks whether an expression is constant within the GROUP BY clause.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.sql.validate.SqlValidatorScope">Methods inherited from interface&nbsp;org.apache.calcite.sql.validate.<a href="SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></h3>
<code><a href="SqlValidatorScope.html#addChild(org.apache.calcite.sql.validate.SqlValidatorNamespace,java.lang.String,boolean)">addChild</a>, <a href="SqlValidatorScope.html#findAliases(java.util.Collection)">findAliases</a>, <a href="SqlValidatorScope.html#findAllColumnNames(java.util.List)">findAllColumnNames</a>, <a href="SqlValidatorScope.html#findQualifyingTableName(java.lang.String,org.apache.calcite.sql.SqlNode)">findQualifyingTableName</a>, <a href="SqlValidatorScope.html#findQualifyingTableNames(java.lang.String,org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.validate.SqlNameMatcher)">findQualifyingTableNames</a>, <a href="SqlValidatorScope.html#fullyQualify(org.apache.calcite.sql.SqlIdentifier)">fullyQualify</a>, <a href="SqlValidatorScope.html#getMonotonicity(org.apache.calcite.sql.SqlNode)">getMonotonicity</a>, <a href="SqlValidatorScope.html#getNode()">getNode</a>, <a href="SqlValidatorScope.html#getOperandScope(org.apache.calcite.sql.SqlCall)">getOperandScope</a>, <a href="SqlValidatorScope.html#getOrderList()">getOrderList</a>, <a href="SqlValidatorScope.html#getTableNamespace(java.util.List)">getTableNamespace</a>, <a href="SqlValidatorScope.html#getValidator()">getValidator</a>, <a href="SqlValidatorScope.html#isMeasureRef(org.apache.calcite.sql.SqlNode)">isMeasureRef</a>, <a href="SqlValidatorScope.html#isWithin(org.apache.calcite.sql.validate.SqlValidatorScope)">isWithin</a>, <a href="SqlValidatorScope.html#lookupWindow(java.lang.String)">lookupWindow</a>, <a href="SqlValidatorScope.html#nullifyType(org.apache.calcite.sql.SqlNode,org.apache.calcite.rel.type.RelDataType)">nullifyType</a>, <a href="SqlValidatorScope.html#resolve(java.util.List,org.apache.calcite.sql.validate.SqlNameMatcher,boolean,org.apache.calcite.sql.validate.SqlValidatorScope.Resolved)">resolve</a>, <a href="SqlValidatorScope.html#resolveColumn(java.lang.String,org.apache.calcite.sql.SqlNode)">resolveColumn</a>, <a href="SqlValidatorScope.html#resolveTable(java.util.List,org.apache.calcite.sql.validate.SqlNameMatcher,org.apache.calcite.sql.validate.SqlValidatorScope.Path,org.apache.calcite.sql.validate.SqlValidatorScope.Resolved)">resolveTable</a>, <a href="SqlValidatorScope.html#validateExpr(org.apache.calcite.sql.SqlNode)">validateExpr</a></code></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="checkAggregateExpr(org.apache.calcite.sql.SqlNode,boolean)">
<h3>checkAggregateExpr</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">checkAggregateExpr</span><wbr><span class="parameters">(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;expr,
boolean&nbsp;deep)</span></div>
<div class="block">Checks whether an expression is constant within the GROUP BY clause. If
the expression completely matches an expression in the GROUP BY clause,
returns true. If the expression is constant within the group, but does
not exactly match, returns false. If the expression is not constant,
throws an exception. Examples:
<ul>
<li>If we are 'f(b, c)' in 'SELECT a + f(b, c) FROM t GROUP BY a', then
the whole expression matches a group column. Return true.
<li>Just an ordinary expression in a GROUP BY query, such as 'f(SUM(a),
1, b)' in 'SELECT f(SUM(a), 1, b) FROM t GROUP BY b'. Returns false.
<li>Illegal expression, such as 'f(5, a, b)' in 'SELECT f(a, b) FROM t
GROUP BY a'. Throws when it enounters the 'b' operand, because it is not
in the group clause.
</ul></div>
</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>