blob: 9d13f25488e24bcbf4eb63d5f53fc912162b730d [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>Metadata (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="Metadata (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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><a href="../../../../../org/apache/calcite/rel/metadata/JaninoRelMetadataProvider.NoHandler.html" title="org.apache.calcite.rel.metadata中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../../org/apache/calcite/rel/metadata/MetadataDef.html" title="org.apache.calcite.rel.metadata中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/rel/metadata/Metadata.html" target="_top">框架</a></li>
<li><a href="Metadata.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.metadata</div>
<h2 title="接口 Metadata" class="title">接口 Metadata</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知子接口:</dt>
<dd><a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.AllPredicates.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.AllPredicates</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Collation.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Collation</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.ColumnOrigin.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.ColumnOrigin</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.ColumnUniqueness.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.ColumnUniqueness</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.CumulativeCost.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.CumulativeCost</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.DistinctRowCount.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.DistinctRowCount</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Distribution.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Distribution</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.ExplainVisibility.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.ExplainVisibility</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.ExpressionLineage.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.ExpressionLineage</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.MaxRowCount.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.MaxRowCount</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Memory.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Memory</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.MinRowCount.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.MinRowCount</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.NodeTypes.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.NodeTypes</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.NonCumulativeCost.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.NonCumulativeCost</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Parallelism.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Parallelism</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.PercentageOriginalRows.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.PercentageOriginalRows</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.PopulationSize.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.PopulationSize</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Predicates.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Predicates</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.RowCount.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.RowCount</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Selectivity.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Selectivity</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.Size.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.Size</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.TableReferences.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.TableReferences</a>, <a href="../../../../../org/apache/calcite/rel/metadata/BuiltInMetadata.UniqueKeys.html" title="org.apache.calcite.rel.metadata中的接口">BuiltInMetadata.UniqueKeys</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Metadata</span></pre>
<div class="block">Metadata about a relational expression.
<p>For particular types of metadata, a sub-class defines one of more methods
to query that metadata. Then a <a href="../../../../../org/apache/calcite/rel/metadata/RelMetadataProvider.html" title="org.apache.calcite.rel.metadata中的接口"><code>RelMetadataProvider</code></a> can offer those
kinds of metadata for particular sub-classes of <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口"><code>RelNode</code></a>.
<p>User code (typically in a planner rule or an implementation of
<a href="../../../../../org/apache/calcite/rel/RelNode.html#computeSelfCost-org.apache.calcite.plan.RelOptPlanner-org.apache.calcite.rel.metadata.RelMetadataQuery-"><code>RelNode.computeSelfCost(org.apache.calcite.plan.RelOptPlanner, RelMetadataQuery)</code></a>)
acquires a <code>Metadata</code> instance by calling <a href="../../../../../org/apache/calcite/rel/RelNode.html#metadata-java.lang.Class-org.apache.calcite.rel.metadata.RelMetadataQuery-"><code>RelNode.metadata(java.lang.Class&lt;M&gt;, org.apache.calcite.rel.metadata.RelMetadataQuery)</code></a>.
<p>A <code>Metadata</code> instance already knows which particular <code>RelNode</code>
it is describing, so the methods do not pass in the <code>RelNode</code>. In fact,
quite a few metadata methods have no extra parameters. For instance, you can
get the row-count as follows:</p>
<blockquote><pre><code>
RelNode rel;
double rowCount = rel.metadata(RowCount.class).rowCount();
</code></pre></blockquote></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></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/metadata/Metadata.html#rel--">rel</a></span>()</code>
<div class="block">Returns the relational expression that this metadata is about.</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="rel--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rel</h4>
<pre><a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;rel()</pre>
<div class="block">Returns the relational expression that this metadata is about.</div>
</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/metadata/JaninoRelMetadataProvider.NoHandler.html" title="org.apache.calcite.rel.metadata中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../../org/apache/calcite/rel/metadata/MetadataDef.html" title="org.apache.calcite.rel.metadata中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/rel/metadata/Metadata.html" target="_top">框架</a></li>
<li><a href="Metadata.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>