Google Git
Sign in
apache / calcite-site / bf7470eb6bf1d52715d1d602e33af45602b82bc0 / . / apidocs / javadocAggregate / org / apache / calcite / plan / RelTrait.html
blob: b4ed9551ee3890be18bc98f14d73518d7f327f5d [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>RelTrait (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="RelTrait (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/plan/RelOptUtil.VariableUsedVisitor.html" title="org.apache.calcite.plan中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="org.apache.calcite.plan中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/plan/RelTrait.html" target="_top">框架</a></li>
<li><a href="RelTrait.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.plan</div>
<h2 title="接口 RelTrait" class="title">接口 RelTrait</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知子接口:</dt>
<dd><a href="../../../../org/apache/calcite/plan/Convention.html" title="org.apache.calcite.plan中的接口">Convention</a>, <a href="../../../../org/apache/calcite/rel/RelCollation.html" title="org.apache.calcite.rel中的接口">RelCollation</a>, <a href="../../../../org/apache/calcite/rel/RelDistribution.html" title="org.apache.calcite.rel中的接口">RelDistribution</a>, <a href="../../../../org/apache/calcite/plan/RelMultipleTrait.html" title="org.apache.calcite.plan中的接口">RelMultipleTrait</a></dd>
</dl>
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../org/apache/calcite/interpreter/BindableConvention.html" title="org.apache.calcite.interpreter中的枚举">BindableConvention</a>, <a href="../../../../org/apache/calcite/plan/Convention.Impl.html" title="org.apache.calcite.plan中的类">Convention.Impl</a>, <a href="../../../../org/apache/calcite/adapter/enumerable/EnumerableConvention.html" title="org.apache.calcite.adapter.enumerable中的枚举">EnumerableConvention</a>, <a href="../../../../org/apache/calcite/interpreter/InterpretableConvention.html" title="org.apache.calcite.interpreter中的枚举">InterpretableConvention</a>, <a href="../../../../org/apache/calcite/adapter/jdbc/JdbcConvention.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcConvention</a>, <a href="../../../../org/apache/calcite/rel/RelCollationImpl.html" title="org.apache.calcite.rel中的类">RelCollationImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RelTrait</span></pre>
<div class="block">RelTrait represents the manifestation of a relational expression trait within
a trait definition. For example, a <code>CallingConvention.JAVA</code> is a trait
of the <a href="../../../../org/apache/calcite/plan/ConventionTraitDef.html" title="org.apache.calcite.plan中的类"><code>ConventionTraitDef</code></a> trait definition.
<h2><a id="EqualsHashCodeNote">Note about equals() and hashCode()</a></h2>
<p>If all instances of RelTrait for a particular RelTraitDef are defined in
an <code>enum</code> and no new RelTraits can be introduced at runtime, you need
not override <a href="../../../../org/apache/calcite/plan/RelTrait.html#hashCode--"><code>hashCode()</code></a> and <a href="../../../../org/apache/calcite/plan/RelTrait.html#equals-java.lang.Object-"><code>equals(Object)</code></a>. If, however,
new RelTrait instances are generated at runtime (e.g. based on state external
to the planner), you must implement <a href="../../../../org/apache/calcite/plan/RelTrait.html#hashCode--"><code>hashCode()</code></a> and
<a href="../../../../org/apache/calcite/plan/RelTrait.html#equals-java.lang.Object-"><code>equals(Object)</code></a> for proper <a href="../../../../org/apache/calcite/plan/RelTraitDef.html#canonize-T-"><code>canonization</code></a>
of your RelTrait objects.</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></caption>
<tr>
<th class="colFirst" scope="col">限定符和类型</th>
<th class="colLast" scope="col">方法和说明</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTrait.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&nbsp;o)</code>
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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/plan/RelTrait.html#getTraitDef--">getTraitDef</a></span>()</code>
<div class="block">Returns the RelTraitDef that defines this RelTrait.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTrait.html#hashCode--">hashCode</a></span>()</code>
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTrait.html#register-org.apache.calcite.plan.RelOptPlanner-">register</a></span>(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="org.apache.calcite.plan中的接口">RelOptPlanner</a>&nbsp;planner)</code>
<div class="block">Registers a trait instance with the planner.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTrait.html#satisfies-org.apache.calcite.plan.RelTrait-">satisfies</a></span>(<a href="../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;trait)</code>
<div class="block">Returns whether this trait satisfies a given trait.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/plan/RelTrait.html#toString--">toString</a></span>()</code>
<div class="block">Returns a succinct name for this trait.</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="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 RelTraitDef that defines this RelTrait.</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>the RelTraitDef that defines this RelTrait</dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>int&nbsp;hashCode()</pre>
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">覆盖:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="java.lang中的类或接口">hashCode</a></code>&nbsp;在类中&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a>&nbsp;o)</pre>
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">覆盖:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="java.lang中的类或接口">equals</a></code>&nbsp;在类中&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="satisfies-org.apache.calcite.plan.RelTrait-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>satisfies</h4>
<pre>boolean&nbsp;satisfies(<a href="../../../../org/apache/calcite/plan/RelTrait.html" title="org.apache.calcite.plan中的接口">RelTrait</a>&nbsp;trait)</pre>
<div class="block">Returns whether this trait satisfies a given trait.
<p>A trait satisfies another if it is the same or stricter. For example,
<code>ORDER BY x, y</code> satisfies <code>ORDER BY x</code>.
<p>A trait's <code>satisfies</code> relation must be a partial order (reflexive,
anti-symmetric, transitive). Many traits cannot be "loosened"; their
<code>satisfies</code> is an equivalence relation, where only X satisfies X.
<p>If a trait has multiple values
(see <code>RelCompositeTrait</code>)
a collection (T0, T1, ...) satisfies T if any Ti satisfies T.</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>trait</code> - Given trait</dd>
<dt><span class="returnLabel">返回:</span></dt>
<dd>Whether this trait subsumes a given trait</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="java.lang中的类或接口">String</a>&nbsp;toString()</pre>
<div class="block">Returns a succinct name for this trait. The planner may use this String
to describe the trait.</div>
<dl>
<dt><span class="overrideSpecifyLabel">覆盖:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="java.lang中的类或接口">toString</a></code>&nbsp;在类中&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="java.lang中的类或接口">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="register-org.apache.calcite.plan.RelOptPlanner-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>register</h4>
<pre>void&nbsp;register(<a href="../../../../org/apache/calcite/plan/RelOptPlanner.html" title="org.apache.calcite.plan中的接口">RelOptPlanner</a>&nbsp;planner)</pre>
<div class="block">Registers a trait instance with the planner.
<p>This is an opportunity to add rules that relate to that trait. However,
typical implementations will do nothing.</p></div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>planner</code> - Planner</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/plan/RelOptUtil.VariableUsedVisitor.html" title="org.apache.calcite.plan中的类"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../org/apache/calcite/plan/RelTraitDef.html" title="org.apache.calcite.plan中的类"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/plan/RelTrait.html" target="_top">框架</a></li>
<li><a href="RelTrait.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>