Google Git
Sign in
apache / calcite-site / f3651d86b6f63f8b6bbb735c74220c093b7bf506 / . / apidocs / org / apache / calcite / plan / RelTraitDef.html
blob: 21dbb3b34b0ab47b3fa5f6d0faf6e98e2580e0c3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelTraitDef (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RelTraitDef (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":10,"i2":10,"i3":6,"i4":10,"i5":6,"i6":6,"i7":6,"i8":10,"i9":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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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="class-use/RelTraitDef.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.plan</a></div>
<h2 title="Class RelTraitDef" class="title">Class RelTraitDef&lt;T extends <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.plan.RelTraitDef&lt;T&gt;</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><code><a href="ConventionTraitDef.html" title="class in org.apache.calcite.plan">ConventionTraitDef</a></code>, <code><a href="../rel/RelCollationTraitDef.html" title="class in org.apache.calcite.rel">RelCollationTraitDef</a></code>, <code><a href="../rel/RelDistributionTraitDef.html" title="class in org.apache.calcite.rel">RelDistributionTraitDef</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">RelTraitDef&lt;T extends <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&gt;</span>
extends java.lang.Object</pre>
<div class="block">RelTraitDef represents a class of <a href="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="#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)"><code>canConvert(RelOptPlanner, RelTrait, RelTrait)</code></a> and
<a href="#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="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">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<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>
<tr class="altColor">
<td class="colFirst"><code>private com.google.common.collect.Interner&lt;<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#interner">interner</a></span></code></th>
<td class="colLast">
<div class="block">Cache of traits.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RelTraitDef</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)">canConvert</a></span>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;fromTrait,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;toTrait)</code></th>
<td class="colLast">
<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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T,org.apache.calcite.rel.RelNode)">canConvert</a></span>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;fromTrait,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;toTrait,
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;fromRel)</code></th>
<td class="colLast">
<div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canonize(T)">canonize</a></span>&#8203;(<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;trait)</code></th>
<td class="colLast">
<div class="block">Takes an arbitrary RelTrait and returns the canonical representation of
that RelTrait.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <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,T,boolean)">convert</a></span>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;toTrait,
boolean&nbsp;allowInfiniteCostConverters)</code></th>
<td class="colLast">
<div class="block">Converts the given RelNode to the given RelTrait.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&nbsp;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 id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</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 id="i6" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSimpleName()">getSimpleName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract java.lang.Class&lt;<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTraitClass()">getTraitClass</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#multiple()">multiple</a></span>()</code></th>
<td class="colLast">
<div class="block">Whether a relational expression may possess more than one instance of
this trait simultaneously.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<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>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&nbsp;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>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="interner">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>interner</h4>
<pre>private final&nbsp;com.google.common.collect.Interner&lt;<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a> extends <a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&gt; interner</pre>
<div class="block">Cache of traits.
<p>Uses weak interner to allow GC.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RelTraitDef</h4>
<pre>protected&nbsp;RelTraitDef()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="multiple()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>multiple</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;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 id="getTraitClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitClass</h4>
<pre class="methodSignature">public abstract&nbsp;java.lang.Class&lt;<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&gt;&nbsp;getTraitClass()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the specific RelTrait type associated with this RelTraitDef.</dd>
</dl>
</li>
</ul>
<a id="getSimpleName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSimpleName</h4>
<pre class="methodSignature">public abstract&nbsp;java.lang.String&nbsp;getSimpleName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>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>).</dd>
</dl>
</li>
</ul>
<a id="canonize(org.apache.calcite.plan.RelTrait)">
<!-- -->
</a><a id="canonize(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canonize</h4>
<pre class="methodSignature">public final&nbsp;<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;canonize&#8203;(<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;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 id="convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTrait,boolean)">
<!-- -->
</a><a id="convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,T,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;convert&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;toTrait,
boolean&nbsp;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 id="canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait)">
<!-- -->
</a><a id="canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canConvert</h4>
<pre class="methodSignature">public abstract&nbsp;boolean&nbsp;canConvert&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;fromTrait,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;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 id="canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,org.apache.calcite.rel.RelNode)">
<!-- -->
</a><a id="canConvert(org.apache.calcite.plan.RelOptPlanner,T,T,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canConvert</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canConvert&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;fromTrait,
<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;toTrait,
<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;fromRel)</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>
<dd><code>fromRel</code> - the RelNode to convert from (with fromTrait)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if fromTrait can be converted to toTrait</dd>
</dl>
</li>
</ul>
<a id="registerConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerConverterRule</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;registerConverterRule&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&nbsp;converterRule)</pre>
<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="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 id="deregisterConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deregisterConverterRule</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deregisterConverterRule&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&nbsp;converterRule)</pre>
<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="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 id="getDefault()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDefault</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="RelTraitDef.html" title="type parameter in RelTraitDef">T</a>&nbsp;getDefault()</pre>
<div class="block">Returns the default member of this trait.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="class-use/RelTraitDef.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>