blob: c8184cceab797edcf0eb9ac95bcbd8cf2514af3d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ReduceExpressionsRule.Config (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.rules, class: ReduceExpressionsRule, interface: Config">
<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.rules</a></div>
<h1 title="Interface ReduceExpressionsRule.Config" class="title">Interface ReduceExpressionsRule.Config</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="../../plan/RelRule.Config.html" title="interface in org.apache.calcite.plan">RelRule.Config</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="ReduceExpressionsRule.CalcReduceExpressionsRule.CalcReduceExpressionsRuleConfig.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.CalcReduceExpressionsRule.CalcReduceExpressionsRuleConfig</a></code>, <code><a href="ReduceExpressionsRule.FilterReduceExpressionsRule.FilterReduceExpressionsRuleConfig.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.FilterReduceExpressionsRule.FilterReduceExpressionsRuleConfig</a></code>, <code><a href="ReduceExpressionsRule.JoinReduceExpressionsRule.JoinReduceExpressionsRuleConfig.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.JoinReduceExpressionsRule.JoinReduceExpressionsRuleConfig</a></code>, <code><a href="ReduceExpressionsRule.ProjectReduceExpressionsRule.ProjectReduceExpressionsRuleConfig.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.ProjectReduceExpressionsRule.ProjectReduceExpressionsRuleConfig</a></code>, <code><a href="ReduceExpressionsRule.WindowReduceExpressionsRule.WindowReduceExpressionsRuleConfig.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.WindowReduceExpressionsRule.WindowReduceExpressionsRuleConfig</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="ReduceExpressionsRule.html" title="class in org.apache.calcite.rel.rules">ReduceExpressionsRule</a>&lt;<a href="ReduceExpressionsRule.html" title="type parameter in ReduceExpressionsRule">C</a> extends <a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a>&gt;</dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">ReduceExpressionsRule.Config</span><span class="extends-implements">
extends <a href="../../plan/RelRule.Config.html" title="interface in org.apache.calcite.plan">RelRule.Config</a></span></div>
<div class="block">Rule configuration.</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 boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#matchNullability()" class="member-name-link">matchNullability</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Whether to add a CAST when a nullable expression
reduces to a NOT NULL literal.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ReduceExpressionsRule.html" title="class in org.apache.calcite.rel.rules">ReduceExpressionsRule</a>&lt;?&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toRule()" class="member-name-link">toRule</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Creates a rule that uses this configuration.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#treatDynamicCallsAsConstant()" class="member-name-link">treatDynamicCallsAsConstant</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Whether to treat
<a href="../../sql/SqlOperator.html#isDynamicFunction()"><code>dynamic functions</code></a> as constants.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withMatchNullability(boolean)" class="member-name-link">withMatchNullability</a><wbr>(boolean&nbsp;matchNullability)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets <a href="#matchNullability()"><code>matchNullability()</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#withOperandFor(java.lang.Class)" class="member-name-link">withOperandFor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;relClass)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Defines an operand tree for the given classes.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#withTreatDynamicCallsAsConstant(boolean)" class="member-name-link">withTreatDynamicCallsAsConstant</a><wbr>(boolean&nbsp;treatDynamicCallsAsConstant)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets <a href="#treatDynamicCallsAsConstant()"><code>treatDynamicCallsAsConstant()</code></a>.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelRule.Config">Methods inherited from interface&nbsp;org.apache.calcite.plan.<a href="../../plan/RelRule.Config.html" title="interface in org.apache.calcite.plan">RelRule.Config</a></h3>
<code><a href="../../plan/RelRule.Config.html#as(java.lang.Class)">as</a>, <a href="../../plan/RelRule.Config.html#description()">description</a>, <a href="../../plan/RelRule.Config.html#operandSupplier()">operandSupplier</a>, <a href="../../plan/RelRule.Config.html#relBuilderFactory()">relBuilderFactory</a>, <a href="../../plan/RelRule.Config.html#withDescription(java.lang.String)">withDescription</a>, <a href="../../plan/RelRule.Config.html#withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform)">withOperandSupplier</a>, <a href="../../plan/RelRule.Config.html#withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory)">withRelBuilderFactory</a></code></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="toRule()">
<h3>toRule</h3>
<div class="member-signature"><span class="return-type"><a href="ReduceExpressionsRule.html" title="class in org.apache.calcite.rel.rules">ReduceExpressionsRule</a>&lt;?&gt;</span>&nbsp;<span class="element-name">toRule</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../../plan/RelRule.Config.html#toRule()">RelRule.Config</a></code></span></div>
<div class="block">Creates a rule that uses this configuration. Sub-class must override.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../../plan/RelRule.Config.html#toRule()">toRule</a></code>&nbsp;in interface&nbsp;<code><a href="../../plan/RelRule.Config.html" title="interface in org.apache.calcite.plan">RelRule.Config</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="matchNullability()">
<h3>matchNullability</h3>
<div class="member-signature"><span class="annotations">@Default
</span><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">matchNullability</span>()</div>
<div class="block">Whether to add a CAST when a nullable expression
reduces to a NOT NULL literal.</div>
</section>
</li>
<li>
<section class="detail" id="withMatchNullability(boolean)">
<h3>withMatchNullability</h3>
<div class="member-signature"><span class="return-type"><a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a></span>&nbsp;<span class="element-name">withMatchNullability</span><wbr><span class="parameters">(boolean&nbsp;matchNullability)</span></div>
<div class="block">Sets <a href="#matchNullability()"><code>matchNullability()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="treatDynamicCallsAsConstant()">
<h3>treatDynamicCallsAsConstant</h3>
<div class="member-signature"><span class="annotations">@Default
</span><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">treatDynamicCallsAsConstant</span>()</div>
<div class="block">Whether to treat
<a href="../../sql/SqlOperator.html#isDynamicFunction()"><code>dynamic functions</code></a> as constants.
<p>When false (the default), calls to dynamic functions (e.g.
<code>USER</code>) are not reduced. When true, calls to dynamic functions
are treated as a constant, and reduced.</div>
</section>
</li>
<li>
<section class="detail" id="withTreatDynamicCallsAsConstant(boolean)">
<h3>withTreatDynamicCallsAsConstant</h3>
<div class="member-signature"><span class="return-type"><a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a></span>&nbsp;<span class="element-name">withTreatDynamicCallsAsConstant</span><wbr><span class="parameters">(boolean&nbsp;treatDynamicCallsAsConstant)</span></div>
<div class="block">Sets <a href="#treatDynamicCallsAsConstant()"><code>treatDynamicCallsAsConstant()</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="withOperandFor(java.lang.Class)">
<h3>withOperandFor</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="ReduceExpressionsRule.Config.html" title="interface in org.apache.calcite.rel.rules">ReduceExpressionsRule.Config</a></span>&nbsp;<span class="element-name">withOperandFor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;relClass)</span></div>
<div class="block">Defines an operand tree for the given classes.</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>