blob: 23cdc8ba2692df369e861cb1d625b3cd27d30eb5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RelRule.OperandDetailBuilder (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.plan, class: RelRule, interface: OperandDetailBuilder">
<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.plan</a></div>
<h1 title="Interface RelRule.OperandDetailBuilder" class="title">Interface RelRule.OperandDetailBuilder&lt;R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>R</code> - Type of relational expression</dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="RelRule.html" title="class in org.apache.calcite.plan">RelRule</a>&lt;<a href="RelRule.html" title="type parameter in RelRule">C</a> extends <a href="RelRule.Config.html" title="interface in org.apache.calcite.plan">RelRule.Config</a>&gt;</dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">RelRule.OperandDetailBuilder&lt;R extends <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</span></div>
<div class="block">Add details about an operand, such as its inputs.</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></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-tab3"><code><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#anyInputs()" class="member-name-link">anyInputs</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicates that this operand takes any number or type of inputs.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convert(org.apache.calcite.plan.RelTrait)" class="member-name-link">convert</a><wbr>(<a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicates that this operand converts a relational expression to
another trait.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#inputs(org.apache.calcite.plan.RelRule.OperandTransform...)" class="member-name-link">inputs</a><wbr>(<a href="RelRule.OperandTransform.html" title="interface in org.apache.calcite.plan">RelRule.OperandTransform</a>...&nbsp;transforms)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicates that this operand has several inputs.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#noInputs()" class="member-name-link">noInputs</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicates that this operand takes no inputs.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#oneInput(org.apache.calcite.plan.RelRule.OperandTransform)" class="member-name-link">oneInput</a><wbr>(<a href="RelRule.OperandTransform.html" title="interface in org.apache.calcite.plan">RelRule.OperandTransform</a>&nbsp;transform)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicates that this operand has a single input.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.OperandDetailBuilder.html" title="interface in org.apache.calcite.plan">RelRule.OperandDetailBuilder</a>&lt;<a href="RelRule.OperandDetailBuilder.html" title="type parameter in RelRule.OperandDetailBuilder">R</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="#predicate(java.util.function.Predicate)" class="member-name-link">predicate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;? super <a href="RelRule.OperandDetailBuilder.html" title="type parameter in RelRule.OperandDetailBuilder">R</a>&gt;&nbsp;predicate)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the predicate of this operand.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.OperandDetailBuilder.html" title="interface in org.apache.calcite.plan">RelRule.OperandDetailBuilder</a>&lt;<a href="RelRule.OperandDetailBuilder.html" title="type parameter in RelRule.OperandDetailBuilder">R</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#trait(org.apache.calcite.plan.RelTrait)" class="member-name-link">trait</a><wbr>(<a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;trait)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets a trait of this operand.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#unorderedInputs(org.apache.calcite.plan.RelRule.OperandTransform...)" class="member-name-link">unorderedInputs</a><wbr>(<a href="RelRule.OperandTransform.html" title="interface in org.apache.calcite.plan">RelRule.OperandTransform</a>...&nbsp;transforms)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Indicates that this operand has several inputs, unordered.</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="trait(org.apache.calcite.plan.RelTrait)">
<h3>trait</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.OperandDetailBuilder.html" title="interface in org.apache.calcite.plan">RelRule.OperandDetailBuilder</a>&lt;<a href="RelRule.OperandDetailBuilder.html" title="type parameter in RelRule.OperandDetailBuilder">R</a>&gt;</span>&nbsp;<span class="element-name">trait</span><wbr><span class="parameters">(<a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;trait)</span></div>
<div class="block">Sets a trait of this operand.</div>
</section>
</li>
<li>
<section class="detail" id="predicate(java.util.function.Predicate)">
<h3>predicate</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.OperandDetailBuilder.html" title="interface in org.apache.calcite.plan">RelRule.OperandDetailBuilder</a>&lt;<a href="RelRule.OperandDetailBuilder.html" title="type parameter in RelRule.OperandDetailBuilder">R</a>&gt;</span>&nbsp;<span class="element-name">predicate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;? super <a href="RelRule.OperandDetailBuilder.html" title="type parameter in RelRule.OperandDetailBuilder">R</a>&gt;&nbsp;predicate)</span></div>
<div class="block">Sets the predicate of this operand.</div>
</section>
</li>
<li>
<section class="detail" id="oneInput(org.apache.calcite.plan.RelRule.OperandTransform)">
<h3>oneInput</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></span>&nbsp;<span class="element-name">oneInput</span><wbr><span class="parameters">(<a href="RelRule.OperandTransform.html" title="interface in org.apache.calcite.plan">RelRule.OperandTransform</a>&nbsp;transform)</span></div>
<div class="block">Indicates that this operand has a single input.</div>
</section>
</li>
<li>
<section class="detail" id="inputs(org.apache.calcite.plan.RelRule.OperandTransform...)">
<h3>inputs</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></span>&nbsp;<span class="element-name">inputs</span><wbr><span class="parameters">(<a href="RelRule.OperandTransform.html" title="interface in org.apache.calcite.plan">RelRule.OperandTransform</a>...&nbsp;transforms)</span></div>
<div class="block">Indicates that this operand has several inputs.</div>
</section>
</li>
<li>
<section class="detail" id="unorderedInputs(org.apache.calcite.plan.RelRule.OperandTransform...)">
<h3>unorderedInputs</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></span>&nbsp;<span class="element-name">unorderedInputs</span><wbr><span class="parameters">(<a href="RelRule.OperandTransform.html" title="interface in org.apache.calcite.plan">RelRule.OperandTransform</a>...&nbsp;transforms)</span></div>
<div class="block">Indicates that this operand has several inputs, unordered.</div>
</section>
</li>
<li>
<section class="detail" id="anyInputs()">
<h3>anyInputs</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></span>&nbsp;<span class="element-name">anyInputs</span>()</div>
<div class="block">Indicates that this operand takes any number or type of inputs.</div>
</section>
</li>
<li>
<section class="detail" id="noInputs()">
<h3>noInputs</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></span>&nbsp;<span class="element-name">noInputs</span>()</div>
<div class="block">Indicates that this operand takes no inputs.</div>
</section>
</li>
<li>
<section class="detail" id="convert(org.apache.calcite.plan.RelTrait)">
<h3>convert</h3>
<div class="member-signature"><span class="return-type"><a href="RelRule.Done.html" title="interface in org.apache.calcite.plan">RelRule.Done</a></span>&nbsp;<span class="element-name">convert</span><wbr><span class="parameters">(<a href="RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;in)</span></div>
<div class="block">Indicates that this operand converts a relational expression to
another trait.</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-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>