Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / adapter / enumerable / NestedBlockBuilder.html
blob: 134880c6c5689e298b836a7aaad150a619b00f5c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>NestedBlockBuilder (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.adapter.enumerable, interface: NestedBlockBuilder">
<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.adapter.enumerable</a></div>
<h1 title="Interface NestedBlockBuilder" class="title">Interface NestedBlockBuilder</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="AggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggAddContext</a></code>, <code><a href="AggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResetContext</a></code>, <code><a href="AggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">AggResultContext</a></code>, <code><a href="WinAggAddContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggAddContext</a></code>, <code><a href="WinAggResetContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResetContext</a></code>, <code><a href="WinAggResultContext.html" title="interface in org.apache.calcite.adapter.enumerable">WinAggResultContext</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/AggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">AggAddContextImpl</a></code>, <code><a href="impl/AggResetContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">AggResetContextImpl</a></code>, <code><a href="impl/AggResultContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">AggResultContextImpl</a></code>, <code><a href="NestedBlockBuilderImpl.html" title="class in org.apache.calcite.adapter.enumerable">NestedBlockBuilderImpl</a></code>, <code><a href="impl/WinAggAddContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggAddContextImpl</a></code>, <code><a href="impl/WinAggResetContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResetContextImpl</a></code>, <code><a href="impl/WinAggResultContextImpl.html" title="class in org.apache.calcite.adapter.enumerable.impl">WinAggResultContextImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">NestedBlockBuilder</span></div>
<div class="block">Allows to build nested code blocks with tracking of current context.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="StrictAggImplementor.html#implementAdd(org.apache.calcite.adapter.enumerable.AggContext,org.apache.calcite.adapter.enumerable.AggAddContext)"><code>StrictAggImplementor.implementAdd(AggContext, AggAddContext)</code></a></li>
</ul>
</dd>
</dl>
</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="../../linq4j/tree/BlockBuilder.html" title="class in org.apache.calcite.linq4j.tree">BlockBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#currentBlock()" class="member-name-link">currentBlock</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the current code block.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#exitBlock()" class="member-name-link">exitBlock</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Leaves the current code block.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../linq4j/tree/BlockBuilder.html" title="class in org.apache.calcite.linq4j.tree">BlockBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nestBlock()" class="member-name-link">nestBlock</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Starts nested code block.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nestBlock(org.apache.calcite.linq4j.tree.BlockBuilder)" class="member-name-link">nestBlock</a><wbr>(<a href="../../linq4j/tree/BlockBuilder.html" title="class in org.apache.calcite.linq4j.tree">BlockBuilder</a>&nbsp;block)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Uses given block as the new code context.</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="nestBlock()">
<h3>nestBlock</h3>
<div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/BlockBuilder.html" title="class in org.apache.calcite.linq4j.tree">BlockBuilder</a></span>&nbsp;<span class="element-name">nestBlock</span>()</div>
<div class="block">Starts nested code block. The resulting block can optimize expressions
and reuse already calculated values from the parent blocks.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>new code block that can optimize expressions and reuse already
calculated values from the parent blocks.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nestBlock(org.apache.calcite.linq4j.tree.BlockBuilder)">
<h3>nestBlock</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">nestBlock</span><wbr><span class="parameters">(<a href="../../linq4j/tree/BlockBuilder.html" title="class in org.apache.calcite.linq4j.tree">BlockBuilder</a>&nbsp;block)</span></div>
<div class="block">Uses given block as the new code context.
The current block will be restored after <a href="#exitBlock()"><code>exitBlock()</code></a> call.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>block</code> - new code block</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#exitBlock()"><code>exitBlock()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="currentBlock()">
<h3>currentBlock</h3>
<div class="member-signature"><span class="return-type"><a href="../../linq4j/tree/BlockBuilder.html" title="class in org.apache.calcite.linq4j.tree">BlockBuilder</a></span>&nbsp;<span class="element-name">currentBlock</span>()</div>
<div class="block">Returns the current code block.</div>
</section>
</li>
<li>
<section class="detail" id="exitBlock()">
<h3>exitBlock</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">exitBlock</span>()</div>
<div class="block">Leaves the current code block.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="#nestBlock()"><code>nestBlock()</code></a></li>
</ul>
</dd>
</dl>
</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>