blob: dfd922e633a1f3544e5fc001c09ac1d4e5743180 [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>Converter (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="Converter (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"]};
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>上一个类</li>
<li><a href="../../../../../org/apache/calcite/rel/convert/ConverterImpl.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/Converter.html" target="_top">框架</a></li>
<li><a href="Converter.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>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&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="接口 Converter" class="title">接口 Converter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有超级接口:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="java.lang中的类或接口">Cloneable</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html" title="org.apache.calcite.plan中的接口">RelOptNode</a></dd>
</dl>
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../../org/apache/calcite/plan/volcano/AbstractConverter.html" title="org.apache.calcite.plan.volcano中的类">AbstractConverter</a>, <a href="../../../../../org/apache/calcite/adapter/cassandra/CassandraToEnumerableConverter.html" title="org.apache.calcite.adapter.cassandra中的类">CassandraToEnumerableConverter</a>, <a href="../../../../../org/apache/calcite/rel/convert/ConverterImpl.html" title="org.apache.calcite.rel.convert中的类">ConverterImpl</a>, <a href="../../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchToEnumerableConverter.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchToEnumerableConverter</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableBindable.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableBindable</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableInterpretable.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableInterpretable</a>, <a href="../../../../../org/apache/calcite/adapter/spark/EnumerableToSparkConverter.html" title="org.apache.calcite.adapter.spark中的类">EnumerableToSparkConverter</a>, <a href="../../../../../org/apache/calcite/adapter/geode/rel/GeodeToEnumerableConverter.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeToEnumerableConverter</a>, <a href="../../../../../org/apache/calcite/interpreter/InterpretableConverter.html" title="org.apache.calcite.interpreter中的类">InterpretableConverter</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcToEnumerableConverter.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcToEnumerableConverter</a>, <a href="../../../../../org/apache/calcite/adapter/spark/JdbcToSparkConverter.html" title="org.apache.calcite.adapter.spark中的类">JdbcToSparkConverter</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoToEnumerableConverter.html" title="org.apache.calcite.adapter.mongodb中的类">MongoToEnumerableConverter</a>, <a href="../../../../../org/apache/calcite/rel/convert/NoneConverter.html" title="org.apache.calcite.rel.convert中的类">NoneConverter</a>, <a href="../../../../../org/apache/calcite/adapter/pig/PigToEnumerableConverter.html" title="org.apache.calcite.adapter.pig中的类">PigToEnumerableConverter</a>, <a href="../../../../../org/apache/calcite/adapter/spark/SparkToEnumerableConverter.html" title="org.apache.calcite.adapter.spark中的类">SparkToEnumerableConverter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Converter</span>
extends <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a></pre>
<div class="block">A relational expression implements the interface <code>Converter</code> to
indicate that it converts a physical attribute, or
<a href="../../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口"><code>trait</code></a>, of a relational expression
from one value to another.
<p>Sometimes this conversion is expensive; for example, to convert a
non-distinct to a distinct object stream, we have to clone every object in
the input.</p>
<p>A converter does not change the logical expression being evaluated; after
conversion, the number of rows and the values of those rows will still be the
same. By declaring itself to be a converter, a relational expression is
telling the planner about this equivalence, and the planner groups
expressions which are logically equivalent but have different physical traits
into groups called <code>RelSet</code>s.
<p>In principle one could devise converters which change multiple traits
simultaneously (say change the sort-order and the physical location of a
relational expression). In which case, the method <a href="../../../../../org/apache/calcite/rel/convert/Converter.html#getInputTraits--"><code>getInputTraits()</code></a>
would return a <a href="../../../../../org/apache/calcite/plan/RelTraitSet.html" title="org.apache.calcite.plan中的类"><code>RelTraitSet</code></a>. But for
simplicity, this class only allows one trait to be converted at a
time; all other traits are assumed to be preserved.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>嵌套类概要</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.calcite.rel.RelNode">
<!-- -->
</a>
<h3>从接口继承的嵌套类/接口&nbsp;org.apache.calcite.rel.<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a></h3>
<code><a href="../../../../../org/apache/calcite/rel/RelNode.Context.html" title="org.apache.calcite.rel中的接口">RelNode.Context</a></code></li>
</ul>
</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></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><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/Converter.html#getInput--">getInput</a></span>()</code>
<div class="block">Returns the sole input relational expression</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/calcite/plan/RelTraitSet.html" title="org.apache.calcite.plan中的类">RelTraitSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/convert/Converter.html#getInputTraits--">getInputTraits</a></span>()</code>
<div class="block">Returns the trait of the input relational expression.</div>
</td>
</tr>
<tr id="i2" 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/Converter.html#getTraitDef--">getTraitDef</a></span>()</code>
<div class="block">Returns the definition of trait which this converter works on.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.rel.RelNode">
<!-- -->
</a>
<h3>从接口继承的方法&nbsp;org.apache.calcite.rel.<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a></h3>
<code><a href="../../../../../org/apache/calcite/rel/RelNode.html#accept-org.apache.calcite.rel.RelShuttle-">accept</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#accept-org.apache.calcite.rex.RexShuttle-">accept</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#childrenAccept-org.apache.calcite.rel.RelVisitor-">childrenAccept</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#collectVariablesSet-java.util.Set-">collectVariablesSet</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#collectVariablesUsed-java.util.Set-">collectVariablesUsed</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#computeSelfCost-org.apache.calcite.plan.RelOptPlanner-">computeSelfCost</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#computeSelfCost-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.metadata.RelMetadataQuery-">computeSelfCost</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#copy-org.apache.calcite.plan.RelTraitSet-java.util.List-">copy</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#estimateRowCount-org.apache.calcite.rel.metadata.RelMetadataQuery-">estimateRowCount</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#explain-org.apache.calcite.rel.RelWriter-">explain</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getChildExps--">getChildExps</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getCollationList--">getCollationList</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getConvention--">getConvention</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getCorrelVariable--">getCorrelVariable</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getExpectedInputRowType-int-">getExpectedInputRowType</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getInput-int-">getInput</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getInputs--">getInputs</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getQuery--">getQuery</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRelTypeName--">getRelTypeName</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRows--">getRows</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getRowType--">getRowType</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getTable--">getTable</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getVariablesSet--">getVariablesSet</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#getVariablesStopped--">getVariablesStopped</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isDistinct--">isDistinct</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isKey-org.apache.calcite.util.ImmutableBitSet-">isKey</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isValid-boolean-">isValid</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#isValid-org.apache.calcite.util.Litmus-org.apache.calcite.rel.RelNode.Context-">isValid</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#metadata-java.lang.Class-org.apache.calcite.rel.metadata.RelMetadataQuery-">metadata</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#onRegister-org.apache.calcite.plan.RelOptPlanner-">onRegister</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#recomputeDigest--">recomputeDigest</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#register-org.apache.calcite.plan.RelOptPlanner-">register</a>, <a href="../../../../../org/apache/calcite/rel/RelNode.html#replaceInput-int-org.apache.calcite.rel.RelNode-">replaceInput</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.plan.RelOptNode">
<!-- -->
</a>
<h3>从接口继承的方法&nbsp;org.apache.calcite.plan.<a href="../../../../../org/apache/calcite/plan/RelOptNode.html" title="org.apache.calcite.plan中的接口">RelOptNode</a></h3>
<code><a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getCluster--">getCluster</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getDescription--">getDescription</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getDigest--">getDigest</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getId--">getId</a>, <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getTraitSet--">getTraitSet</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>方法详细资料</h3>
<a name="getInputTraits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputTraits</h4>
<pre><a href="../../../../../org/apache/calcite/plan/RelTraitSet.html" title="org.apache.calcite.plan中的类">RelTraitSet</a>&nbsp;getInputTraits()</pre>
<div class="block">Returns the trait of the input relational expression.</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>input trait</dd>
</dl>
</li>
</ul>
<a name="getTraitDef--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitDef</h4>
<pre><a href="../../../../../org/apache/calcite/plan/RelTraitDef.html" title="org.apache.calcite.plan中的类">RelTraitDef</a>&nbsp;getTraitDef()</pre>
<div class="block">Returns the definition of trait which this converter works on.
<p>The input relational expression (matched by the rule) must possess
this trait and have the value given by <a href="../../../../../org/apache/calcite/rel/convert/Converter.html#getInputTraits--"><code>getInputTraits()</code></a>, and the
traits of the output of this converter given by <a href="../../../../../org/apache/calcite/plan/RelOptNode.html#getTraitSet--"><code>RelOptNode.getTraitSet()</code></a> will
have one trait altered and the other orthogonal traits will be the same.</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>trait which this converter modifies</dd>
</dl>
</li>
</ul>
<a name="getInput--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInput</h4>
<pre><a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;getInput()</pre>
<div class="block">Returns the sole input relational expression</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>child relational expression</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>上一个类</li>
<li><a href="../../../../../org/apache/calcite/rel/convert/ConverterImpl.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/Converter.html" target="_top">框架</a></li>
<li><a href="Converter.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>字段&nbsp;|&nbsp;</li>
<li>构造器&nbsp;|&nbsp;</li>
<li><a href="#method.summary">方法</a></li>
</ul>
<ul class="subNavList">
<li>详细资料:&nbsp;</li>
<li>字段&nbsp;|&nbsp;</li>
<li>构造器&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>