| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>EnumerableConvention (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.adapter.enumerable, enum: EnumerableConvention"> |
| <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="#enum-constant-summary">Enum Constants</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum-constant-detail">Enum Constants</a> | </li> |
| <li><a href="#field-detail">Field</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.adapter.enumerable</a></div> |
| <h1 title="Enum EnumerableConvention" class="title">Enum EnumerableConvention</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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a>> |
| <div class="inheritance">org.apache.calcite.adapter.enumerable.EnumerableConvention</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/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code>, <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code>, <code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">EnumerableConvention</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a>> |
| implements <a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span></div> |
| <div class="block">Family of calling conventions that return results as an |
| <a href="../../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</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-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.plan.Convention">Nested classes/interfaces inherited from interface org.apache.calcite.plan.<a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></h2> |
| <code><a href="../../plan/Convention.Impl.html" title="class in org.apache.calcite.plan">Convention.Impl</a></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#INSTANCE" class="member-name-link">INSTANCE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </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>static final double</code></div> |
| <div class="col-second even-row-color"><code><a href="#COST_MULTIPLIER" class="member-name-link">COST_MULTIPLIER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Cost of an enumerable node versus implementing an equivalent node in a |
| "typical" calling convention.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.plan.Convention">Fields inherited from interface org.apache.calcite.plan.<a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></h3> |
| <code><a href="../../plan/Convention.html#NONE">NONE</a></code></div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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-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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canConvertConvention(org.apache.calcite.plan.Convention)" class="member-name-link">canConvertConvention</a><wbr>(<a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention)</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 we should convert from this convention to |
| <code>toConvention</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../rel/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="#enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">enforce</a><wbr>(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Given an input and required traits, returns the corresponding |
| enforcer rel nodes, like physical Sort, Exchange etc.</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/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInterface()" class="member-name-link">getInterface</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-tab2 method-summary-table-tab4"><code><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="#getName()" class="member-name-link">getName</a>()</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-tab4"><code><a href="../../rel/core/RelFactories.Struct.html" title="class in org.apache.calcite.rel.core">RelFactories.Struct</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelFactories()" class="member-name-link">getRelFactories</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return RelFactories struct for this convention.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTraitDef()" class="member-name-link">getTraitDef</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 RelTraitDef that defines this RelTrait.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register(org.apache.calcite.plan.RelOptPlanner)" class="member-name-link">register</a><wbr>(<a href="../../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a trait instance with the planner.</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="#satisfies(org.apache.calcite.plan.RelTrait)" class="member-name-link">satisfies</a><wbr>(<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this trait satisfies a given trait.</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</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 succinct name for this trait.</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="#useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">useAbstractConvertersForConversion</a><wbr>(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> fromTraits, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether we should convert from this trait set to the other trait |
| set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.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/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.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/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</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#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.plan.RelTrait">Methods inherited from interface org.apache.calcite.plan.<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></h3> |
| <code><a href="../../plan/RelTrait.html#apply(org.apache.calcite.util.mapping.Mappings.TargetMapping)">apply</a>, <a href="../../plan/RelTrait.html#equals(java.lang.Object)">equals</a>, <a href="../../plan/RelTrait.html#hashCode()">hashCode</a>, <a href="../../plan/RelTrait.html#isDefault()">isDefault</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="INSTANCE"> |
| <h3>INSTANCE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a></span> <span class="element-name">INSTANCE</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="COST_MULTIPLIER"> |
| <h3>COST_MULTIPLIER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">COST_MULTIPLIER</span></div> |
| <div class="block">Cost of an enumerable node versus implementing an equivalent node in a |
| "typical" calling convention.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.adapter.enumerable.EnumerableConvention.COST_MULTIPLIER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<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> name)</span></div> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/RelTrait.html#toString()">RelTrait</a></code></span></div> |
| <div class="block">Returns a succinct name for this trait. The planner may use this String |
| to describe the trait.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/RelTrait.html#toString()">toString</a></code> in interface <code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInterface()"> |
| <h3>getInterface</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/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a></span> <span class="element-name">getInterface</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/Convention.html#getInterface()">getInterface</a></code> in interface <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/Convention.html#getName()">getName</a></code> in interface <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)"> |
| <h3>enforce</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">enforce</span><wbr><span class="parameters">(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> input, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/Convention.html#enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">Convention</a></code></span></div> |
| <div class="block">Given an input and required traits, returns the corresponding |
| enforcer rel nodes, like physical Sort, Exchange etc.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/Convention.html#enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">enforce</a></code> in interface <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>input</code> - The input RelNode</dd> |
| <dd><code>required</code> - The required traits</dd> |
| <dt>Returns:</dt> |
| <dd>Physical enforcer that satisfies the required traitSet, |
| or <code>null</code> if trait enforcement is not allowed or the |
| required traitSet can't be satisfied.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraitDef()"> |
| <h3>getTraitDef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></span> <span class="element-name">getTraitDef</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/RelTrait.html#getTraitDef()">RelTrait</a></code></span></div> |
| <div class="block">Returns the RelTraitDef that defines this RelTrait.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/RelTrait.html#getTraitDef()">getTraitDef</a></code> in interface <code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the RelTraitDef that defines this RelTrait</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="satisfies(org.apache.calcite.plan.RelTrait)"> |
| <h3>satisfies</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">satisfies</span><wbr><span class="parameters">(<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">RelTrait</a></code></span></div> |
| <div class="block">Returns whether this trait satisfies a given trait. |
| |
| <p>A trait satisfies another if it is the same or stricter. For example, |
| <code>ORDER BY x, y</code> satisfies <code>ORDER BY x</code>. |
| |
| <p>A trait's <code>satisfies</code> relation must be a partial order (reflexive, |
| anti-symmetric, transitive). Many traits cannot be "loosened"; their |
| <code>satisfies</code> is an equivalence relation, where only X satisfies X. |
| |
| <p>If a trait has multiple values |
| (see <code>RelCompositeTrait</code>) |
| a collection (T0, T1, ...) satisfies T if any Ti satisfies T.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a></code> in interface <code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>trait</code> - Given trait</dd> |
| <dt>Returns:</dt> |
| <dd>Whether this trait subsumes a given trait</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.calcite.plan.RelOptPlanner)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">RelTrait</a></code></span></div> |
| <div class="block">Registers a trait instance with the planner. |
| |
| <p>This is an opportunity to add rules that relate to that trait. However, |
| typical implementations will do nothing.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a></code> in interface <code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>planner</code> - Planner</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canConvertConvention(org.apache.calcite.plan.Convention)"> |
| <h3>canConvertConvention</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">canConvertConvention</span><wbr><span class="parameters">(<a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/Convention.html#canConvertConvention(org.apache.calcite.plan.Convention)">Convention</a></code></span></div> |
| <div class="block">Returns whether we should convert from this convention to |
| <code>toConvention</code>. Used by <a href="../../plan/ConventionTraitDef.html" title="class in org.apache.calcite.plan"><code>ConventionTraitDef</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/Convention.html#canConvertConvention(org.apache.calcite.plan.Convention)">canConvertConvention</a></code> in interface <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>toConvention</code> - Desired convention to convert to</dd> |
| <dt>Returns:</dt> |
| <dd>Whether we should convert from this convention to toConvention</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)"> |
| <h3>useAbstractConvertersForConversion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">useAbstractConvertersForConversion</span><wbr><span class="parameters">(<a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> fromTraits, |
| <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/Convention.html#useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)">Convention</a></code></span></div> |
| <div class="block">Returns whether we should convert from this trait set to the other trait |
| set. |
| |
| <p>The convention decides whether it wants to handle other trait |
| conversions, e.g. collation, distribution, etc. For a given convention, we |
| will only add abstract converters to handle the trait (convention, |
| collation, distribution, etc.) conversions if this function returns true.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/Convention.html#useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)">useAbstractConvertersForConversion</a></code> in interface <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>fromTraits</code> - Traits of the RelNode that we are converting from</dd> |
| <dd><code>toTraits</code> - Target traits</dd> |
| <dt>Returns:</dt> |
| <dd>Whether we should add converters</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRelFactories()"> |
| <h3>getRelFactories</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/core/RelFactories.Struct.html" title="class in org.apache.calcite.rel.core">RelFactories.Struct</a></span> <span class="element-name">getRelFactories</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../plan/Convention.html#getRelFactories()">Convention</a></code></span></div> |
| <div class="block">Return RelFactories struct for this convention. It can can be used to |
| build RelNode.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../plan/Convention.html#getRelFactories()">getRelFactories</a></code> in interface <code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</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> |
