| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RelTraitDef (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RelTraitDef (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":10,"i2":6,"i3":10,"i4":6,"i5":6,"i6":6,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/plan/RelTraitPropagationVisitor.html" title="class in org.apache.calcite.plan"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/plan/RelTraitDef.html" target="_top">Frames</a></li> |
| <li><a href="RelTraitDef.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.plan</div> |
| <h2 title="Class RelTraitDef" class="title">Class RelTraitDef<T extends <a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.plan.RelTraitDef<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Trait that this trait definition is based upon</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/calcite/plan/ConventionTraitDef.html" title="class in org.apache.calcite.plan">ConventionTraitDef</a>, <a href="../../../../org/apache/calcite/rel/RelCollationTraitDef.html" title="class in org.apache.calcite.rel">RelCollationTraitDef</a>, <a href="../../../../org/apache/calcite/rel/RelDistributionTraitDef.html" title="class in org.apache.calcite.rel">RelDistributionTraitDef</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">RelTraitDef<T extends <a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">RelTraitDef represents a class of <a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan"><code>RelTrait</code></a>s. Implementations of |
| RelTraitDef may be singletons under the following conditions: |
| |
| <ol> |
| <li>if the set of all possible associated RelTraits is finite and fixed (e.g. |
| all RelTraits for this RelTraitDef are known at compile time). For example, |
| the CallingConvention trait meets this requirement, because CallingConvention |
| is effectively an enumeration.</li> |
| <li>Either |
| |
| <ul> |
| <li> <a href="../../../../org/apache/calcite/plan/RelTraitDef.html#canConvert-org.apache.calcite.plan.RelOptPlanner-T-T-"><code>canConvert(RelOptPlanner, RelTrait, RelTrait)</code></a> and |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html#convert-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.RelNode-T-boolean-"><code>convert(RelOptPlanner, RelNode, RelTrait, boolean)</code></a> do not require |
| planner-instance-specific information, <b>or</b></li> |
| |
| <li>the RelTraitDef manages separate sets of conversion data internally. See |
| <a href="../../../../org/apache/calcite/plan/ConventionTraitDef.html" title="class in org.apache.calcite.plan"><code>ConventionTraitDef</code></a> for an example of this.</li> |
| </ul> |
| </li> |
| </ol> |
| |
| <p>Otherwise, a new instance of RelTraitDef must be constructed and |
| registered with each new planner instantiated.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#RelTraitDef--">RelTraitDef</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#canConvert-org.apache.calcite.plan.RelOptPlanner-T-T-">canConvert</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> fromTrait, |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> toTrait)</code> |
| <div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#canonize-T-">canonize</a></span>(<a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> trait)</code> |
| <div class="block">Takes an arbitrary RelTrait and returns the canonical representation of |
| that RelTrait.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#convert-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.RelNode-T-boolean-">convert</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> toTrait, |
| boolean allowInfiniteCostConverters)</code> |
| <div class="block">Converts the given RelNode to the given RelTrait.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#deregisterConverterRule-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.convert.ConverterRule-">deregisterConverterRule</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</code> |
| <div class="block">Provides notification that a particular <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> has been |
| de-registered from a <a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#getDefault--">getDefault</a></span>()</code> |
| <div class="block">Returns the default member of this trait.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#getSimpleName--">getSimpleName</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#getTraitClass--">getTraitClass</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#multiple--">multiple</a></span>()</code> |
| <div class="block">Whether a relational expression may possess more than one instance of |
| this trait simultaneously.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTraitDef.html#registerConverterRule-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.convert.ConverterRule-">registerConverterRule</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</code> |
| <div class="block">Provides notification of the registration of a particular |
| <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> with a <a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="RelTraitDef--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RelTraitDef</h4> |
| <pre>protected RelTraitDef()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="multiple--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>multiple</h4> |
| <pre>public boolean multiple()</pre> |
| <div class="block">Whether a relational expression may possess more than one instance of |
| this trait simultaneously. |
| |
| <p>A subset has only one instance of a trait.</p></div> |
| </li> |
| </ul> |
| <a name="getTraitClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTraitClass</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><<a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a>> getTraitClass()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the specific RelTrait type associated with this RelTraitDef.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSimpleName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSimpleName</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSimpleName()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a simple name for this RelTraitDef (for use in |
| <a href="../../../../org/apache/calcite/rel/RelNode.html#explain-org.apache.calcite.rel.RelWriter-"><code>RelNode.explain(org.apache.calcite.rel.RelWriter)</code></a>).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canonize-org.apache.calcite.plan.RelTrait-"> |
| <!-- --> |
| </a><a name="canonize-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canonize</h4> |
| <pre>public final <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> canonize(<a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> trait)</pre> |
| <div class="block">Takes an arbitrary RelTrait and returns the canonical representation of |
| that RelTrait. Canonized RelTrait objects may always be compared using |
| the equality operator (<code>==</code>). |
| |
| <p>If an equal RelTrait has already been canonized and is still in use, |
| it will be returned. Otherwise, the given RelTrait is made canonical and |
| returned.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trait</code> - a possibly non-canonical RelTrait</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a canonical RelTrait.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="convert-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.RelNode-org.apache.calcite.plan.RelTrait-boolean-"> |
| <!-- --> |
| </a><a name="convert-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.RelNode-T-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>convert</h4> |
| <pre>public abstract <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> convert(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> toTrait, |
| boolean allowInfiniteCostConverters)</pre> |
| <div class="block">Converts the given RelNode to the given RelTrait.</div> |
| <dl> |
| <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>toTrait</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> |
| </li> |
| </ul> |
| <a name="canConvert-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.plan.RelTrait-org.apache.calcite.plan.RelTrait-"> |
| <!-- --> |
| </a><a name="canConvert-org.apache.calcite.plan.RelOptPlanner-T-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canConvert</h4> |
| <pre>public abstract boolean canConvert(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> fromTrait, |
| <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> toTrait)</pre> |
| <div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>planner</code> - the planner requesting the conversion test</dd> |
| <dd><code>fromTrait</code> - the RelTrait to convert from</dd> |
| <dd><code>toTrait</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> |
| </li> |
| </ul> |
| <a name="registerConverterRule-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.convert.ConverterRule-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerConverterRule</h4> |
| <pre>public void registerConverterRule(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</pre> |
| <div class="block">Provides notification of the registration of a particular |
| <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> with a <a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>. The default |
| implementation does nothing.</div> |
| <dl> |
| <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> |
| </li> |
| </ul> |
| <a name="deregisterConverterRule-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.convert.ConverterRule-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deregisterConverterRule</h4> |
| <pre>public void deregisterConverterRule(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a> planner, |
| <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a> converterRule)</pre> |
| <div class="block">Provides notification that a particular <a href="../../../../org/apache/calcite/rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> has been |
| de-registered from a <a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>. The default implementation |
| does nothing.</div> |
| <dl> |
| <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> |
| </li> |
| </ul> |
| <a name="getDefault--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDefault</h4> |
| <pre>public abstract <a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="type parameter in RelTraitDef">T</a> getDefault()</pre> |
| <div class="block">Returns the default member of this trait.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/plan/RelTrait.html" title="interface in org.apache.calcite.plan"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/plan/RelTraitPropagationVisitor.html" title="class in org.apache.calcite.plan"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/plan/RelTraitDef.html" target="_top">Frames</a></li> |
| <li><a href="RelTraitDef.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |