| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Sort (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: Sort"> |
| <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 Sort" class="title">Class Sort</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.Sort</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.BindableSort.html" title="class in org.apache.calcite.interpreter">Bindables.BindableSort</a></code>, <code><a href="../../adapter/cassandra/CassandraSort.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSort</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchSort.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSort</a></code>, <code><a href="../../adapter/enumerable/EnumerableLimitSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableLimitSort</a></code>, <code><a href="../../adapter/enumerable/EnumerableSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSort</a></code>, <code><a href="../../adapter/geode/rel/GeodeSort.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeSort</a></code>, <code><a href="../../adapter/innodb/InnodbSort.html" title="class in org.apache.calcite.adapter.innodb">InnodbSort</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcSort.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcSort</a></code>, <code><a href="../logical/LogicalSort.html" title="class in org.apache.calcite.rel.logical">LogicalSort</a></code>, <code><a href="../../adapter/mongodb/MongoSort.html" title="class in org.apache.calcite.adapter.mongodb">MongoSort</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Sort</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 expression that imposes a particular sort order on its input |
| without otherwise changing its content.</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.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>final <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#collation" class="member-name-link">collation</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#fetch" class="member-name-link">fetch</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-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 even-row-color"><code><a href="#hints" class="member-name-link">hints</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div> |
| <div class="col-last odd-row-color"> </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.rel.RelCollation,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)" class="member-name-link">Sort</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="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> child, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> offset, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> fetch)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a Sort.</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,org.apache.calcite.rel.RelCollation)" class="member-name-link">Sort</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, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a Sort.</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.rel.RelCollation,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)" class="member-name-link">Sort</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, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> offset, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> fetch)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a Sort.</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">Sort</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 a Sort 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-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></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#accept(org.apache.calcite.rex.RexShuttle)" class="member-name-link">accept</a><wbr>(<a href="../../rex/RexShuttle.html" title="class in org.apache.calcite.rex">RexShuttle</a> shuttle)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Accepts a visit from a shuttle.</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>final <a href="Sort.html" title="class in org.apache.calcite.rel.core">Sort</a></code></div> |
| <div class="col-second even-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 even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="Sort.html" title="class in org.apache.calcite.rel.core">Sort</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,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelCollation)" 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> newInput, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> newCollation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Sort.html" title="class in org.apache.calcite.rel.core">Sort</a></code></div> |
| <div class="col-second even-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.rel.RelCollation,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)" 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> newInput, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> newCollation, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> offset, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> fetch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCollation()" class="member-name-link">getCollation</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 array of <a href="../RelFieldCollation.html" title="class in org.apache.calcite.rel"><code>RelFieldCollation</code></a>s asked for by the sort |
| specification, from most significant to least significant.</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"><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="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSortExps()" class="member-name-link">getSortExps</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 sort expressions.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEnforcer()" class="member-name-link">isEnforcer</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Indicates whether it is an enforcer operator, e.g.</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#deriveRowType()">deriveRowType</a>, <a href="../SingleRel.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</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#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#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</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="collation"> |
| <h3>collation</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">collation</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="offset"> |
| <h3>offset</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">offset</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fetch"> |
| <h3>fetch</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">fetch</span></div> |
| </section> |
| </li> |
| <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> |
| </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.rel.RelCollation,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)"> |
| <h3>Sort</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Sort</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="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> child, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> offset, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> fetch)</span></div> |
| <div class="block">Creates a Sort.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cluster</code> - Cluster this relational expression belongs to</dd> |
| <dd><code>traits</code> - Traits</dd> |
| <dd><code>hints</code> - Hints for this node</dd> |
| <dd><code>child</code> - input relational expression</dd> |
| <dd><code>collation</code> - array of sort specifications</dd> |
| <dd><code>offset</code> - Expression for number of rows to discard before returning |
| first row</dd> |
| <dd><code>fetch</code> - Expression for number of rows to fetch</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.rel.RelCollation)"> |
| <h3>Sort</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Sort</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, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</span></div> |
| <div class="block">Creates a Sort.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cluster</code> - Cluster this relational expression belongs to</dd> |
| <dd><code>traits</code> - Traits</dd> |
| <dd><code>child</code> - input relational expression</dd> |
| <dd><code>collation</code> - array of sort specifications</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.rel.RelCollation,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)"> |
| <h3>Sort</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Sort</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, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> offset, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> fetch)</span></div> |
| <div class="block">Creates a Sort.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cluster</code> - Cluster this relational expression belongs to</dd> |
| <dd><code>traits</code> - Traits</dd> |
| <dd><code>child</code> - input relational expression</dd> |
| <dd><code>collation</code> - array of sort specifications</dd> |
| <dd><code>offset</code> - Expression for number of rows to discard before returning |
| first row</dd> |
| <dd><code>fetch</code> - Expression for number of rows to fetch</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.rel.RelInput)"> |
| <h3>Sort</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Sort</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 a Sort 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="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="Sort.html" title="class in org.apache.calcite.rel.core">Sort</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.rel.RelCollation)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="Sort.html" title="class in org.apache.calcite.rel.core">Sort</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> newInput, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> newCollation)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="copy(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelCollation,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="Sort.html" title="class in org.apache.calcite.rel.core">Sort</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> newInput, |
| <a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> newCollation, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> offset, |
| @Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> fetch)</span></div> |
| </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">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. |
| |
| <p>The CPU cost of a Sort has three main cases: |
| |
| <ul> |
| <li>If <code>fetch</code> is zero, CPU cost is zero; otherwise, |
| |
| <li>if the sort keys are empty, we don't need to sort, only step over |
| the rows, and therefore the CPU cost is |
| <code>min(fetch + offset, inputRowCount) * bytesPerRow</code>; otherwise |
| |
| <li>we need to read and sort <code>inputRowCount</code> rows, with at most |
| <code>min(fetch + offset, inputRowCount)</code> of them in the sort data |
| structure at a time, giving a CPU cost of <code>inputRowCount * |
| log(min(fetch + offset, inputRowCount)) * bytesPerRow</code>. |
| </ul> |
| |
| <p>The cost model factors in row width via <code>bytesPerRow</code>, because |
| sorts need to move rows around, not just compare them; by making the cost |
| higher if rows are wider, we discourage pushing a Project through a Sort. |
| We assume that each field is 4 bytes, and we add 3 'virtual fields' to |
| represent the per-row overhead. Thus a 1-field row is (3 + 1) * 4 = 16 |
| bytes; a 5-field row is (3 + 5) * 4 = 32 bytes. |
| |
| <p>The cost model does not consider a 5-field sort to be more expensive |
| than, say, a 2-field sort, because both sorts will compare just one field |
| most of the time.</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="accept(org.apache.calcite.rex.RexShuttle)"> |
| <h3>accept</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">accept</span><wbr><span class="parameters">(<a href="../../rex/RexShuttle.html" title="class in org.apache.calcite.rex">RexShuttle</a> shuttle)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">RelNode</a></code></span></div> |
| <div class="block">Accepts a visit from a shuttle. If the shuttle updates expression, then |
| a copy of the relation should be created. This new relation might have |
| a different row-type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</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#accept(org.apache.calcite.rex.RexShuttle)">accept</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>shuttle</code> - Shuttle</dd> |
| <dt>Returns:</dt> |
| <dd>A copy of this node incorporating changes made by the shuttle to |
| this node's children</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEnforcer()"> |
| <h3>isEnforcer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isEnforcer</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../RelNode.html#isEnforcer()">RelNode</a></code></span></div> |
| <div class="block">Indicates whether it is an enforcer operator, e.g. PhysicalSort, |
| PhysicalHashDistribute, etc. As an enforcer, the operator must be |
| created only when required traitSet is not satisfied by its input.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../RelNode.html#isEnforcer()">isEnforcer</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#isEnforcer()">isEnforcer</a></code> in class <code><a href="../AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Whether it is an enforcer operator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCollation()"> |
| <h3>getCollation</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">getCollation</span>()</div> |
| <div class="block">Returns the array of <a href="../RelFieldCollation.html" title="class in org.apache.calcite.rel"><code>RelFieldCollation</code></a>s asked for by the sort |
| specification, from most significant to least significant. |
| |
| <p>See also <a href="../metadata/RelMetadataQuery.html#collations(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.collations(RelNode)</code></a>, |
| which lists all known collations. For example, |
| <code>ORDER BY time_id</code> might also be sorted by |
| <code>the_year, the_month</code> because of a known monotonicity |
| constraint among the columns. <code>getCollation</code> would return |
| <code>[time_id]</code> and <code>collations</code> would return |
| <code>[ [time_id], [the_year, the_month] ]</code>.</p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSortExps()"> |
| <h3>getSortExps</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="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></span> <span class="element-name">getSortExps</span>()</div> |
| <div class="block">Returns the sort expressions.</div> |
| </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="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> |
| </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> |