| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ConventionTraitDef (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, class: ConventionTraitDef"> |
| <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}; |
| 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>Nested | </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="Class ConventionTraitDef" class="title">Class ConventionTraitDef</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"><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.RelTraitDef</a><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>> |
| <div class="inheritance">org.apache.calcite.plan.ConventionTraitDef</div> |
| </div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ConventionTraitDef</span> |
| extends <a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>></pre> |
| <div class="block">Definition of the convention trait. |
| A new set of conversion information is created for |
| each planner that registers at least one <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> instance. |
| |
| <p>Conversion data is held in a <code>LoadingCache</code> |
| with weak keys so that the JVM's garbage |
| collector may reclaim the conversion data after the planner itself has been |
| garbage collected. The conversion information consists of a graph of |
| conversions (from one calling convention to another) and a map of graph arcs |
| to <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a>s.</div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== 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="ConventionTraitDef.html" title="class in org.apache.calcite.plan">ConventionTraitDef</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INSTANCE">INSTANCE</a></span></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="#canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.plan.Convention,org.apache.calcite.plan.Convention)">canConvert</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> fromConvention, |
| <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention)</code></th> |
| <td class="colLast"> |
| <div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</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="#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.plan.Convention,boolean)">convert</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention, |
| boolean allowInfiniteCostConverters)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the given RelNode to the given RelTrait.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deregisterConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">deregisterConverterRule</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</code></th> |
| <td class="colLast"> |
| <div class="block">Provides notification that a particular <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> has been |
| de-registered from a <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><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="#getDefault()">getDefault</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default member of this trait.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <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="#getSimpleName()">getSimpleName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a simple name for this RelTraitDef (for use in |
| <a href="../rel/RelNode.html#explain(org.apache.calcite.rel.RelWriter)"><code>RelNode.explain(org.apache.calcite.rel.RelWriter)</code></a>).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <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><<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="#getTraitClass()">getTraitClass</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the specific RelTrait type associated with this RelTraitDef.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">registerConverterRule</a></span>​(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</code></th> |
| <td class="colLast"> |
| <div class="block">Provides notification of the registration of a particular |
| <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> with a <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class org.apache.calcite.plan.<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></h3> |
| <a id="methods.inherited.from.class.org.apache.calcite.plan.RelTraitDef"> |
| <!-- --> |
| </a><code><a href="RelTraitDef.html#canonize(T)">canonize</a>, <a href="RelTraitDef.html#multiple()">multiple</a></code></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#toString()" title="class or interface in java.lang" class="externalLink">toString</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> |
| </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="INSTANCE">INSTANCE</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="ConventionTraitDef.html" title="class in org.apache.calcite.plan">ConventionTraitDef</a></span> <span class="memberName">INSTANCE</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="getTraitClass()">getTraitClass</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><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>></span> <span class="memberName">getTraitClass</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="RelTraitDef.html#getTraitClass()">RelTraitDef</a></code></span></div> |
| <div class="block">Returns the specific RelTrait type associated with this RelTraitDef.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTraitDef.html#getTraitClass()">getTraitClass</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<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="getSimpleName()">getSimpleName</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">getSimpleName</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="RelTraitDef.html#getSimpleName()">RelTraitDef</a></code></span></div> |
| <div class="block">Returns a simple name for this RelTraitDef (for use in |
| <a href="../rel/RelNode.html#explain(org.apache.calcite.rel.RelWriter)"><code>RelNode.explain(org.apache.calcite.rel.RelWriter)</code></a>).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTraitDef.html#getSimpleName()">getSimpleName</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<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="getDefault()">getDefault</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a></span> <span class="memberName">getDefault</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="RelTraitDef.html#getDefault()">RelTraitDef</a></code></span></div> |
| <div class="block">Returns the default member of this trait.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTraitDef.html#getDefault()">getDefault</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<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="registerConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">registerConverterRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">registerConverterRule</span>​(<span class="arguments"><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="RelTraitDef.html#registerConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">RelTraitDef</a></code></span></div> |
| <div class="block">Provides notification of the registration of a particular |
| <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> with a <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>. The default |
| implementation does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="RelTraitDef.html#registerConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">registerConverterRule</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - the planner registering the rule</dd> |
| <dd><code>converterRule</code> - the registered converter rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="deregisterConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">deregisterConverterRule</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">deregisterConverterRule</span>​(<span class="arguments"><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="RelTraitDef.html#deregisterConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">RelTraitDef</a></code></span></div> |
| <div class="block">Provides notification that a particular <a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> has been |
| de-registered from a <a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>. The default implementation |
| does nothing.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="RelTraitDef.html#deregisterConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">deregisterConverterRule</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - the planner registering the rule</dd> |
| <dd><code>converterRule</code> - the registered converter rule</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.plan.Convention,boolean)">convert</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">convert</span>​(<span class="arguments"><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> toConvention, |
| boolean allowInfiniteCostConverters)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="RelTraitDef.html#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,T,boolean)">RelTraitDef</a></code></span></div> |
| <div class="block">Converts the given RelNode to the given RelTrait.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTraitDef.html#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,T,boolean)">convert</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - the planner requesting the conversion</dd> |
| <dd><code>rel</code> - RelNode to convert</dd> |
| <dd><code>toConvention</code> - RelTrait to convert to</dd> |
| <dd><code>allowInfiniteCostConverters</code> - flag indicating whether infinite cost |
| converters are allowed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a converted RelNode or null if conversion is not possible</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.plan.Convention,org.apache.calcite.plan.Convention)">canConvert</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">canConvert</span>​(<span class="arguments"><a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a> fromConvention, |
| <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 class: <code><a href="RelTraitDef.html#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)">RelTraitDef</a></code></span></div> |
| <div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelTraitDef.html#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)">canConvert</a></code> in class <code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a><<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - the planner requesting the conversion test</dd> |
| <dd><code>fromConvention</code> - the RelTrait to convert from</dd> |
| <dd><code>toConvention</code> - the RelTrait to convert to</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if fromTrait can be converted to toTrait</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>Nested | </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-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
