| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Aggregate (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"> |
| <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><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.rel.core</a></div> |
| <h1 title="Class Aggregate" class="title">Class Aggregate</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="../AbstractRelNode.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.AbstractRelNode</a> |
| <div class="inheritance"><a href="../SingleRel.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.SingleRel</a> |
| <div class="inheritance">org.apache.calcite.rel.core.Aggregate</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code>, <code><a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></code>, <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../../interpreter/Bindables.BindableAggregate.html" title="class in org.apache.calcite.interpreter">Bindables.BindableAggregate</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchAggregate.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchAggregate</a></code>, <code><a href="../../adapter/enumerable/EnumerableAggregateBase.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregateBase</a></code>, <code><a href="../../adapter/geode/rel/GeodeAggregate.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeAggregate</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcAggregate.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcAggregate</a></code>, <code><a href="../logical/LogicalAggregate.html" title="class in org.apache.calcite.rel.logical">LogicalAggregate</a></code>, <code><a href="../../adapter/mongodb/MongoAggregate.html" title="class in org.apache.calcite.adapter.mongodb">MongoAggregate</a></code>, <code><a href="../../adapter/pig/PigAggregate.html" title="class in org.apache.calcite.adapter.pig">PigAggregate</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Aggregate</span> |
| <span class="extends-implements">extends <a href="../SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a> |
| implements <a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></span></div> |
| <div class="block">Relational operator that eliminates |
| duplicates and computes totals. |
| |
| <p>It corresponds to the <code>GROUP BY</code> operator in a SQL query |
| statement, together with the aggregate functions in the <code>SELECT</code> |
| clause. |
| |
| <p>Rules: |
| |
| <ul> |
| <li><a href="../rules/AggregateProjectPullUpConstantsRule.html" title="class in org.apache.calcite.rel.rules"><code>AggregateProjectPullUpConstantsRule</code></a> |
| <li><a href="../rules/AggregateExpandDistinctAggregatesRule.html" title="class in org.apache.calcite.rel.rules"><code>AggregateExpandDistinctAggregatesRule</code></a> |
| <li><a href="../rules/AggregateReduceFunctionsRule.html" title="class in org.apache.calcite.rel.rules"><code>AggregateReduceFunctionsRule</code></a>. |
| </ul></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="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="Aggregate.AggCallBinding.html" class="type-name-link" title="class in org.apache.calcite.rel.core">Aggregate.AggCallBinding</a></code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="Aggregate.Group.html" class="type-name-link" title="enum in org.apache.calcite.rel.core">Aggregate.Group</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Describes the kind of roll-up.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="Aggregate.PercentileDiscAggCallBinding.html" class="type-name-link" title="class in org.apache.calcite.rel.core">Aggregate.PercentileDiscAggCallBinding</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Used for PERCENTILE_DISC return type inference.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.rel.RelNode">Nested classes/interfaces inherited from interface org.apache.calcite.rel.<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h2> |
| <code><a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected final <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#aggCalls" class="member-name-link">aggCalls</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#groupSet" class="member-name-link">groupSet</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final com.google.common.collect.ImmutableList<<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#groupSets" class="member-name-link">groupSets</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#hints" class="member-name-link">hints</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#indicator" class="member-name-link">indicator</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final com.google.common.base.Predicate<<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#IS_NOT_GRAND_TOTAL" class="member-name-link">IS_NOT_GRAND_TOTAL</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color"><code>static final com.google.common.base.Predicate<<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#IS_SIMPLE" class="member-name-link">IS_SIMPLE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final com.google.common.base.Predicate<<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#NO_INDICATOR" class="member-name-link">NO_INDICATOR</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.SingleRel">Fields inherited from class org.apache.calcite.rel.<a href="../SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></h3> |
| <code><a href="../SingleRel.html#input">input</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.AbstractRelNode">Fields inherited from class org.apache.calcite.rel.<a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <code><a href="../AbstractRelNode.html#digest">digest</a>, <a href="../AbstractRelNode.html#id">id</a>, <a href="../AbstractRelNode.html#rowType">rowType</a>, <a href="../AbstractRelNode.html#traitSet">traitSet</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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,java.util.List,org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)" class="member-name-link">Aggregate</a><wbr>(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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><<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>> hints, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| @Nullable <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates an Aggregate.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,boolean,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)" class="member-name-link">Aggregate</a><wbr>(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traits, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> child, |
| boolean indicator, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)" class="member-name-link">Aggregate</a><wbr>(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.RelInput)" class="member-name-link">Aggregate</a><wbr>(<a href="../RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a> input)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates an Aggregate by parsing serialized output.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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><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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkIndicator(boolean)" class="member-name-link">checkIndicator</a><wbr>(boolean indicator)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Used internally; will removed when <a href="#indicator"><code>indicator</code></a> is removed, |
| before 2.0.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">computeSelfCost</a><wbr>(<a href="../../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</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 cost of this plan (not including children).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#containsDistinctCall()" class="member-name-link">containsDistinctCall</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether any of the aggregates are DISTINCT.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)" class="member-name-link">copy</a><wbr>(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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><<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,boolean,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)" class="member-name-link">copy</a><wbr>(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| boolean indicator, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)" class="member-name-link">copy</a><wbr>(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| @Nullable <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a copy of this aggregate.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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="#deriveRowType()" class="member-name-link">deriveRowType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deriveRowType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rel.type.RelDataType,boolean,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)" class="member-name-link">deriveRowType</a><wbr>(<a href="../type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> inputRowType, |
| boolean indicator, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| @Nullable <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Computes the row type of an <code>Aggregate</code> before it exists.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)" class="member-name-link">estimateRowCount</a><wbr>(<a href="../metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an estimate of the number of rows this relational expression will |
| return.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#explainTerms(org.apache.calcite.rel.RelWriter)" class="member-name-link">explainTerms</a><wbr>(<a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Describes the inputs and attributes of this relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAggCallList()" class="member-name-link">getAggCallList</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a list of calls to aggregate functions.</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="#getGroupCount()" class="member-name-link">getGroupCount</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 grouping fields.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGroupSet()" class="member-name-link">getGroupSet</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a bit set of the grouping fields.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.common.collect.ImmutableList<<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGroupSets()" class="member-name-link">getGroupSets</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 list of grouping sets computed by this Aggregate.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Aggregate.Group.html" title="enum in org.apache.calcite.rel.core">Aggregate.Group</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGroupType()" class="member-name-link">getGroupType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the type of roll-up.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHints()" class="member-name-link">getHints</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 hints of this relational expressions as an immutable list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getIndicatorCount()" class="member-name-link">getIndicatorCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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><<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNamedAggCalls()" class="member-name-link">getNamedAggCalls</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 a list of calls to aggregate functions together with their output |
| field names.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isNotGrandTotal(org.apache.calcite.rel.core.Aggregate)" class="member-name-link">isNotGrandTotal</a><wbr>(<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a> aggregate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isSimple(org.apache.calcite.rel.core.Aggregate)" class="member-name-link">isSimple</a><wbr>(<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a> aggregate)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)" class="member-name-link">isValid</a><wbr>(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| @Nullable <a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this relational expression is valid.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#noIndicator(org.apache.calcite.rel.core.Aggregate)" class="member-name-link">noIndicator</a><wbr>(<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a> aggregate)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.SingleRel">Methods inherited from class org.apache.calcite.rel.<a href="../SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></h3> |
| <code><a href="../SingleRel.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../SingleRel.html#getInput()">getInput</a>, <a href="../SingleRel.html#getInputs()">getInputs</a>, <a href="../SingleRel.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.AbstractRelNode">Methods inherited from class org.apache.calcite.rel.<a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3> |
| <code><a href="../AbstractRelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../AbstractRelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../AbstractRelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="../AbstractRelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="../AbstractRelNode.html#deepEquals(java.lang.Object)">deepEquals</a>, <a href="../AbstractRelNode.html#deepHashCode()">deepHashCode</a>, <a href="../AbstractRelNode.html#equals(java.lang.Object)">equals</a>, <a href="../AbstractRelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="../AbstractRelNode.html#getCluster()">getCluster</a>, <a href="../AbstractRelNode.html#getConvention()">getConvention</a>, <a href="../AbstractRelNode.html#getCorrelVariable()">getCorrelVariable</a>, <a href="../AbstractRelNode.html#getDescription()">getDescription</a>, <a href="../AbstractRelNode.html#getDigest()">getDigest</a>, <a href="../AbstractRelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../AbstractRelNode.html#getId()">getId</a>, <a href="../AbstractRelNode.html#getInput(int)">getInput</a>, <a href="../AbstractRelNode.html#getRelDigest()">getRelDigest</a>, <a href="../AbstractRelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../AbstractRelNode.html#getRowType()">getRowType</a>, <a href="../AbstractRelNode.html#getTable()">getTable</a>, <a href="../AbstractRelNode.html#getTraitSet()">getTraitSet</a>, <a href="../AbstractRelNode.html#getVariablesSet()">getVariablesSet</a>, <a href="../AbstractRelNode.html#hashCode()">hashCode</a>, <a href="../AbstractRelNode.html#isEnforcer()">isEnforcer</a>, <a href="../AbstractRelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../AbstractRelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../AbstractRelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../AbstractRelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../AbstractRelNode.html#sole(java.util.List)">sole</a>, <a href="../AbstractRelNode.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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#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#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#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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.hint.Hintable">Methods inherited from interface org.apache.calcite.rel.hint.<a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></h3> |
| <code><a href="../hint/Hintable.html#attachHints(java.util.List)">attachHints</a>, <a href="../hint/Hintable.html#withHints(java.util.List)">withHints</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelNode">Methods inherited from interface org.apache.calcite.rel.<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3> |
| <code><a href="../RelNode.html#explain()">explain</a>, <a href="../RelNode.html#fieldIsNullable(int)">fieldIsNullable</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="hints"> |
| <h3>hints</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></span> <span class="element-name">hints</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="IS_SIMPLE"> |
| <h3>IS_SIMPLE</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="return-type">com.google.common.base.Predicate<<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>></span> <span class="element-name">IS_SIMPLE</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NO_INDICATOR"> |
| <h3>NO_INDICATOR</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="return-type">com.google.common.base.Predicate<<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>></span> <span class="element-name">NO_INDICATOR</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="IS_NOT_GRAND_TOTAL"> |
| <h3>IS_NOT_GRAND_TOTAL</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="return-type">com.google.common.base.Predicate<<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a>></span> <span class="element-name">IS_NOT_GRAND_TOTAL</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="indicator"> |
| <h3>indicator</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">indicator</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.rel.core.Aggregate.indicator">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aggCalls"> |
| <h3>aggCalls</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>></span> <span class="element-name">aggCalls</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="groupSet"> |
| <h3>groupSet</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">groupSet</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="groupSets"> |
| <h3>groupSets</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="element-name">groupSets</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,java.util.List,org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)"> |
| <h3>Aggregate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Aggregate</span><wbr><span class="parameters">(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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><<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>> hints, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| @Nullable <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</span></div> |
| <div class="block">Creates an Aggregate. |
| |
| <p>All members of <code>groupSets</code> must be sub-sets of <code>groupSet</code>. |
| For a simple <code>GROUP BY</code>, <code>groupSets</code> is a singleton list |
| containing <code>groupSet</code>. |
| |
| <p>It is allowed for <code>groupSet</code> to contain bits that are not in any |
| of the <code>groupSets</code>, even this does not correspond to valid SQL. See |
| discussion in |
| <a href="../../tools/RelBuilder.html#groupKey(org.apache.calcite.util.ImmutableBitSet,java.lang.Iterable)"><code>RelBuilder.groupKey(ImmutableBitSet, Iterable)</code></a>. |
| |
| <p>If <code>GROUP BY</code> is not specified, |
| or equivalently if <code>GROUP BY ()</code> is specified, |
| <code>groupSet</code> will be the empty set, |
| and <code>groupSets</code> will have one element, that empty set. |
| |
| <p>If <code>CUBE</code>, <code>ROLLUP</code> or <code>GROUPING SETS</code> are |
| specified, <code>groupSets</code> will have additional elements, |
| but they must each be a subset of <code>groupSet</code>, |
| and they must be sorted by inclusion: |
| <code>(0, 1, 2), (1), (0, 2), (0), ()</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cluster</code> - Cluster</dd> |
| <dd><code>traitSet</code> - Trait set</dd> |
| <dd><code>hints</code> - Hints of this relational expression</dd> |
| <dd><code>input</code> - Input relational expression</dd> |
| <dd><code>groupSet</code> - Bit set of grouping fields</dd> |
| <dd><code>groupSets</code> - List of all grouping sets; null for just <code>groupSet</code></dd> |
| <dd><code>aggCalls</code> - Collection of calls to aggregate functions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)"> |
| <h3>Aggregate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">Aggregate</span><wbr><span class="parameters">(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,boolean,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)"> |
| <h3>Aggregate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="element-name">Aggregate</span><wbr><span class="parameters">(<a href="../../plan/RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a> cluster, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traits, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> child, |
| boolean indicator, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.rel.RelInput)"> |
| <h3>Aggregate</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Aggregate</span><wbr><span class="parameters">(<a href="../RelInput.html" title="interface in org.apache.calcite.rel">RelInput</a> input)</span></div> |
| <div class="block">Creates an Aggregate by parsing serialized output.</div> |
| </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="isSimple(org.apache.calcite.rel.core.Aggregate)"> |
| <h3>isSimple</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isSimple</span><wbr><span class="parameters">(<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a> aggregate)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkIndicator(boolean)"> |
| <h3>checkIndicator</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">checkIndicator</span><wbr><span class="parameters">(boolean indicator)</span></div> |
| <div class="block">Used internally; will removed when <a href="#indicator"><code>indicator</code></a> is removed, |
| before 2.0.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNotGrandTotal(org.apache.calcite.rel.core.Aggregate)"> |
| <h3>isNotGrandTotal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isNotGrandTotal</span><wbr><span class="parameters">(<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a> aggregate)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="noIndicator(org.apache.calcite.rel.core.Aggregate)"> |
| <h3>noIndicator</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">noIndicator</span><wbr><span class="parameters">(<a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a> aggregate)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <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><<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">RelNode</a></code></span></div> |
| <div class="block">Creates a copy of this relational expression, perhaps changing traits and |
| inputs. |
| |
| <p>Sub-classes with other important attributes are encouraged to create |
| variants of this method with more parameters.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>traitSet</code> - Trait set</dd> |
| <dd><code>inputs</code> - Inputs</dd> |
| <dt>Returns:</dt> |
| <dd>Copy of this relational expression, substituting traits and |
| inputs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| @Nullable <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</span></div> |
| <div class="block">Creates a copy of this aggregate.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>traitSet</code> - Traits</dd> |
| <dd><code>input</code> - Input</dd> |
| <dd><code>groupSet</code> - Bit set of grouping fields</dd> |
| <dd><code>groupSets</code> - List of all grouping sets; null for just <code>groupSet</code></dd> |
| <dd><code>aggCalls</code> - Collection of calls to aggregate functions</dd> |
| <dt>Returns:</dt> |
| <dd>New <code>Aggregate</code> if any parameter differs from the value of |
| this <code>Aggregate</code>, or just <code>this</code> if all the parameters are |
| the same</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)"><code>copy(org.apache.calcite.plan.RelTraitSet, java.util.List)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,boolean,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></span> <span class="element-name">copy</span><wbr><span class="parameters">(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> traitSet, |
| <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| boolean indicator, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAggCallList()"> |
| <h3>getAggCallList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>></span> <span class="element-name">getAggCallList</span>()</div> |
| <div class="block">Returns a list of calls to aggregate functions.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>list of calls to aggregate functions</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNamedAggCalls()"> |
| <h3>getNamedAggCalls</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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><<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></span> <span class="element-name">getNamedAggCalls</span>()</div> |
| <div class="block">Returns a list of calls to aggregate functions together with their output |
| field names.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>list of calls to aggregate functions and their output field names</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGroupCount()"> |
| <h3>getGroupCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getGroupCount</span>()</div> |
| <div class="block">Returns the number of grouping fields. |
| These grouping fields are the leading fields in both the input and output |
| records. |
| |
| <p>NOTE: The <a href="#getGroupSet()"><code>getGroupSet()</code></a> data structure allows for the |
| grouping fields to not be on the leading edge. New code should, if |
| possible, assume that grouping fields are in arbitrary positions in the |
| input relational expression.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of grouping fields</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIndicatorCount()"> |
| <h3>getIndicatorCount</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getIndicatorCount</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Returns the number of indicator fields. |
| |
| <p>Always zero.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of indicator fields, always zero</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGroupSet()"> |
| <h3>getGroupSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getGroupSet</span>()</div> |
| <div class="block">Returns a bit set of the grouping fields.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>bit set of ordinals of grouping fields</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGroupSets()"> |
| <h3>getGroupSets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="element-name">getGroupSets</span>()</div> |
| <div class="block">Returns the list of grouping sets computed by this Aggregate.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>List of all grouping sets</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="explainTerms(org.apache.calcite.rel.RelWriter)"> |
| <h3>explainTerms</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a></span> <span class="element-name">explainTerms</span><wbr><span class="parameters">(<a href="../RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a> pw)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../AbstractRelNode.html#explainTerms(org.apache.calcite.rel.RelWriter)">AbstractRelNode</a></code></span></div> |
| <div class="block">Describes the inputs and attributes of this relational expression. |
| Each node should call <code>super.explainTerms</code>, then call the |
| <a href="../RelWriter.html#input(java.lang.String,org.apache.calcite.rel.RelNode)"><code>RelWriter.input(String, RelNode)</code></a> |
| and |
| <a href="../RelWriter.html#item(java.lang.String,java.lang.Object)"><code>RelWriter.item(String, Object)</code></a> |
| methods for each input and attribute.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../SingleRel.html#explainTerms(org.apache.calcite.rel.RelWriter)">explainTerms</a></code> in class <code><a href="../SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>pw</code> - Plan writer</dd> |
| <dt>Returns:</dt> |
| <dd>Plan writer for fluent-explain pattern</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>estimateRowCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">estimateRowCount</span><wbr><span class="parameters">(<a href="../metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns an estimate of the number of rows this relational expression will |
| return. |
| |
| <p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use |
| <a href="../metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a chance to |
| override the rel's default ideas about row count.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../SingleRel.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code> in class <code><a href="../SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Estimate of the number of rows this relational expression will |
| return</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)"> |
| <h3>computeSelfCost</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../plan/RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span> <span class="element-name">computeSelfCost</span><wbr><span class="parameters">(<a href="../../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a> mq)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div> |
| <div class="block">Returns the cost of this plan (not including children). The base |
| implementation throws an error; derived classes should override. |
| |
| <p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use |
| <a href="../metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a |
| chance to override the rel's default ideas about cost.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>planner</code> - Planner for cost calculation</dd> |
| <dd><code>mq</code> - Metadata query</dd> |
| <dt>Returns:</dt> |
| <dd>Cost of this plan (not including children)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveRowType()"> |
| <h3>deriveRowType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">deriveRowType</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../SingleRel.html#deriveRowType()">deriveRowType</a></code> in class <code><a href="../SingleRel.html" title="class in org.apache.calcite.rel">SingleRel</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deriveRowType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rel.type.RelDataType,boolean,org.apache.calcite.util.ImmutableBitSet,java.util.List,java.util.List)"> |
| <h3>deriveRowType</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">deriveRowType</span><wbr><span class="parameters">(<a href="../type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> inputRowType, |
| boolean indicator, |
| <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> groupSet, |
| @Nullable <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><<a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> groupSets, |
| <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><<a href="AggregateCall.html" title="class in org.apache.calcite.rel.core">AggregateCall</a>> aggCalls)</span></div> |
| <div class="block">Computes the row type of an <code>Aggregate</code> before it exists.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>typeFactory</code> - Type factory</dd> |
| <dd><code>inputRowType</code> - Input row type</dd> |
| <dd><code>indicator</code> - Deprecated, always false</dd> |
| <dd><code>groupSet</code> - Bit set of grouping fields</dd> |
| <dd><code>groupSets</code> - List of all grouping sets; null for just <code>groupSet</code></dd> |
| <dd><code>aggCalls</code> - Collection of calls to aggregate functions</dd> |
| <dt>Returns:</dt> |
| <dd>Row type of the aggregate</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(<a href="../../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus, |
| @Nullable <a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a> context)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">RelNode</a></code></span></div> |
| <div class="block">Returns whether this relational expression is valid. |
| |
| <p>If assertions are enabled, this method is typically called with <code> |
| litmus</code> = <code>THROW</code>, as follows: |
| |
| <blockquote> |
| <pre>assert rel.isValid(Litmus.THROW)</pre> |
| </blockquote> |
| |
| <p>This signals that the method can throw an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link"><code>AssertionError</code></a> if it |
| is not valid.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></code> in interface <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../AbstractRelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>litmus</code> - What to do if invalid</dd> |
| <dd><code>context</code> - Context for validity checking</dd> |
| <dt>Returns:</dt> |
| <dd>Whether relational expression is valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsDistinctCall()"> |
| <h3>containsDistinctCall</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsDistinctCall</span>()</div> |
| <div class="block">Returns whether any of the aggregates are DISTINCT.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Whether any of the aggregates are DISTINCT</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHints()"> |
| <h3>getHints</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.common.collect.ImmutableList<<a href="../hint/RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>></span> <span class="element-name">getHints</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../hint/Hintable.html#getHints()">Hintable</a></code></span></div> |
| <div class="block">Returns the hints of this relational expressions as an immutable list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../hint/Hintable.html#getHints()">getHints</a></code> in interface <code><a href="../hint/Hintable.html" title="interface in org.apache.calcite.rel.hint">Hintable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGroupType()"> |
| <h3>getGroupType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Aggregate.Group.html" title="enum in org.apache.calcite.rel.core">Aggregate.Group</a></span> <span class="element-name">getGroupType</span>()</div> |
| <div class="block">Returns the type of roll-up.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Type of roll-up</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> |
