Google Git
Sign in
apache / calcite-site / f3651d86b6f63f8b6bbb735c74220c093b7bf506 / . / apidocs / org / apache / calcite / plan / ConventionTraitDef.html
blob: 6fdbcfcbf161a01cc6ce3f7938a15355e9a5fed9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ConventionTraitDef (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="ConventionTraitDef (Apache Calcite API)";
}
}
catch(err) {
}
//-->
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 = "../../../../";
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/ConventionTraitDef.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><a href="#nested.class.summary">Nested</a>&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 ConventionTraitDef" class="title">Class ConventionTraitDef</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.plan.ConventionTraitDef</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">ConventionTraitDef</span>
extends <a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</pre>
<div class="block">Definition of the 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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ConventionTraitDef.ConversionData.html" title="class in org.apache.calcite.plan">ConventionTraitDef.ConversionData</a></span></code></th>
<td class="colLast">
<div class="block">Workspace for converting from one convention to another.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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.cache.LoadingCache&lt;<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>,&#8203;<a href="ConventionTraitDef.ConversionData.html" title="class in org.apache.calcite.plan">ConventionTraitDef.ConversionData</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#conversionCache">conversionCache</a></span></code></th>
<td class="colLast">
<div class="block">Weak-key cache of RelOptPlanner to ConversionData.</div>
</td>
</tr>
<tr class="rowColor">
<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">&nbsp;</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>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ConventionTraitDef</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="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>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>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;fromConvention,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;toConvention)</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>private <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="#changeConvention(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.Convention,org.apache.calcite.plan.Convention,com.google.common.collect.Multimap)">changeConvention</a></span>&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;source,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;target,
com.google.common.collect.Multimap&lt;<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>,&#8203;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;,&#8203;<a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&gt;&nbsp;mapArcToConverterRule)</code></th>
<td class="colLast">
<div class="block">Tries to convert a relational expression to the target convention of an
arc.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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>&#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="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;toConvention,
boolean&nbsp;allowInfiniteCostConverters)</code></th>
<td class="colLast">
<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>
<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="i4" class="altColor">
<td class="colFirst"><code>private <a href="ConventionTraitDef.ConversionData.html" title="class in org.apache.calcite.plan">ConventionTraitDef.ConversionData</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConversionData(org.apache.calcite.plan.RelOptPlanner)">getConversionData</a></span>&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<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 id="i6" class="altColor">
<td class="colFirst"><code>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>java.lang.Class&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</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>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.org.apache.calcite.plan.RelTraitDef">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.plan.<a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></h3>
<code><a href="RelTraitDef.html#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T,org.apache.calcite.rel.RelNode)">canConvert</a>, <a href="RelTraitDef.html#canonize(T)">canonize</a>, <a href="RelTraitDef.html#multiple()">multiple</a></code></li>
</ul>
<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="INSTANCE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INSTANCE</h4>
<pre>public static final&nbsp;<a href="ConventionTraitDef.html" title="class in org.apache.calcite.plan">ConventionTraitDef</a> INSTANCE</pre>
</li>
</ul>
<a id="conversionCache">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>conversionCache</h4>
<pre>private final&nbsp;com.google.common.cache.LoadingCache&lt;<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>,&#8203;<a href="ConventionTraitDef.ConversionData.html" title="class in org.apache.calcite.plan">ConventionTraitDef.ConversionData</a>&gt; conversionCache</pre>
<div class="block">Weak-key cache of RelOptPlanner to ConversionData. The idea is that when
the planner goes away, so does the cache entry.</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>ConventionTraitDef</h4>
<pre>private&nbsp;ConventionTraitDef()</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="getTraitClass()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitClass</h4>
<pre class="methodSignature">public&nbsp;java.lang.Class&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;&nbsp;getTraitClass()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelTraitDef.html#getTraitClass()">getTraitClass</a></code>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</code></dd>
<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&nbsp;java.lang.String&nbsp;getSimpleName()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelTraitDef.html#getSimpleName()">getSimpleName</a></code>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</code></dd>
<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="getDefault()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefault</h4>
<pre class="methodSignature">public&nbsp;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;getDefault()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</code></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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</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>
</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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</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>
</li>
</ul>
<a id="convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.plan.Convention,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public&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="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;toConvention,
boolean&nbsp;allowInfiniteCostConverters)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</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>
</li>
</ul>
<a id="changeConvention(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.Convention,org.apache.calcite.plan.Convention,com.google.common.collect.Multimap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeConvention</h4>
<pre class="methodSignature">private&nbsp;<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;changeConvention&#8203;(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;source,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;target,
com.google.common.collect.Multimap&lt;<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>,&#8203;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;,&#8203;<a href="../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&gt;&nbsp;mapArcToConverterRule)</pre>
<div class="block">Tries to convert a relational expression to the target convention of an
arc.</div>
</li>
</ul>
<a id="canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.plan.Convention,org.apache.calcite.plan.Convention)">
<!-- -->
</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="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;fromConvention,
<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;toConvention)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&gt;</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>
</li>
</ul>
<a id="getConversionData(org.apache.calcite.plan.RelOptPlanner)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConversionData</h4>
<pre class="methodSignature">private&nbsp;<a href="ConventionTraitDef.ConversionData.html" title="class in org.apache.calcite.plan">ConventionTraitDef.ConversionData</a>&nbsp;getConversionData&#8203;(<a href="RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</pre>
</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/ConventionTraitDef.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><a href="#nested.class.summary">Nested</a>&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>