blob: 213c12f3fd3bc7b13af5271b298d0f262a380e5d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="zh">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ConverterRule (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ConverterRule (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"],8:["t4","具体方法"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>您的浏览器已禁用 JavaScript。</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-all.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/rel/convert/ConverterImpl.html" title="org.apache.calcite.rel.convert中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../../org/apache/calcite/rel/convert/NoneConverter.html" title="org.apache.calcite.rel.convert中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/rel/convert/ConverterRule.html" target="_top">框架</a></li>
<li><a href="ConverterRule.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.calcite.plan.RelOptRule">字段</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.rel.convert</div>
<h2 title="类 ConverterRule" class="title">类 ConverterRule</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="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>直接已知子类:</dt>
<dd><a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableAggregateRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableAggregateRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableFilterRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableFilterRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableJoinRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableJoinRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableMatchRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableMatchRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableProjectRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableProjectRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableSortRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableSortRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableUnionRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableUnionRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableValuesRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableValuesRule</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableWindowRule.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableWindowRule</a>, <a href="../../../../../org/apache/calcite/adapter/cassandra/CassandraToEnumerableConverterRule.html" title="org.apache.calcite.adapter.cassandra中的类">CassandraToEnumerableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchToEnumerableConverterRule.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchToEnumerableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableBindable.EnumerableToBindableConverterRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableBindable.EnumerableToBindableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableCorrelateRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableCorrelateRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableInterpreterRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableInterpreterRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableMatchRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableMatchRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableRepeatUnionRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableRepeatUnionRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableTableFunctionScanRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableTableFunctionScanRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableTableModifyRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableTableModifyRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableTableScanRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableTableScanRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableTableSpoolRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableTableSpoolRule</a>, <a href="../../../../../org/apache/calcite/adapter/spark/EnumerableToSparkConverterRule.html" title="org.apache.calcite.adapter.spark中的类">EnumerableToSparkConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableValuesRule.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableValuesRule</a>, <a href="../../../../../org/apache/calcite/adapter/geode/rel/GeodeToEnumerableConverterRule.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeToEnumerableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcAggregateRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcAggregateRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcFilterRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcFilterRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcIntersectRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcIntersectRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcJoinRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcJoinRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcMinusRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcMinusRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcProjectRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcProjectRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcSortRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcSortRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcTableModificationRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcTableModificationRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcUnionRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcUnionRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcValuesRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcValuesRule</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcToEnumerableConverterRule.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcToEnumerableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/spark/JdbcToSparkConverterRule.html" title="org.apache.calcite.adapter.spark中的类">JdbcToSparkConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoToEnumerableConverterRule.html" title="org.apache.calcite.adapter.mongodb中的类">MongoToEnumerableConverterRule</a>, <a href="../../../../../org/apache/calcite/interpreter/NoneToBindableConverterRule.html" title="org.apache.calcite.interpreter中的类">NoneToBindableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/pig/PigToEnumerableConverterRule.html" title="org.apache.calcite.adapter.pig中的类">PigToEnumerableConverterRule</a>, <a href="../../../../../org/apache/calcite/adapter/spark/SparkRules.SparkValuesRule.html" title="org.apache.calcite.adapter.spark中的类">SparkRules.SparkValuesRule</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ConverterRule</span>
extends <a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>字段概要</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.calcite.plan.RelOptRule">
<!-- -->
</a>
<h3>从类继承的字段&nbsp;org.apache.calcite.plan.<a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="org.apache.calcite.plan中的类">RelOptRule</a></h3>
<code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html#description">description</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#operands">operands</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#relBuilderFactory">relBuilderFactory</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>构造器概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="构造器概要表, 列表构造器和解释">
<caption><span>构造器</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">构造器和说明</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#ConverterRule-java.lang.Class-org.apache.calcite.plan.RelTrait-org.apache.calcite.plan.RelTrait-java.lang.String-">ConverterRule</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;? extends <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&gt;&nbsp;clazz,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;descriptionPrefix)</code>
<div class="block">Creates a <code>ConverterRule</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#ConverterRule-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>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;R&gt;&nbsp;clazz,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="java.util.function中的类或接口">Predicate</a>&lt;? super R&gt;&nbsp;predicate,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="../../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="org.apache.calcite.tools中的接口">RelBuilderFactory</a>&nbsp;relBuilderFactory,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;descriptionPrefix)</code>
<div class="block">Creates a <code>ConverterRule</code> with a predicate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#ConverterRule-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>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="../../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="org.apache.calcite.tools中的接口">RelBuilderFactory</a>&nbsp;relBuilderFactory,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;description)</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#ConverterRule-java.lang.Class-com.google.common.base.Predicate-org.apache.calcite.plan.RelTrait-org.apache.calcite.plan.RelTrait-java.lang.String-">ConverterRule</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;descriptionPrefix)</code>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>方法概要</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">具体方法</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#convert-org.apache.calcite.rel.RelNode-">convert</a></span>(<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;rel)</code>
<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="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#getInTrait--">getInTrait</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/plan/Convention.html" title="org.apache.calcite.plan中的接口">Convention</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#getOutConvention--">getOutConvention</a></span>()</code>
<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="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#getOutTrait--">getOutTrait</a></span>()</code>
<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="../../../../../org/apache/calcite/plan/RelTraitDef.html" title="org.apache.calcite.plan中的类">RelTraitDef</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#getTraitDef--">getTraitDef</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#isGuaranteed--">isGuaranteed</a></span>()</code>
<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>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/ConverterRule.html#onMatch-org.apache.calcite.plan.RelOptRuleCall-">onMatch</a></span>(<a href="../../../../../org/apache/calcite/plan/RelOptRuleCall.html" title="org.apache.calcite.plan中的类">RelOptRuleCall</a>&nbsp;call)</code>
<div class="block">Receives notification about a rule match.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.plan.RelOptRule">
<!-- -->
</a>
<h3>从类继承的方法&nbsp;org.apache.calcite.plan.<a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="org.apache.calcite.plan中的类">RelOptRule</a></h3>
<code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html#any--">any</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#convert-org.apache.calcite.rel.RelNode-org.apache.calcite.plan.RelTrait-">convert</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#convert-org.apache.calcite.rel.RelNode-org.apache.calcite.plan.RelTraitSet-">convert</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#convertList-java.util.List-org.apache.calcite.plan.RelTrait-">convertList</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#convertOperand-java.lang.Class-java.util.function.Predicate-org.apache.calcite.plan.RelTrait-">convertOperand</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#convertOperand-java.lang.Class-com.google.common.base.Predicate-org.apache.calcite.plan.RelTrait-">convertOperand</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#equals-org.apache.calcite.plan.RelOptRule-">equals</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#getOperand--">getOperand</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#getOperands--">getOperands</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#hashCode--">hashCode</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#matches-org.apache.calcite.plan.RelOptRuleCall-">matches</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#none--">none</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#operand-java.lang.Class-org.apache.calcite.plan.RelOptRuleOperandChildren-">operand</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#operand-java.lang.Class-org.apache.calcite.plan.RelOptRuleOperand-org.apache.calcite.plan.RelOptRuleOperand...-">operand</a>, <a href="../../../../../org/apache/calcite/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="../../../../../org/apache/calcite/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="../../../../../org/apache/calcite/plan/RelOptRule.html#operand-java.lang.Class-org.apache.calcite.plan.RelTrait-org.apache.calcite.plan.RelOptRuleOperandChildren-">operand</a>, <a href="../../../../../org/apache/calcite/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="../../../../../org/apache/calcite/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="../../../../../org/apache/calcite/plan/RelOptRule.html#some-org.apache.calcite.plan.RelOptRuleOperand-org.apache.calcite.plan.RelOptRuleOperand...-">some</a>, <a href="../../../../../org/apache/calcite/plan/RelOptRule.html#toString--">toString</a>, <a href="../../../../../org/apache/calcite/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 name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>从类继承的方法&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="java.lang中的类或接口">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="java.lang中的类或接口">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="java.lang中的类或接口">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="java.lang中的类或接口">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="java.lang中的类或接口">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="java.lang中的类或接口">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="java.lang中的类或接口">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="java.lang中的类或接口">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>构造器详细资料</h3>
<a name="ConverterRule-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(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;? extends <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&gt;&nbsp;clazz,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;descriptionPrefix)</pre>
<div class="block">Creates a <code>ConverterRule</code>.</div>
<dl>
<dt><span class="paramLabel">参数:</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>descriptionPrefix</code> - Description prefix of rule</dd>
</dl>
</li>
</ul>
<a name="ConverterRule-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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="java.lang中的类或接口">@Deprecated</a>
public&nbsp;ConverterRule(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;descriptionPrefix)</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
</li>
</ul>
<a name="ConverterRule-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(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;R&gt;&nbsp;clazz,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="java.util.function中的类或接口">Predicate</a>&lt;? super R&gt;&nbsp;predicate,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="../../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="org.apache.calcite.tools中的接口">RelBuilderFactory</a>&nbsp;relBuilderFactory,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;descriptionPrefix)</pre>
<div class="block">Creates a <code>ConverterRule</code> with a predicate.</div>
<dl>
<dt><span class="paramLabel">参数:</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>descriptionPrefix</code> - Description prefix of rule</dd>
</dl>
</li>
</ul>
<a name="ConverterRule-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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="java.lang中的类或接口">@Deprecated</a>
public&nbsp;ConverterRule(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="java.lang中的类或接口">Class</a>&lt;R&gt;&nbsp;clazz,
com.google.common.base.Predicate&lt;? super R&gt;&nbsp;predicate,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;in,
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;out,
<a href="../../../../../org/apache/calcite/tools/RelBuilderFactory.html" title="org.apache.calcite.tools中的接口">RelBuilderFactory</a>&nbsp;relBuilderFactory,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;description)</pre>
<div class="block"><span class="deprecatedLabel">已过时。</span>&nbsp;</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>方法详细资料</h3>
<a name="getOutConvention--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutConvention</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/calcite/plan/Convention.html" title="org.apache.calcite.plan中的接口">Convention</a>&nbsp;getOutConvention()</pre>
<div class="block"><span class="descfrmTypeLabel">从类复制的说明:&nbsp;<code><a href="../../../../../org/apache/calcite/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">覆盖:</span></dt>
<dd><code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html#getOutConvention--">getOutConvention</a></code>&nbsp;在类中&nbsp;<code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="org.apache.calcite.plan中的类">RelOptRule</a></code></dd>
<dt><span class="returnLabel">返回:</span></dt>
<dd>Convention of the result of firing this rule, null if
not known</dd>
</dl>
</li>
</ul>
<a name="getOutTrait--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutTrait</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;getOutTrait()</pre>
<div class="block"><span class="descfrmTypeLabel">从类复制的说明:&nbsp;<code><a href="../../../../../org/apache/calcite/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">覆盖:</span></dt>
<dd><code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html#getOutTrait--">getOutTrait</a></code>&nbsp;在类中&nbsp;<code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="org.apache.calcite.plan中的类">RelOptRule</a></code></dd>
<dt><span class="returnLabel">返回:</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 name="getInTrait--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInTrait</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;getInTrait()</pre>
</li>
</ul>
<a name="getTraitDef--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitDef</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/calcite/plan/RelTraitDef.html" title="org.apache.calcite.plan中的类">RelTraitDef</a>&nbsp;getTraitDef()</pre>
</li>
</ul>
<a name="convert-org.apache.calcite.rel.RelNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;convert(<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="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 name="isGuaranteed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isGuaranteed</h4>
<pre>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">返回:</span></dt>
<dd><code>true</code> if this rule can convert <em>any</em> relational
expression</dd>
</dl>
</li>
</ul>
<a name="onMatch-org.apache.calcite.plan.RelOptRuleCall-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onMatch</h4>
<pre>public&nbsp;void&nbsp;onMatch(<a href="../../../../../org/apache/calcite/plan/RelOptRuleCall.html" title="org.apache.calcite.plan中的类">RelOptRuleCall</a>&nbsp;call)</pre>
<div class="block"><span class="descfrmTypeLabel">从类复制的说明:&nbsp;<code><a href="../../../../../org/apache/calcite/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="../../../../../org/apache/calcite/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="../../../../../org/apache/calcite/plan/RelOptRuleCall.html#transformTo-org.apache.calcite.rel.RelNode-java.util.Map-org.apache.calcite.plan.RelHintsPropagator-"><code>RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map&lt;org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode&gt;, org.apache.calcite.plan.RelHintsPropagator)</code></a> to
register the expression.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">指定者:</span></dt>
<dd><code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html#onMatch-org.apache.calcite.plan.RelOptRuleCall-">onMatch</a></code>&nbsp;在类中&nbsp;<code><a href="../../../../../org/apache/calcite/plan/RelOptRule.html" title="org.apache.calcite.plan中的类">RelOptRule</a></code></dd>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>call</code> - Rule call</dd>
<dt><span class="seeLabel">另请参阅:</span></dt>
<dd><a href="../../../../../org/apache/calcite/plan/RelOptRule.html#matches-org.apache.calcite.plan.RelOptRuleCall-"><code>RelOptRule.matches(RelOptRuleCall)</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="导航">
<li><a href="../../../../../overview-summary.html">概览</a></li>
<li><a href="package-summary.html">程序包</a></li>
<li class="navBarCell1Rev"></li>
<li><a href="package-tree.html"></a></li>
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
<li><a href="../../../../../index-all.html">索引</a></li>
<li><a href="../../../../../help-doc.html">帮助</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/rel/convert/ConverterImpl.html" title="org.apache.calcite.rel.convert中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../../org/apache/calcite/rel/convert/NoneConverter.html" title="org.apache.calcite.rel.convert中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/rel/convert/ConverterRule.html" target="_top">框架</a></li>
<li><a href="ConverterRule.html" target="_top">无框架</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>概要:&nbsp;</li>
<li>嵌套&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.calcite.plan.RelOptRule">字段</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">构造器</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">方法</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>