Google Git
Sign in
apache / calcite-site / 73438994d0eddb47732e4af32867ba1810011b6b / . / javadocAggregate / org / apache / calcite / rel / hint / Hintable.html
blob: b9a6f22139417f3977cd2e8a7cda07a3e04b6e2b [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Hintable (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.rel.hint, interface: Hintable">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rel.hint</a></div>
<h1 title="Interface Hintable" class="title">Interface Hintable</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../core/Aggregate.html" title="class in org.apache.calcite.rel.core">Aggregate</a></code>, <code><a href="../../interpreter/Bindables.BindableAggregate.html" title="class in org.apache.calcite.interpreter">Bindables.BindableAggregate</a></code>, <code><a href="../../interpreter/Bindables.BindableFilter.html" title="class in org.apache.calcite.interpreter">Bindables.BindableFilter</a></code>, <code><a href="../../interpreter/Bindables.BindableIntersect.html" title="class in org.apache.calcite.interpreter">Bindables.BindableIntersect</a></code>, <code><a href="../../interpreter/Bindables.BindableJoin.html" title="class in org.apache.calcite.interpreter">Bindables.BindableJoin</a></code>, <code><a href="../../interpreter/Bindables.BindableMinus.html" title="class in org.apache.calcite.interpreter">Bindables.BindableMinus</a></code>, <code><a href="../../interpreter/Bindables.BindableProject.html" title="class in org.apache.calcite.interpreter">Bindables.BindableProject</a></code>, <code><a href="../../interpreter/Bindables.BindableSort.html" title="class in org.apache.calcite.interpreter">Bindables.BindableSort</a></code>, <code><a href="../../interpreter/Bindables.BindableTableScan.html" title="class in org.apache.calcite.interpreter">Bindables.BindableTableScan</a></code>, <code><a href="../../interpreter/Bindables.BindableUnion.html" title="class in org.apache.calcite.interpreter">Bindables.BindableUnion</a></code>, <code><a href="../../interpreter/Bindables.BindableValues.html" title="class in org.apache.calcite.interpreter">Bindables.BindableValues</a></code>, <code><a href="../../interpreter/Bindables.BindableWindow.html" title="class in org.apache.calcite.interpreter">Bindables.BindableWindow</a></code>, <code><a href="../core/Calc.html" title="class in org.apache.calcite.rel.core">Calc</a></code>, <code><a href="../../adapter/cassandra/CassandraFilter.html" title="class in org.apache.calcite.adapter.cassandra">CassandraFilter</a></code>, <code><a href="../../adapter/cassandra/CassandraProject.html" title="class in org.apache.calcite.adapter.cassandra">CassandraProject</a></code>, <code><a href="../../adapter/cassandra/CassandraSort.html" title="class in org.apache.calcite.adapter.cassandra">CassandraSort</a></code>, <code><a href="../../adapter/cassandra/CassandraTableScan.html" title="class in org.apache.calcite.adapter.cassandra">CassandraTableScan</a></code>, <code><a href="../core/Correlate.html" title="class in org.apache.calcite.rel.core">Correlate</a></code>, <code><a href="../../adapter/csv/CsvTableScan.html" title="class in org.apache.calcite.adapter.csv">CsvTableScan</a></code>, <code><a href="../../adapter/file/CsvTableScan.html" title="class in org.apache.calcite.adapter.file">CsvTableScan</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchAggregate.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchAggregate</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchFilter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchFilter</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchProject.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchProject</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchSort.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchSort</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchTableScan.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchTableScan</a></code>, <code><a href="../../adapter/enumerable/EnumerableAggregate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregate</a></code>, <code><a href="../../adapter/enumerable/EnumerableAggregateBase.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableAggregateBase</a></code>, <code><a href="../../adapter/enumerable/EnumerableBatchNestedLoopJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableBatchNestedLoopJoin</a></code>, <code><a href="../../adapter/enumerable/EnumerableCalc.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCalc</a></code>, <code><a href="../../adapter/enumerable/EnumerableCorrelate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableCorrelate</a></code>, <code><a href="../../adapter/enumerable/EnumerableFilter.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableFilter</a></code>, <code><a href="../../adapter/enumerable/EnumerableHashJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableHashJoin</a></code>, <code><a href="../../adapter/enumerable/EnumerableIntersect.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableIntersect</a></code>, <code><a href="../../adapter/enumerable/EnumerableLimitSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableLimitSort</a></code>, <code><a href="../../adapter/enumerable/EnumerableMergeJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMergeJoin</a></code>, <code><a href="../../adapter/enumerable/EnumerableMergeUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMergeUnion</a></code>, <code><a href="../../adapter/enumerable/EnumerableMinus.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableMinus</a></code>, <code><a href="../../adapter/enumerable/EnumerableNestedLoopJoin.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableNestedLoopJoin</a></code>, <code><a href="../../adapter/enumerable/EnumerableProject.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableProject</a></code>, <code><a href="../../adapter/enumerable/EnumerableSort.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSort</a></code>, <code><a href="../../adapter/enumerable/EnumerableSortedAggregate.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableSortedAggregate</a></code>, <code><a href="../../adapter/enumerable/EnumerableTableScan.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableTableScan</a></code>, <code><a href="../../adapter/enumerable/EnumerableUnion.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableUnion</a></code>, <code><a href="../../adapter/enumerable/EnumerableValues.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableValues</a></code>, <code><a href="../../adapter/enumerable/EnumerableWindow.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableWindow</a></code>, <code><a href="../core/EquiJoin.html" title="class in org.apache.calcite.rel.core">EquiJoin</a></code>, <code><a href="../rules/EquiJoin.html" title="class in org.apache.calcite.rel.rules">EquiJoin</a></code>, <code><a href="../core/Filter.html" title="class in org.apache.calcite.rel.core">Filter</a></code>, <code><a href="../../adapter/geode/rel/GeodeAggregate.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeAggregate</a></code>, <code><a href="../../adapter/geode/rel/GeodeFilter.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeFilter</a></code>, <code><a href="../../adapter/geode/rel/GeodeProject.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeProject</a></code>, <code><a href="../../adapter/geode/rel/GeodeSort.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeSort</a></code>, <code><a href="../../adapter/geode/rel/GeodeTableScan.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeTableScan</a></code>, <code><a href="../../adapter/innodb/InnodbFilter.html" title="class in org.apache.calcite.adapter.innodb">InnodbFilter</a></code>, <code><a href="../../adapter/innodb/InnodbProject.html" title="class in org.apache.calcite.adapter.innodb">InnodbProject</a></code>, <code><a href="../../adapter/innodb/InnodbSort.html" title="class in org.apache.calcite.adapter.innodb">InnodbSort</a></code>, <code><a href="../../adapter/innodb/InnodbTableScan.html" title="class in org.apache.calcite.adapter.innodb">InnodbTableScan</a></code>, <code><a href="../core/Intersect.html" title="class in org.apache.calcite.rel.core">Intersect</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcAggregate.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcAggregate</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcFilter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcFilter</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcIntersect.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcIntersect</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcJoin.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcJoin</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcMinus.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcMinus</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcProject.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcProject</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcSort.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcSort</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcUnion.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcUnion</a></code>, <code><a href="../../adapter/jdbc/JdbcRules.JdbcValues.html" title="class in org.apache.calcite.adapter.jdbc">JdbcRules.JdbcValues</a></code>, <code><a href="../../adapter/jdbc/JdbcTableScan.html" title="class in org.apache.calcite.adapter.jdbc">JdbcTableScan</a></code>, <code><a href="../core/Join.html" title="class in org.apache.calcite.rel.core">Join</a></code>, <code><a href="../logical/LogicalAggregate.html" title="class in org.apache.calcite.rel.logical">LogicalAggregate</a></code>, <code><a href="../logical/LogicalCalc.html" title="class in org.apache.calcite.rel.logical">LogicalCalc</a></code>, <code><a href="../logical/LogicalCorrelate.html" title="class in org.apache.calcite.rel.logical">LogicalCorrelate</a></code>, <code><a href="../logical/LogicalFilter.html" title="class in org.apache.calcite.rel.logical">LogicalFilter</a></code>, <code><a href="../logical/LogicalIntersect.html" title="class in org.apache.calcite.rel.logical">LogicalIntersect</a></code>, <code><a href="../logical/LogicalJoin.html" title="class in org.apache.calcite.rel.logical">LogicalJoin</a></code>, <code><a href="../logical/LogicalMinus.html" title="class in org.apache.calcite.rel.logical">LogicalMinus</a></code>, <code><a href="../logical/LogicalProject.html" title="class in org.apache.calcite.rel.logical">LogicalProject</a></code>, <code><a href="../logical/LogicalSort.html" title="class in org.apache.calcite.rel.logical">LogicalSort</a></code>, <code><a href="../logical/LogicalTableScan.html" title="class in org.apache.calcite.rel.logical">LogicalTableScan</a></code>, <code><a href="../logical/LogicalUnion.html" title="class in org.apache.calcite.rel.logical">LogicalUnion</a></code>, <code><a href="../logical/LogicalValues.html" title="class in org.apache.calcite.rel.logical">LogicalValues</a></code>, <code><a href="../logical/LogicalWindow.html" title="class in org.apache.calcite.rel.logical">LogicalWindow</a></code>, <code><a href="../core/Minus.html" title="class in org.apache.calcite.rel.core">Minus</a></code>, <code><a href="../../adapter/mongodb/MongoAggregate.html" title="class in org.apache.calcite.adapter.mongodb">MongoAggregate</a></code>, <code><a href="../../adapter/mongodb/MongoFilter.html" title="class in org.apache.calcite.adapter.mongodb">MongoFilter</a></code>, <code><a href="../../adapter/mongodb/MongoProject.html" title="class in org.apache.calcite.adapter.mongodb">MongoProject</a></code>, <code><a href="../../adapter/mongodb/MongoSort.html" title="class in org.apache.calcite.adapter.mongodb">MongoSort</a></code>, <code><a href="../../adapter/mongodb/MongoTableScan.html" title="class in org.apache.calcite.adapter.mongodb">MongoTableScan</a></code>, <code><a href="../../adapter/pig/PigAggregate.html" title="class in org.apache.calcite.adapter.pig">PigAggregate</a></code>, <code><a href="../../adapter/pig/PigFilter.html" title="class in org.apache.calcite.adapter.pig">PigFilter</a></code>, <code><a href="../../adapter/pig/PigJoin.html" title="class in org.apache.calcite.adapter.pig">PigJoin</a></code>, <code><a href="../../adapter/pig/PigProject.html" title="class in org.apache.calcite.adapter.pig">PigProject</a></code>, <code><a href="../../adapter/pig/PigTableScan.html" title="class in org.apache.calcite.adapter.pig">PigTableScan</a></code>, <code><a href="../core/Project.html" title="class in org.apache.calcite.rel.core">Project</a></code>, <code><a href="../core/SetOp.html" title="class in org.apache.calcite.rel.core">SetOp</a></code>, <code><a href="../core/Sort.html" title="class in org.apache.calcite.rel.core">Sort</a></code>, <code><a href="../../adapter/spark/SparkRules.SparkValues.html" title="class in org.apache.calcite.adapter.spark">SparkRules.SparkValues</a></code>, <code><a href="../../adapter/splunk/SplunkTableScan.html" title="class in org.apache.calcite.adapter.splunk">SplunkTableScan</a></code>, <code><a href="../../test/SqlToRelTestBase.CustomCorrelate.html" title="class in org.apache.calcite.test">SqlToRelTestBase.CustomCorrelate</a></code>, <code><a href="../../schema/impl/StarTable.StarTableScan.html" title="class in org.apache.calcite.schema.impl">StarTable.StarTableScan</a></code>, <code><a href="../core/TableScan.html" title="class in org.apache.calcite.rel.core">TableScan</a></code>, <code><a href="../core/Union.html" title="class in org.apache.calcite.rel.core">Union</a></code>, <code><a href="../core/Values.html" title="class in org.apache.calcite.rel.core">Values</a></code>, <code><a href="../core/Window.html" title="class in org.apache.calcite.rel.core">Window</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Hintable</span></div>
<div class="block"><a href="Hintable.html" title="interface in org.apache.calcite.rel.hint"><code>Hintable</code></a> is a kind of <a href="../RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> that can attach <a href="RelHint.html" title="class in org.apache.calcite.rel.hint"><code>RelHint</code></a>s.
<p>This interface is experimental, <a href="../RelNode.html" title="interface in 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>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#attachHints(java.util.List)" class="member-name-link">attachHints</a><wbr>(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>&gt;&nbsp;hintList)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Attaches list of hints to this relational expression.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>com.google.common.collect.ImmutableList&lt;<a href="RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getHints()" class="member-name-link">getHints</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the hints of this relational expressions as an immutable list.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#withHints(java.util.List)" class="member-name-link">withHints</a><wbr>(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>&gt;&nbsp;hintList)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns a new relational expression with the specified hints <code>hintList</code>.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="attachHints(java.util.List)">
<h3>attachHints</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">attachHints</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>&gt;&nbsp;hintList)</span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>hintList</code> - The hints to attach to this relational expression</dd>
<dt>Returns:</dt>
<dd>Relational expression with the hints <code>hintList</code> attached</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="withHints(java.util.List)">
<h3>withHints</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">withHints</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>&gt;&nbsp;hintList)</span></div>
<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 class="notes">
<dt>Returns:</dt>
<dd>Relational expression with set up hints</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHints()">
<h3>getHints</h3>
<div class="member-signature"><span class="return-type">com.google.common.collect.ImmutableList&lt;<a href="RelHint.html" title="class in org.apache.calcite.rel.hint">RelHint</a>&gt;</span>&nbsp;<span class="element-name">getHints</span>()</div>
<div class="block">Returns the hints of this relational expressions as an immutable list.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2022 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>