javadocAggregate/org/apache/calcite/plan/Context.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Context (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, interface: Context">
 <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 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>Method</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 Context" class="title">Interface Context</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="../test/MockSqlOperatorTable.MyAggFunc.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAggFunc</a></code>, <code><a href="../test/MockSqlOperatorTable.MyAvgAggFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAvgAggFunction</a></code>, <code><a href="../sql/fun/SqlAbstractGroupFunction.html" title="class in org.apache.calcite.sql.fun">SqlAbstractGroupFunction</a></code>, <code><a href="../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a></code>, <code><a href="../sql/fun/SqlAnyValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAnyValueAggFunction</a></code>, <code><a href="../sql/fun/SqlAvgAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAvgAggFunction</a></code>, <code><a href="../sql/fun/SqlBasicAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBasicAggFunction</a></code>, <code><a href="../sql/fun/SqlBitOpAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBitOpAggFunction</a></code>, <code><a href="../sql/fun/SqlCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCountAggFunction</a></code>, <code><a href="../sql/fun/SqlCovarAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCovarAggFunction</a></code>, <code><a href="../sql/fun/SqlFirstLastValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlFirstLastValueAggFunction</a></code>, <code><a href="../sql/fun/SqlHistogramAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlHistogramAggFunction</a></code>, <code><a href="../sql/fun/SqlJsonArrayAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonArrayAggAggFunction</a></code>, <code><a href="../sql/fun/SqlJsonObjectAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonObjectAggAggFunction</a></code>, <code><a href="../sql/fun/SqlLeadLagAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlLeadLagAggFunction</a></code>, <code><a href="../sql/fun/SqlMinMaxAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlMinMaxAggFunction</a></code>, <code><a href="../sql/fun/SqlNthValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNthValueAggFunction</a></code>, <code><a href="../sql/fun/SqlNtileAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNtileAggFunction</a></code>, <code><a href="../sql/SqlRankFunction.html" title="class in org.apache.calcite.sql">SqlRankFunction</a></code>, <code><a href="../sql/fun/SqlRegrCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlRegrCountAggFunction</a></code>, <code><a href="../sql/fun/SqlSingleValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSingleValueAggFunction</a></code>, <code><a href="../sql/fun/SqlSumAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumAggFunction</a></code>, <code><a href="../sql/fun/SqlSumEmptyIsZeroAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumEmptyIsZeroAggFunction</a></code>, <code><a href="../sql/validate/SqlUserDefinedAggFunction.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedAggFunction</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Context</span><span class="extends-implements">
 extends <a href="../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></span></div>
 <div class="block">Provides library users a way to store data within the planner session and
  access it within rules. Frameworks can implement their own implementation
  of Context and pass that as part of the FrameworkConfig.

  <p>Simply implement the <a href="../schema/Wrapper.html#unwrap(java.lang.Class)"><code>Wrapper.unwrap(java.lang.Class&lt;C&gt;)</code></a> method to return any sub-objects
  that you wish to provide.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.calcite.schema.Wrapper">Methods inherited from interface&nbsp;org.apache.calcite.schema.<a href="../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></h3>
 <code><a href="../schema/Wrapper.html#maybeUnwrap(java.lang.Class)">maybeUnwrap</a>, <a href="../schema/Wrapper.html#unwrap(java.lang.Class)">unwrap</a>, <a href="../schema/Wrapper.html#unwrapOrThrow(java.lang.Class)">unwrapOrThrow</a></code></div>
 </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>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>Context (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, interface: Context">
	<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 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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method-summary">Method</a></li>
	</ul>
	<ul class="sub-nav-list">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li>Method</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> <a href="package-summary.html">org.apache.calcite.plan</a></div>
	<h1 title="Interface Context" class="title">Interface Context</h1>
	</div>
	<section class="class-description" id="class-description">
	<dl class="notes">
	<dt>All Superinterfaces:</dt>
	<dd><code><a href="../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></code></dd>
	</dl>
	<dl class="notes">
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="../test/MockSqlOperatorTable.MyAggFunc.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAggFunc</a></code>, <code><a href="../test/MockSqlOperatorTable.MyAvgAggFunction.html" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAvgAggFunction</a></code>, <code><a href="../sql/fun/SqlAbstractGroupFunction.html" title="class in org.apache.calcite.sql.fun">SqlAbstractGroupFunction</a></code>, <code><a href="../sql/SqlAggFunction.html" title="class in org.apache.calcite.sql">SqlAggFunction</a></code>, <code><a href="../sql/fun/SqlAnyValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAnyValueAggFunction</a></code>, <code><a href="../sql/fun/SqlAvgAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlAvgAggFunction</a></code>, <code><a href="../sql/fun/SqlBasicAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBasicAggFunction</a></code>, <code><a href="../sql/fun/SqlBitOpAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlBitOpAggFunction</a></code>, <code><a href="../sql/fun/SqlCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCountAggFunction</a></code>, <code><a href="../sql/fun/SqlCovarAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlCovarAggFunction</a></code>, <code><a href="../sql/fun/SqlFirstLastValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlFirstLastValueAggFunction</a></code>, <code><a href="../sql/fun/SqlHistogramAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlHistogramAggFunction</a></code>, <code><a href="../sql/fun/SqlJsonArrayAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonArrayAggAggFunction</a></code>, <code><a href="../sql/fun/SqlJsonObjectAggAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlJsonObjectAggAggFunction</a></code>, <code><a href="../sql/fun/SqlLeadLagAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlLeadLagAggFunction</a></code>, <code><a href="../sql/fun/SqlMinMaxAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlMinMaxAggFunction</a></code>, <code><a href="../sql/fun/SqlNthValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNthValueAggFunction</a></code>, <code><a href="../sql/fun/SqlNtileAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlNtileAggFunction</a></code>, <code><a href="../sql/SqlRankFunction.html" title="class in org.apache.calcite.sql">SqlRankFunction</a></code>, <code><a href="../sql/fun/SqlRegrCountAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlRegrCountAggFunction</a></code>, <code><a href="../sql/fun/SqlSingleValueAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSingleValueAggFunction</a></code>, <code><a href="../sql/fun/SqlSumAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumAggFunction</a></code>, <code><a href="../sql/fun/SqlSumEmptyIsZeroAggFunction.html" title="class in org.apache.calcite.sql.fun">SqlSumEmptyIsZeroAggFunction</a></code>, <code><a href="../sql/validate/SqlUserDefinedAggFunction.html" title="class in org.apache.calcite.sql.validate">SqlUserDefinedAggFunction</a></code></dd>
	</dl>
	<hr>
	<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Context</span><span class="extends-implements">
	extends <a href="../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></span></div>
	<div class="block">Provides library users a way to store data within the planner session and
	access it within rules. Frameworks can implement their own implementation
	of Context and pass that as part of the FrameworkConfig.

	<p>Simply implement the <a href="../schema/Wrapper.html#unwrap(java.lang.Class)"><code>Wrapper.unwrap(java.lang.Class<C>)</code></a> method to return any sub-objects
	that you wish to provide.</div>
	</section>
	<section class="summary">
	<ul class="summary-list">
	<!-- ========== METHOD SUMMARY =========== -->
	<li>
	<section class="method-summary" id="method-summary">
	<h2>Method Summary</h2>
	<div class="inherited-list">
	<h3 id="methods-inherited-from-class-org.apache.calcite.schema.Wrapper">Methods inherited from interface org.apache.calcite.schema.<a href="../schema/Wrapper.html" title="interface in org.apache.calcite.schema">Wrapper</a></h3>
	<code><a href="../schema/Wrapper.html#maybeUnwrap(java.lang.Class)">maybeUnwrap</a>, <a href="../schema/Wrapper.html#unwrap(java.lang.Class)">unwrap</a>, <a href="../schema/Wrapper.html#unwrapOrThrow(java.lang.Class)">unwrapOrThrow</a></code></div>
	</section>
	</li>
	</ul>
	</section>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<hr>
	<p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>