Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / linq4j / package-summary.html
blob: 4df5feb2fb0b198a977aa585d74ba2af6920141c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.calcite.linq4j (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.linq4j">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.calcite.linq4j" class="title">Package org.apache.calcite.linq4j</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=FIELD) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=PARAMETER) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=RETURN)
</span>package <span class="element-name">org.apache.calcite.linq4j</span></div>
<section class="package-description" id="package-description">
<div class="block">Language-integrated query for Java (linq4j) main package.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.calcite</a></div>
<div class="col-last even-row-color">
<div class="block">Main package for Calcite, the dynamic data management platform.</div>
</div>
<div class="col-first odd-row-color"><a href="function/package-summary.html">org.apache.calcite.linq4j.function</a></div>
<div class="col-last odd-row-color">
<div class="block">Contains definitions of functions and predicates.</div>
</div>
<div class="col-first even-row-color"><a href="tree/package-summary.html">org.apache.calcite.linq4j.tree</a></div>
<div class="col-last even-row-color">
<div class="block">Object model for Java expressions.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button><button id="class-summary-tab7" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab7', 2)" class="table-tab">Annotation Types</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractEnumerable.html" title="class in org.apache.calcite.linq4j">AbstractEnumerable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Abstract implementation of the <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> interface that
implements the extension methods.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractEnumerable2.html" title="class in org.apache.calcite.linq4j">AbstractEnumerable2</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract implementation of the <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>
interface that implements the extension methods.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractQueryable.html" title="class in org.apache.calcite.linq4j">AbstractQueryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Abstract implementation of the <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> interface that implements
the extension methods.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BaseQueryable.html" title="class in org.apache.calcite.linq4j">BaseQueryable</a>&lt;TSource&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Skeleton implementation of <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CartesianProductEnumerator.html" title="class in org.apache.calcite.linq4j">CartesianProductEnumerator</a>&lt;T,<wbr>E&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Enumerator over the cartesian product of enumerators.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DefaultEnumerable.html" title="class in org.apache.calcite.linq4j">DefaultEnumerable</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implementation of the <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> interface
that implements the extension methods by calling into the <a href="Extensions.html" title="class in org.apache.calcite.linq4j"><code>Extensions</code></a>
class.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DelegatingEnumerator.html" title="class in org.apache.calcite.linq4j">DelegatingEnumerator</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Simple enumerator that just delegates all calls to the passed enumerator.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Exposes the enumerator, which supports a simple iteration over a collection.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="EnumerableDefaults.html" title="class in org.apache.calcite.linq4j">EnumerableDefaults</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Default implementations of methods in the <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> interface.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Supports a simple iteration over a collection.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ExtendedEnumerable.html" title="interface in org.apache.calcite.linq4j">ExtendedEnumerable</a>&lt;TSource&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Extension methods in <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ExtendedOrderedEnumerable.html" title="interface in org.apache.calcite.linq4j">ExtendedOrderedEnumerable</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Extension methods for <a href="OrderedEnumerable.html" title="interface in org.apache.calcite.linq4j"><code>OrderedEnumerable</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ExtendedOrderedQueryable.html" title="interface in org.apache.calcite.linq4j">ExtendedOrderedQueryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Extension methods for <a href="OrderedQueryable.html" title="interface in org.apache.calcite.linq4j"><code>OrderedQueryable</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Extensions.html" title="class in org.apache.calcite.linq4j">Extensions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Contains what, in LINQ.NET, would be extension methods.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Grouping.html" title="interface in org.apache.calcite.linq4j">Grouping</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Represents a collection of objects that have a common key.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="JoinType.html" title="enum in org.apache.calcite.linq4j">JoinType</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Enumeration of join types.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Linq4j.html" title="class in org.apache.calcite.linq4j">Linq4j</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility and factory methods for Linq4j.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Lookup.html" title="interface in org.apache.calcite.linq4j">Lookup</a>&lt;K,<wbr>V&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Represents a collection of keys each mapped to one or more values.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MemoryEnumerable.html" title="class in org.apache.calcite.linq4j">MemoryEnumerable</a>&lt;E&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Enumerable that has a (limited) memory for n past and m future steps.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MemoryEnumerator.html" title="class in org.apache.calcite.linq4j">MemoryEnumerator</a>&lt;E&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Enumerator that keeps some recent and some "future" values.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MemoryFactory.html" title="class in org.apache.calcite.linq4j">MemoryFactory</a>&lt;E&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Contains the State and changes internally.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MemoryFactory.Memory.html" title="class in org.apache.calcite.linq4j">MemoryFactory.Memory</a>&lt;E&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Contents of a "memory segment", used for implementing the
<code>MATCH_RECOGNIZE</code> operator.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Nullness.html" title="class in org.apache.calcite.linq4j">Nullness</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The methods in this class allow to cast nullable reference to a non-nullable one.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="OpType.html" title="enum in org.apache.calcite.linq4j">OpType</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Operator type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ord.html" title="class in org.apache.calcite.linq4j">Ord</a>&lt;E&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Pair of an element and an ordinal.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="OrderedEnumerable.html" title="interface in org.apache.calcite.linq4j">OrderedEnumerable</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Represents the result of applying a sorting operation to an
<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="OrderedQueryable.html" title="interface in org.apache.calcite.linq4j">OrderedQueryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Represents the result of applying a sorting operation to a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="PackageMarker.html" title="annotation in org.apache.calcite.linq4j">PackageMarker</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab7">
<div class="block">This is a dummy annotation that forces javac to produce output for
otherwise empty package-info.java.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Provides functionality to evaluate queries against a specific data source
wherein the type of the data is known.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="QueryableDefaults.html" title="class in org.apache.calcite.linq4j">QueryableDefaults</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Default implementations for methods in the <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> interface.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="QueryableDefaults.NonLeafReplayableQueryable.html" title="class in org.apache.calcite.linq4j">QueryableDefaults.NonLeafReplayableQueryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Non-leaf replayable queryable.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QueryableDefaults.Replayable.html" title="interface in org.apache.calcite.linq4j">QueryableDefaults.Replayable</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Replayable.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="QueryableDefaults.ReplayableQueryable.html" title="class in org.apache.calcite.linq4j">QueryableDefaults.ReplayableQueryable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Replayable queryable.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QueryableFactory.html" title="interface in org.apache.calcite.linq4j">QueryableFactory</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Factory for building <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> objects.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="QueryableRecorder.html" title="class in org.apache.calcite.linq4j">QueryableRecorder</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implementation of <a href="QueryableFactory.html" title="interface in org.apache.calcite.linq4j"><code>QueryableFactory</code></a> that records each event
and returns an object that can replay the event when you call its
<a href="QueryableDefaults.ReplayableQueryable.html#replay(org.apache.calcite.linq4j.QueryableFactory)"><code>QueryableDefaults.ReplayableQueryable.replay(QueryableFactory)</code></a>
method.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="QueryProvider.html" title="interface in org.apache.calcite.linq4j">QueryProvider</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Defines methods to create and execute queries that are described by a
<a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="QueryProviderImpl.html" title="class in org.apache.calcite.linq4j">QueryProviderImpl</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Partial implementation of <a href="QueryProvider.html" title="interface in org.apache.calcite.linq4j"><code>QueryProvider</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="QueryProviderImpl.QueryableImpl.html" title="class in org.apache.calcite.linq4j">QueryProviderImpl.QueryableImpl</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Binds an expression to this query provider.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="RawEnumerable.html" title="interface in org.apache.calcite.linq4j">RawEnumerable</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Exposes the enumerator, which supports a simple iteration over a collection,
without the extension methods.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RawQueryable.html" title="interface in org.apache.calcite.linq4j">RawQueryable</a>&lt;T&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Core methods that define a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TransformedEnumerator.html" title="class in org.apache.calcite.linq4j">TransformedEnumerator</a>&lt;F,<wbr>E&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Enumerator that applies a transform to each value from a backing
enumerator.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</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>