Google Git
Sign in
apache / calcite-site / bf7470eb6bf1d52715d1d602e33af45602b82bc0 / . / apidocs / javadocAggregate / org / apache / calcite / rel / RelWriter.html
blob: 7c86c926e8a2a718f4c9fc2357f61fe2a532e434 [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>RelWriter (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="RelWriter (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":6,"i5":18,"i6":18,"i7":18};
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"],16:["t5","默认方法"]};
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/RelVisitor.html" title="org.apache.calcite.rel中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/rel/SingleRel.html" title="org.apache.calcite.rel中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/rel/RelWriter.html" target="_top">框架</a></li>
<li><a href="RelWriter.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</div>
<h2 title="接口 RelWriter" class="title">接口 RelWriter</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../org/apache/calcite/rel/externalize/RelJsonWriter.html" title="org.apache.calcite.rel.externalize中的类">RelJsonWriter</a>, <a href="../../../../org/apache/calcite/rel/externalize/RelWriterImpl.html" title="org.apache.calcite.rel.externalize中的类">RelWriterImpl</a>, <a href="../../../../org/apache/calcite/rel/externalize/RelXmlWriter.html" title="org.apache.calcite.rel.externalize中的类">RelXmlWriter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RelWriter</span></pre>
<div class="block">Callback for an expression to dump itself to.
<p>It is used for generating EXPLAIN PLAN output, and also for serializing
a tree of relational expressions to JSON.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t5" class="tableTab"><span><a href="javascript:show(16);">默认方法</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/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#done-org.apache.calcite.rel.RelNode-">done</a></span>(<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;node)</code>
<div class="block">Writes the completed explanation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#explain-org.apache.calcite.rel.RelNode-java.util.List-">explain</a></span>(<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;rel,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">List</a>&lt;<a href="../../../../org/apache/calcite/util/Pair.html" title="org.apache.calcite.util中的类">Pair</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&gt;&gt;&nbsp;valueList)</code>
<div class="block">Prints an explanation of a node, with a list of (term, value) pairs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlExplainLevel.html" title="org.apache.calcite.sql中的枚举">SqlExplainLevel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#getDetailLevel--">getDetailLevel</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#input-java.lang.String-org.apache.calcite.rel.RelNode-">input</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;term,
<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;input)</code>
<div class="block">Adds an input to the explanation of the current node.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#item-java.lang.String-java.lang.Object-">item</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;term,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&nbsp;value)</code>
<div class="block">Adds an attribute to the explanation of the current node.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#itemIf-java.lang.String-java.lang.Object-boolean-">itemIf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;term,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&nbsp;value,
boolean&nbsp;condition)</code>
<div class="block">Adds an input to the explanation of the current node, if a condition
holds.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>default boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#nest--">nest</a></span>()</code>
<div class="block">Returns whether the writer prefers nested values.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../org/apache/calcite/rex/RexNode.Closeable.html" title="org.apache.calcite.rex中的接口">RexNode.Closeable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/rel/RelWriter.html#withRexNormalize--">withRexNormalize</a></span>()</code>
<div class="block">Activates <a href="../../../../org/apache/calcite/rex/RexNode.html" title="org.apache.calcite.rex中的类"><code>RexNode</code></a> normalization if <a href="../../../../org/apache/calcite/sql/SqlExplainLevel.html#DIGEST_ATTRIBUTES"><code>SqlExplainLevel.DIGEST_ATTRIBUTES</code></a> is used.</div>
</td>
</tr>
</table>
</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="explain-org.apache.calcite.rel.RelNode-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explain</h4>
<pre>void&nbsp;explain(<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;rel,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="java.util中的类或接口">List</a>&lt;<a href="../../../../org/apache/calcite/util/Pair.html" title="org.apache.calcite.util中的类">Pair</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&gt;&gt;&nbsp;valueList)</pre>
<div class="block">Prints an explanation of a node, with a list of (term, value) pairs.
<p>The term-value pairs are generally gathered by calling
<a href="../../../../org/apache/calcite/rel/RelNode.html#explain-org.apache.calcite.rel.RelWriter-"><code>RelNode.explain(RelWriter)</code></a>.
Each sub-class of <a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口"><code>RelNode</code></a>
calls <a href="../../../../org/apache/calcite/rel/RelWriter.html#input-java.lang.String-org.apache.calcite.rel.RelNode-"><code>input(String, org.apache.calcite.rel.RelNode)</code></a>
and <a href="../../../../org/apache/calcite/rel/RelWriter.html#item-java.lang.String-java.lang.Object-"><code>item(String, Object)</code></a> to declare term-value pairs.</p></div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>rel</code> - Relational expression</dd>
<dd><code>valueList</code> - List of term-value pairs</dd>
</dl>
</li>
</ul>
<a name="getDetailLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDetailLevel</h4>
<pre><a href="../../../../org/apache/calcite/sql/SqlExplainLevel.html" title="org.apache.calcite.sql中的枚举">SqlExplainLevel</a>&nbsp;getDetailLevel()</pre>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>detail level at which plan should be generated</dd>
</dl>
</li>
</ul>
<a name="input-java.lang.String-org.apache.calcite.rel.RelNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>input</h4>
<pre>default&nbsp;<a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a>&nbsp;input(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;term,
<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;input)</pre>
<div class="block">Adds an input to the explanation of the current node.</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>term</code> - Term for input, e.g. "left" or "input #1".</dd>
<dd><code>input</code> - Input relational expression</dd>
</dl>
</li>
</ul>
<a name="item-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>item</h4>
<pre><a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a>&nbsp;item(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;term,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&nbsp;value)</pre>
<div class="block">Adds an attribute to the explanation of the current node.</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>term</code> - Term for attribute, e.g. "joinType"</dd>
<dd><code>value</code> - Attribute value</dd>
</dl>
</li>
</ul>
<a name="itemIf-java.lang.String-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>itemIf</h4>
<pre>default&nbsp;<a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a>&nbsp;itemIf(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;term,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&nbsp;value,
boolean&nbsp;condition)</pre>
<div class="block">Adds an input to the explanation of the current node, if a condition
holds.</div>
</li>
</ul>
<a name="done-org.apache.calcite.rel.RelNode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>done</h4>
<pre><a href="../../../../org/apache/calcite/rel/RelWriter.html" title="org.apache.calcite.rel中的接口">RelWriter</a>&nbsp;done(<a href="../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;node)</pre>
<div class="block">Writes the completed explanation.</div>
</li>
</ul>
<a name="nest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nest</h4>
<pre>default&nbsp;boolean&nbsp;nest()</pre>
<div class="block">Returns whether the writer prefers nested values. Traditional explain
writers prefer flattened values.</div>
</li>
</ul>
<a name="withRexNormalize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withRexNormalize</h4>
<pre>@API(since="1.22",
status=EXPERIMENTAL)
default&nbsp;<a href="../../../../org/apache/calcite/rex/RexNode.Closeable.html" title="org.apache.calcite.rex中的接口">RexNode.Closeable</a>&nbsp;withRexNormalize()</pre>
<div class="block">Activates <a href="../../../../org/apache/calcite/rex/RexNode.html" title="org.apache.calcite.rex中的类"><code>RexNode</code></a> normalization if <a href="../../../../org/apache/calcite/sql/SqlExplainLevel.html#DIGEST_ATTRIBUTES"><code>SqlExplainLevel.DIGEST_ATTRIBUTES</code></a> is used.
Note: the returned value must be closed, and the API is designed to be used with a
try-with-resources.</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>a handle that should be closed to revert normalization state</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/RelVisitor.html" title="org.apache.calcite.rel中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/rel/SingleRel.html" title="org.apache.calcite.rel中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/rel/RelWriter.html" target="_top">框架</a></li>
<li><a href="RelWriter.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>