| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Convention.Impl (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, class: Impl"> |
| <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":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class Convention.Impl" class="title">Class Convention.Impl</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.plan.Convention.Impl</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code>, <code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../adapter/jdbc/JdbcConvention.html" title="class in org.apache.calcite.adapter.jdbc">JdbcConvention</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></dd> |
| </dl> |
| <hr> |
| <pre>public static class <span class="typeNameLabel">Convention.Impl</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></pre> |
| <div class="block">Default implementation.</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="inheritedList"> |
| <h2>Nested classes/interfaces inherited from interface org.apache.calcite.plan.<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></h2> |
| <a id="nested.classes.inherited.from.class.org.apache.calcite.plan.Convention"> |
| <!-- --> |
| </a><code><a href="Convention.Impl.html" title="class in org.apache.calcite.plan">Convention.Impl</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="inheritedList"> |
| <h3>Fields inherited from interface org.apache.calcite.plan.<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></h3> |
| <a id="fields.inherited.from.class.org.apache.calcite.plan.Convention"> |
| <!-- --> |
| </a><code><a href="Convention.html#NONE">NONE</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.Class)">Impl</a></span>​(<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> name, |
| <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><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> relClass)</code></th> |
| <td class="colLast"> </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="t4" class="tableTab" onclick="show(8);">Concrete 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>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>@Nullable <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><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTraitDef()">getTraitDef</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the RelTraitDef that defines this RelTrait.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(org.apache.calcite.plan.RelOptPlanner)">register</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</code></th> |
| <td class="colLast"> |
| <div class="block">Registers a trait instance with the planner.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a></span>​(<a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this trait satisfies a given trait.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <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="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a succinct name for this trait.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>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 class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.apache.calcite.plan.<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.plan.Convention"> |
| <!-- --> |
| </a><code><a href="Convention.html#getRelFactories()">getRelFactories</a></code></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#hashCode()">hashCode</a>, <a href="RelTrait.html#isDefault()">isDefault</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(java.lang.String,java.lang.Class)">Impl</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">Impl</span>​(<span class="arguments"><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> name, |
| <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><? extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> relClass)</span></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="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <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">toString</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTrait.html#toString()">toString</a></code> in interface <code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="register(org.apache.calcite.plan.RelOptPlanner)">register</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">register</span>​(<span class="arguments"><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a></code> in interface <code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - Planner</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">satisfies</span>​(<span class="arguments"><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> trait)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a></code> in interface <code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trait</code> - Given trait</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether this trait subsumes a given trait</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getInterface()">getInterface</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Convention.html#getInterface()">getInterface</a></code> in interface <code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getName()">getName</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <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> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Convention.html#getName()">getName</a></code> in interface <code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getTraitDef()">getTraitDef</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></span> <span class="memberName">getTraitDef</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelTrait.html#getTraitDef()">RelTrait</a></code></span></div> |
| <div class="block">Returns the RelTraitDef that defines this RelTrait.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTrait.html#getTraitDef()">getTraitDef</a></code> in interface <code><a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the RelTraitDef that defines this RelTrait</dd> |
| </dl> |
| </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">public</span> <span class="returnType">@Nullable <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Convention.html#enforce(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">enforce</a></code> in interface <code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| <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">public</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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="ConventionTraitDef.html" title="class in org.apache.calcite.plan"><code>ConventionTraitDef</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Convention.html#canConvertConvention(org.apache.calcite.plan.Convention)">canConvertConvention</a></code> in interface <code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| <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">public</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Convention.html#useAbstractConvertersForConversion(org.apache.calcite.plan.RelTraitSet,org.apache.calcite.plan.RelTraitSet)">useAbstractConvertersForConversion</a></code> in interface <code><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></dd> |
| <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> |
| </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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
