blob: 9d71047a321970894809e8351be3432e1272a369 [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>Hintable (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="Hintable (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6,"i2":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/hint/CompositeHintPredicate.Composition.html" title="org.apache.calcite.rel.hint中的枚举"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../../org/apache/calcite/rel/hint/HintOptionChecker.html" title="org.apache.calcite.rel.hint中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/rel/hint/Hintable.html" target="_top">框架</a></li>
<li><a href="Hintable.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.hint</div>
<h2 title="接口 Hintable" class="title">接口 Hintable</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>所有已知实现类:</dt>
<dd><a href="../../../../../org/apache/calcite/rel/core/Aggregate.html" title="org.apache.calcite.rel.core中的类">Aggregate</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableAggregate.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableAggregate</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableJoin.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableJoin</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableProject.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableProject</a>, <a href="../../../../../org/apache/calcite/interpreter/Bindables.BindableTableScan.html" title="org.apache.calcite.interpreter中的类">Bindables.BindableTableScan</a>, <a href="../../../../../org/apache/calcite/rel/core/Calc.html" title="org.apache.calcite.rel.core中的类">Calc</a>, <a href="../../../../../org/apache/calcite/adapter/cassandra/CassandraProject.html" title="org.apache.calcite.adapter.cassandra中的类">CassandraProject</a>, <a href="../../../../../org/apache/calcite/adapter/cassandra/CassandraTableScan.html" title="org.apache.calcite.adapter.cassandra中的类">CassandraTableScan</a>, <a href="../../../../../org/apache/calcite/adapter/csv/CsvTableScan.html" title="org.apache.calcite.adapter.csv中的类">CsvTableScan</a>, <a href="../../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchAggregate.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchProject.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchProject</a>, <a href="../../../../../org/apache/calcite/adapter/elasticsearch/ElasticsearchTableScan.html" title="org.apache.calcite.adapter.elasticsearch中的类">ElasticsearchTableScan</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableAggregate.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableBatchNestedLoopJoin.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableBatchNestedLoopJoin</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableCalc.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableCalc</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableHashJoin.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableHashJoin</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableMergeJoin.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableMergeJoin</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableNestedLoopJoin.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableNestedLoopJoin</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableProject.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableProject</a>, <a href="../../../../../org/apache/calcite/adapter/enumerable/EnumerableTableScan.html" title="org.apache.calcite.adapter.enumerable中的类">EnumerableTableScan</a>, <a href="../../../../../org/apache/calcite/rel/core/EquiJoin.html" title="org.apache.calcite.rel.core中的类">EquiJoin</a>, <a href="../../../../../org/apache/calcite/rel/rules/EquiJoin.html" title="org.apache.calcite.rel.rules中的类">EquiJoin</a>, <a href="../../../../../org/apache/calcite/adapter/geode/rel/GeodeAggregate.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/geode/rel/GeodeProject.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeProject</a>, <a href="../../../../../org/apache/calcite/adapter/geode/rel/GeodeTableScan.html" title="org.apache.calcite.adapter.geode.rel中的类">GeodeTableScan</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcAggregate.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcJoin.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcJoin</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcRules.JdbcProject.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcRules.JdbcProject</a>, <a href="../../../../../org/apache/calcite/adapter/jdbc/JdbcTableScan.html" title="org.apache.calcite.adapter.jdbc中的类">JdbcTableScan</a>, <a href="../../../../../org/apache/calcite/rel/core/Join.html" title="org.apache.calcite.rel.core中的类">Join</a>, <a href="../../../../../org/apache/calcite/rel/logical/LogicalAggregate.html" title="org.apache.calcite.rel.logical中的类">LogicalAggregate</a>, <a href="../../../../../org/apache/calcite/rel/logical/LogicalCalc.html" title="org.apache.calcite.rel.logical中的类">LogicalCalc</a>, <a href="../../../../../org/apache/calcite/rel/logical/LogicalJoin.html" title="org.apache.calcite.rel.logical中的类">LogicalJoin</a>, <a href="../../../../../org/apache/calcite/rel/logical/LogicalProject.html" title="org.apache.calcite.rel.logical中的类">LogicalProject</a>, <a href="../../../../../org/apache/calcite/rel/logical/LogicalTableScan.html" title="org.apache.calcite.rel.logical中的类">LogicalTableScan</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoAggregate.html" title="org.apache.calcite.adapter.mongodb中的类">MongoAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoProject.html" title="org.apache.calcite.adapter.mongodb中的类">MongoProject</a>, <a href="../../../../../org/apache/calcite/adapter/mongodb/MongoTableScan.html" title="org.apache.calcite.adapter.mongodb中的类">MongoTableScan</a>, <a href="../../../../../org/apache/calcite/adapter/pig/PigAggregate.html" title="org.apache.calcite.adapter.pig中的类">PigAggregate</a>, <a href="../../../../../org/apache/calcite/adapter/pig/PigJoin.html" title="org.apache.calcite.adapter.pig中的类">PigJoin</a>, <a href="../../../../../org/apache/calcite/adapter/pig/PigProject.html" title="org.apache.calcite.adapter.pig中的类">PigProject</a>, <a href="../../../../../org/apache/calcite/adapter/pig/PigTableScan.html" title="org.apache.calcite.adapter.pig中的类">PigTableScan</a>, <a href="../../../../../org/apache/calcite/rel/core/Project.html" title="org.apache.calcite.rel.core中的类">Project</a>, <a href="../../../../../org/apache/calcite/adapter/splunk/SplunkTableScan.html" title="org.apache.calcite.adapter.splunk中的类">SplunkTableScan</a>, <a href="../../../../../org/apache/calcite/schema/impl/StarTable.StarTableScan.html" title="org.apache.calcite.schema.impl中的类">StarTable.StarTableScan</a>, <a href="../../../../../org/apache/calcite/rel/core/TableScan.html" title="org.apache.calcite.rel.core中的类">TableScan</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Hintable</span></pre>
<div class="block"><a href="../../../../../org/apache/calcite/rel/hint/Hintable.html" title="org.apache.calcite.rel.hint中的接口"><code>Hintable</code></a> is a kind of <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口"><code>RelNode</code></a> that can attach <a href="../../../../../org/apache/calcite/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类"><code>RelHint</code></a>s.
<p>This interface is experimental, <a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口"><code>RelNode</code></a>s that implement it
have a constructor parameter named "hints" used to construct relational expression
with given hints.
<p>Current design is not that elegant and mature, because we have to
copy the hints whenever these relational expressions are copied or used to
derive new relational expressions.
Even though we have implemented the mechanism to propagate the hints, for large queries,
there would be many cases where the hints are not copied to the right RelNode,
and the effort/memory is wasted if we are copying the hint to a RelNode
but the hint is not used.</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>default <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/hint/Hintable.html#attachHints-java.util.List-">attachHints</a></span>(<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/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类">RelHint</a>&gt;&nbsp;hintList)</code>
<div class="block">Attaches list of hints to this relational expression.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../../../../../org/apache/calcite/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类">RelHint</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/hint/Hintable.html#getHints--">getHints</a></span>()</code>
<div class="block">Returns the hints of this relational expressions as an immutable list.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <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/hint/Hintable.html#withHints-java.util.List-">withHints</a></span>(<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/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类">RelHint</a>&gt;&nbsp;hintList)</code>
<div class="block">Returns a new relational expression with the specified hints <code>hintList</code>.</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="attachHints-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attachHints</h4>
<pre>default&nbsp;<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;attachHints(<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/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类">RelHint</a>&gt;&nbsp;hintList)</pre>
<div class="block">Attaches list of hints to this relational expression.
<p>This method is only for internal use during sql-to-rel conversion.
<p>Sub-class should return a new copy of the relational expression.
<p>The default implementation merges the given hints with existing ones,
put them in one list and eliminate the duplicates; then
returns a new copy of this relational expression with the merged hints.</div>
<dl>
<dt><span class="paramLabel">参数:</span></dt>
<dd><code>hintList</code> - The hints to attach to this relational expression</dd>
<dt><span class="returnLabel">返回:</span></dt>
<dd>Relational expression with the hints <code>hintList</code> attached</dd>
</dl>
</li>
</ul>
<a name="withHints-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withHints</h4>
<pre>default&nbsp;<a href="../../../../../org/apache/calcite/rel/RelNode.html" title="org.apache.calcite.rel中的接口">RelNode</a>&nbsp;withHints(<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/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类">RelHint</a>&gt;&nbsp;hintList)</pre>
<div class="block">Returns a new relational expression with the specified hints <code>hintList</code>.
<p>This method should be overridden by every logical node that supports hint.
It is only for internal use during decorrelation.
<p>Sub-class should return a new copy of the relational expression.
<p>The default implementation returns the relational expression directly
only because not every kind of relational expression supports hints.</div>
<dl>
<dt><span class="returnLabel">返回:</span></dt>
<dd>Relational expression with set up hints</dd>
</dl>
</li>
</ul>
<a name="getHints--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getHints</h4>
<pre>com.google.common.collect.ImmutableList&lt;<a href="../../../../../org/apache/calcite/rel/hint/RelHint.html" title="org.apache.calcite.rel.hint中的类">RelHint</a>&gt;&nbsp;getHints()</pre>
<div class="block">Returns the hints of this relational expressions as an immutable list.</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/hint/CompositeHintPredicate.Composition.html" title="org.apache.calcite.rel.hint中的枚举"><span class="typeNameLink">上一个类</span></a></li>
<li><a href="../../../../../org/apache/calcite/rel/hint/HintOptionChecker.html" title="org.apache.calcite.rel.hint中的接口"><span class="typeNameLink">下一个类</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/rel/hint/Hintable.html" target="_top">框架</a></li>
<li><a href="Hintable.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>