| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Convention (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.plan, interface: Convention"> |
| <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>Constr | </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>Constr | </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.plan</a></div> |
| <h1 title="Interface Convention" class="title">Interface Convention</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../interpreter/BindableConvention.html" title="enum in org.apache.calcite.interpreter">BindableConvention</a></code>, <code><a href="Convention.Impl.html" title="class in org.apache.calcite.plan">Convention.Impl</a></code>, <code><a href="../adapter/enumerable/EnumerableConvention.html" title="enum in org.apache.calcite.adapter.enumerable">EnumerableConvention</a></code>, <code><a href="../interpreter/InterpretableConvention.html" title="enum in org.apache.calcite.interpreter">InterpretableConvention</a></code>, <code><a href="../adapter/jdbc/JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc">JdbcConvention</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Convention</span><span class="extends-implements"> |
| extends <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></span></div> |
| <div class="block">Calling convention trait.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="Convention.Impl.html" class="type-name-link" title="class in org.apache.calcite.plan">Convention.Impl</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default implementation.</div> |
| </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 <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#NONE" class="member-name-link">NONE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Convention that for a relational expression that does not support any |
| convention.</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-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#canConvertConvention(org.apache.calcite.plan.Convention)" class="member-name-link">canConvertConvention</a><wbr>(<a href="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-tab5"> |
| <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-tab5"><code>default @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-tab5"><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="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-tab5"> |
| <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-tab3"><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-tab3"><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-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <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-tab5"><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-tab5"> |
| <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-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)" class="member-name-link">useAbstractConvertersForConversion</a><wbr>(<a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> fromTraits, |
| <a href="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-tab5"> |
| <div class="block">Returns whether we should convert from this trait set to the other trait |
| set.</div> |
| </div> |
| </div> |
| </div> |
| </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="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></h3> |
| <code><a href="RelTrait.html#apply(org.apache.calcite.util.mapping.Mappings.TargetMapping)">apply</a>, <a href="RelTrait.html#equals(java.lang.Object)">equals</a>, <a href="RelTrait.html#getTraitDef()">getTraitDef</a>, <a href="RelTrait.html#hashCode()">hashCode</a>, <a href="RelTrait.html#isDefault()">isDefault</a>, <a href="RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a>, <a href="RelTrait.html#toString()">toString</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="NONE"> |
| <h3>NONE</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span> <span class="element-name">NONE</span></div> |
| <div class="block">Convention that for a relational expression that does not support any |
| convention. It is not implementable, and has to be transformed to |
| something else in order to be implemented. |
| |
| <p>Relational expressions generally start off in this form.</p> |
| |
| <p>Such expressions always have infinite cost.</p></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="getInterface()"> |
| <h3>getInterface</h3> |
| <div class="member-signature"><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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><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> |
| </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">default</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="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> required)</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>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="canConvertConvention(org.apache.calcite.plan.Convention)"> |
| <h3>canConvertConvention</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">canConvertConvention</span><wbr><span class="parameters">(<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention)</span></div> |
| <div class="block">Returns whether we should convert from this convention to |
| <code>toConvention</code>. Used by <a href="ConventionTraitDef.html" title="class in org.apache.calcite.plan"><code>ConventionTraitDef</code></a>.</div> |
| <dl class="notes"> |
| <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">default</span> <span class="return-type">boolean</span> <span class="element-name">useAbstractConvertersForConversion</span><wbr><span class="parameters">(<a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> fromTraits, |
| <a href="RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> toTraits)</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>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">default</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">Return RelFactories struct for this convention. It can can be used to |
| build RelNode.</div> |
| </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> |
