Google Git
Sign in
apache / calcite-site / f3651d86b6f63f8b6bbb735c74220c093b7bf506 / . / apidocs / org / apache / calcite / rel / convert / ConverterRule.html
blob: b998229d9a3feb12129bec25ce5616abbd2d5565 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ConverterRule (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="ConverterRule (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/ConverterRule.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.rel.convert</a></div>
<h2 title="Class ConverterRule" class="title">Class ConverterRule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.RelOptRule</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.rel.convert.ConverterRule</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../interpreter/Bindables.BindableAggregateRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableAggregateRule</a></code>, <code><a href="../../interpreter/Bindables.BindableFilterRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableFilterRule</a></code>, <code><a href="../../interpreter/Bindables.BindableJoinRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableJoinRule</a></code>, <code><a href="../../interpreter/Bindables.BindableProjectRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableProjectRule</a></code>, <code><a href="../../interpreter/Bindables.BindableSortRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableSortRule</a></code>, <code><a href="../../interpreter/Bindables.BindableUnionRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableUnionRule</a></code>, <code><a href="../../interpreter/Bindables.BindableValuesRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableValuesRule</a></code>, <code><a href="../../interpreter/Bindables.BindableWindowRule.html" title="class in org.apache.calcite.interpreter">Bindables.BindableWindowRule</a></code>, <code><a href="../../adapter/cassandra/CassandraRules.CassandraConverterRule.html" title="class in org.apache.calcite.adapter.cassandra">CassandraRules.CassandraConverterRule</a></code>, <code><a href="../../adapter/cassandra/CassandraToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.cassandra">CassandraToEnumerableConverterRule</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchRules.ElasticsearchConverterRule.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchRules.ElasticsearchConverterRule</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchToEnumerableConverterRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableAggregateRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregateRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableBindable.EnumerableToBindableConverterRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableBindable.EnumerableToBindableConverterRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableCalcRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCalcRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableCollectRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCollectRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableCorrelateRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCorrelateRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableFilterRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableFilterRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableInterpreterRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableInterpreterRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableIntersectRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableIntersectRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableJoinRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableJoinRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableMergeJoinRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMergeJoinRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableMinusRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMinusRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableProjectRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableProjectRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableRepeatUnionRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableRepeatUnionRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableSemiJoinRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSemiJoinRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableSortRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSortRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableTableFunctionScanRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableFunctionScanRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableTableModifyRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableModifyRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableTableScanRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableScanRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableTableSpoolRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableSpoolRule</a></code>, <code><a href="../../adapter/spark/EnumerableToSparkConverterRule.html" title="class in org.apache.calcite.adapter.spark">EnumerableToSparkConverterRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableUncollectRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUncollectRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableUnionRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUnionRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableValuesRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableValuesRule</a></code>, <code><a href="../../adapter/enumerable/EnumerableWindowRule.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableWindowRule</a></code>, <code><a href="../../adapter/geode/rel/GeodeRules.GeodeConverterRule.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeRules.GeodeConverterRule</a></code>, <code><a href="../../adapter/geode/rel/GeodeToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeToEnumerableConverterRule</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcConverterRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcConverterRule</a></code>, <code><a href="../../adapter/jdbc/JdbcToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.jdbc">JdbcToEnumerableConverterRule</a></code>, <code><a href="../../adapter/spark/JdbcToSparkConverterRule.html" title="class in org.apache.calcite.adapter.spark">JdbcToSparkConverterRule</a></code>, <code><a href="../../adapter/mongodb/MongoRules.MongoConverterRule.html" title="class in org.apache.calcite.adapter.mongodb">MongoRules.MongoConverterRule</a></code>, <code><a href="../../adapter/mongodb/MongoToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.mongodb">MongoToEnumerableConverterRule</a></code>, <code><a href="../../interpreter/NoneToBindableConverterRule.html" title="class in org.apache.calcite.interpreter">NoneToBindableConverterRule</a></code>, <code><a href="../../adapter/pig/PigRules.PigAggregateRule.html" title="class in org.apache.calcite.adapter.pig">PigRules.PigAggregateRule</a></code>, <code><a href="../../adapter/pig/PigRules.PigFilterRule.html" title="class in org.apache.calcite.adapter.pig">PigRules.PigFilterRule</a></code>, <code><a href="../../adapter/pig/PigRules.PigJoinRule.html" title="class in org.apache.calcite.adapter.pig">PigRules.PigJoinRule</a></code>, <code><a href="../../adapter/pig/PigRules.PigProjectRule.html" title="class in org.apache.calcite.adapter.pig">PigRules.PigProjectRule</a></code>, <code><a href="../../adapter/pig/PigRules.PigTableScanRule.html" title="class in org.apache.calcite.adapter.pig">PigRules.PigTableScanRule</a></code>, <code><a href="../../adapter/pig/PigToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.pig">PigToEnumerableConverterRule</a></code>, <code><a href="../../adapter/spark/SparkRules.EnumerableToSparkConverterRule.html" title="class in org.apache.calcite.adapter.spark">SparkRules.EnumerableToSparkConverterRule</a></code>, <code><a href="../../adapter/spark/SparkRules.SparkCalcRule.html" title="class in org.apache.calcite.adapter.spark">SparkRules.SparkCalcRule</a></code>, <code><a href="../../adapter/spark/SparkRules.SparkToEnumerableConverterRule.html" title="class in org.apache.calcite.adapter.spark">SparkRules.SparkToEnumerableConverterRule</a></code>, <code><a href="../../adapter/spark/SparkRules.SparkValuesRule.html" title="class in org.apache.calcite.adapter.spark">SparkRules.SparkValuesRule</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">ConverterRule</span>
extends <a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></pre>
<div class="block">Abstract base class for a rule which converts from one calling convention to
another without changing semantics.</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 <a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inTrait">inTrait</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#outTrait">outTrait</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.plan.RelOptRule">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.calcite.plan.<a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></h3>
<code><a href="../../plan/RelOptRule.html#description">description</a>, <a href="../../plan/RelOptRule.html#operands">operands</a>, <a href="../../plan/RelOptRule.html#relBuilderFactory">relBuilderFactory</a></code></li>
</ul>
</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">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,java.lang.String)">ConverterRule</a></span>&#8203;(java.lang.Class&lt;? extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;clazz,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
java.lang.String&nbsp;description)</code></th>
<td class="colLast">
<div class="block">Creates a <code>ConverterRule</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,java.lang.String)">ConverterRule</a></span>&#8203;(java.lang.Class&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
java.lang.String&nbsp;description)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,org.apache.calcite.tools.RelBuilderFactory,java.lang.String)">ConverterRule</a></span>&#8203;(java.lang.Class&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
<a href="../../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a>&nbsp;relBuilderFactory,
java.lang.String&nbsp;description)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,org.apache.calcite.tools.RelBuilderFactory,java.lang.String)">ConverterRule</a></span>&#8203;(java.lang.Class&lt;R&gt;&nbsp;clazz,
java.util.function.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
<a href="../../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a>&nbsp;relBuilderFactory,
java.lang.String&nbsp;description)</code></th>
<td class="colLast">
<div class="block">Creates a <code>ConverterRule</code> with a predicate.</div>
</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 <a href="../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.rel.RelNode)">convert</a></span>&#8203;(<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
<td class="colLast">
<div class="block">Converts a relational expression to the target trait(s) of this rule.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInTrait()">getInTrait</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutConvention()">getOutConvention</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the convention of the result of firing this rule, null if
not known.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutTrait()">getOutTrait</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the trait which will be modified as a result of firing this rule,
or null if the rule is not a converter rule.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTraitDef()">getTraitDef</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGuaranteed()">isGuaranteed</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if this rule can convert <em>any</em> relational expression
of the input convention.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onMatch(org.apache.calcite.plan.RelOptRuleCall)">onMatch</a></span>&#8203;(<a href="../../plan/RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a>&nbsp;call)</code></th>
<td class="colLast">
<div class="block">Receives notification about a rule match.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.plan.RelOptRule">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.plan.<a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></h3>
<code><a href="../../plan/RelOptRule.html#any()">any</a>, <a href="../../plan/RelOptRule.html#convert(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTrait)">convert</a>, <a href="../../plan/RelOptRule.html#convert(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">convert</a>, <a href="../../plan/RelOptRule.html#convertList(java.util.List,org.apache.calcite.plan.RelTrait)">convertList</a>, <a href="../../plan/RelOptRule.html#convertOperand(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait)">convertOperand</a>, <a href="../../plan/RelOptRule.html#convertOperand(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait)">convertOperand</a>, <a href="../../plan/RelOptRule.html#equals(java.lang.Object)">equals</a>, <a href="../../plan/RelOptRule.html#equals(org.apache.calcite.plan.RelOptRule)">equals</a>, <a href="../../plan/RelOptRule.html#getOperand()">getOperand</a>, <a href="../../plan/RelOptRule.html#getOperands()">getOperands</a>, <a href="../../plan/RelOptRule.html#hashCode()">hashCode</a>, <a href="../../plan/RelOptRule.html#matches(org.apache.calcite.plan.RelOptRuleCall)">matches</a>, <a href="../../plan/RelOptRule.html#none()">none</a>, <a href="../../plan/RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a>, <a href="../../plan/RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operand</a>, <a href="../../plan/RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelTrait,com.google.common.base.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a>, <a href="../../plan/RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelTrait,com.google.common.base.Predicate,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operand</a>, <a href="../../plan/RelOptRule.html#operand(java.lang.Class,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelOptRuleOperandChildren)">operand</a>, <a href="../../plan/RelOptRule.html#operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperandChildren)">operandJ</a>, <a href="../../plan/RelOptRule.html#operandJ(java.lang.Class,org.apache.calcite.plan.RelTrait,java.util.function.Predicate,org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">operandJ</a>, <a href="../../plan/RelOptRule.html#some(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">some</a>, <a href="../../plan/RelOptRule.html#toString()">toString</a>, <a href="../../plan/RelOptRule.html#unordered(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.plan.RelOptRuleOperand...)">unordered</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, finalize, getClass, notify, notifyAll, 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="inTrait">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inTrait</h4>
<pre>private final&nbsp;<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> inTrait</pre>
</li>
</ul>
<a id="outTrait">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>outTrait</h4>
<pre>private final&nbsp;<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a> outTrait</pre>
</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;(java.lang.Class,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConverterRule</h4>
<pre>public&nbsp;ConverterRule&#8203;(java.lang.Class&lt;? extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;clazz,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
java.lang.String&nbsp;description)</pre>
<div class="block">Creates a <code>ConverterRule</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - Type of relational expression to consider converting</dd>
<dd><code>in</code> - Trait of relational expression to consider converting</dd>
<dd><code>out</code> - Trait which is converted to</dd>
<dd><code>description</code> - Description of rule</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConverterRule</h4>
<pre>@Deprecated
public&nbsp;ConverterRule&#8203;(java.lang.Class&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
java.lang.String&nbsp;description)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.Class,java.util.function.Predicate,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,org.apache.calcite.tools.RelBuilderFactory,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConverterRule</h4>
<pre>public&nbsp;ConverterRule&#8203;(java.lang.Class&lt;R&gt;&nbsp;clazz,
java.util.function.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
<a href="../../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a>&nbsp;relBuilderFactory,
java.lang.String&nbsp;description)</pre>
<div class="block">Creates a <code>ConverterRule</code> with a predicate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - Type of relational expression to consider converting</dd>
<dd><code>predicate</code> - Predicate on the relational expression</dd>
<dd><code>in</code> - Trait of relational expression to consider converting</dd>
<dd><code>out</code> - Trait which is converted to</dd>
<dd><code>relBuilderFactory</code> - Builder for relational expressions</dd>
<dd><code>description</code> - Description of rule</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.Class,com.google.common.base.Predicate,org.apache.calcite.plan.RelTrait,org.apache.calcite.plan.RelTrait,org.apache.calcite.tools.RelBuilderFactory,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConverterRule</h4>
<pre>@Deprecated
public&nbsp;ConverterRule&#8203;(java.lang.Class&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in,
<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;out,
<a href="../../tools/RelBuilderFactory.html" title="interface in org.apache.calcite.tools">RelBuilderFactory</a>&nbsp;relBuilderFactory,
java.lang.String&nbsp;description)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</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="getOutConvention()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutConvention</h4>
<pre class="methodSignature">public&nbsp;<a href="../../plan/Convention.html" title="interface in org.apache.calcite.plan">Convention</a>&nbsp;getOutConvention()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../plan/RelOptRule.html#getOutConvention()">RelOptRule</a></code></span></div>
<div class="block">Returns the convention of the result of firing this rule, null if
not known.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../plan/RelOptRule.html#getOutConvention()">getOutConvention</a></code>&nbsp;in class&nbsp;<code><a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Convention of the result of firing this rule, null if
not known</dd>
</dl>
</li>
</ul>
<a id="getOutTrait()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutTrait</h4>
<pre class="methodSignature">public&nbsp;<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;getOutTrait()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../plan/RelOptRule.html#getOutTrait()">RelOptRule</a></code></span></div>
<div class="block">Returns the trait which will be modified as a result of firing this rule,
or null if the rule is not a converter rule.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../plan/RelOptRule.html#getOutTrait()">getOutTrait</a></code>&nbsp;in class&nbsp;<code><a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Trait which will be modified as a result of firing this rule,
or null if the rule is not a converter rule</dd>
</dl>
</li>
</ul>
<a id="getInTrait()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInTrait</h4>
<pre class="methodSignature">public&nbsp;<a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;getInTrait()</pre>
</li>
</ul>
<a id="getTraitDef()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitDef</h4>
<pre class="methodSignature">public&nbsp;<a href="../../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&nbsp;getTraitDef()</pre>
</li>
</ul>
<a id="convert(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;convert&#8203;(<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
<div class="block">Converts a relational expression to the target trait(s) of this rule.
<p>Returns null if conversion is not possible.</div>
</li>
</ul>
<a id="isGuaranteed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGuaranteed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isGuaranteed()</pre>
<div class="block">Returns true if this rule can convert <em>any</em> relational expression
of the input convention.
<p>The union-to-java converter, for example, is not guaranteed, because
it only works on unions.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this rule can convert <em>any</em> relational
expression</dd>
</dl>
</li>
</ul>
<a id="onMatch(org.apache.calcite.plan.RelOptRuleCall)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onMatch</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onMatch&#8203;(<a href="../../plan/RelOptRuleCall.html" title="class in org.apache.calcite.plan">RelOptRuleCall</a>&nbsp;call)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../plan/RelOptRule.html#onMatch(org.apache.calcite.plan.RelOptRuleCall)">RelOptRule</a></code></span></div>
<div class="block">Receives notification about a rule match. At the time that this method is
called, <a href="../../plan/RelOptRuleCall.html#rels"><code>call.rels</code></a> holds the set of relational
expressions which match the operands to the rule; <code>
call.rels[0]</code> is the root expression.
<p>Typically a rule would check that the nodes are valid matches, creates
a new expression, then calls back <a href="../../plan/RelOptRuleCall.html#transformTo(org.apache.calcite.rel.RelNode,java.util.Map)"><code>RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map&lt;org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode&gt;)</code></a> to
register the expression.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../plan/RelOptRule.html#onMatch(org.apache.calcite.plan.RelOptRuleCall)">onMatch</a></code>&nbsp;in class&nbsp;<code><a href="../../plan/RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>call</code> - Rule call</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../plan/RelOptRule.html#matches(org.apache.calcite.plan.RelOptRuleCall)"><code>RelOptRule.matches(RelOptRuleCall)</code></a></dd>
</dl>
</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/ConverterRule.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>