| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Convention (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":18,"i5":18}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.plan</a></div> |
| <h1 title="Interface Convention" class="title">Interface Convention</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| </dl> |
| <dl> |
| <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> |
| <pre>public interface <span class="typeNameLabel">Convention</span> |
| extends <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></pre> |
| <div class="block">Calling convention trait.</div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Convention.Impl.html" title="class in org.apache.calcite.plan">Convention.Impl</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Default implementation.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NONE">NONE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Convention that for a relational expression that does not support any |
| convention.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="tableTab" onclick="show(16);">Default Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canConvertConvention(org.apache.calcite.plan.Convention)">canConvertConvention</a></span>​(<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether we should convert from this convention to |
| <code>toConvention</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>default <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">enforce</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Given an input and required traits, returns the corresponding |
| enforcer rel nodes, like physical Sort, Exchange etc.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInterface()">getInterface</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>default <a href="../rel/core/RelFactories.Struct.html" title="class in org.apache.calcite.rel.core">RelFactories.Struct</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelFactories()">getRelFactories</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return RelFactories struct for this convention.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)">useAbstractConvertersForConversion</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Returns whether we should convert from this trait set to the other trait |
| set.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.plan.<a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.plan.RelTrait"> |
| <!-- --> |
| </a><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="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="NONE">NONE</a></h3> |
| <div class="memberSignature"><span class="modifiers">static final</span> <span class="returnType"><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span> <span class="memberName">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 class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getInterface()">getInterface</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a></span> <span class="memberName">getInterface</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getName()">getName</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getName</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">enforce</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="memberName">enforce</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - The input RelNode</dd> |
| <dd><code>required</code> - The required traits</dd> |
| <dt><span class="returnLabel">Returns:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="canConvertConvention(org.apache.calcite.plan.Convention)">canConvertConvention</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">boolean</span> <span class="memberName">canConvertConvention</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>toConvention</code> - Desired convention to convert to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether we should convert from this convention to toConvention</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)">useAbstractConvertersForConversion</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">boolean</span> <span class="memberName">useAbstractConvertersForConversion</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromTraits</code> - Traits of the RelNode that we are converting from</dd> |
| <dd><code>toTraits</code> - Target traits</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether we should add converters</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRelFactories()">getRelFactories</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="../rel/core/RelFactories.Struct.html" title="class in org.apache.calcite.rel.core">RelFactories.Struct</a></span> <span class="memberName">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> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |