blob: 04bbc9254b2a5444e69812ec5b51da05fe023475 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.calcite.util.mapping (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.util.mapping">
<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.util.mapping" class="title">Package org.apache.calcite.util.mapping</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.calcite.util.mapping</span></div>
<section class="package-description" id="package-description">
<div class="block">Support for algebraic maps.</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.util</a></div>
<div class="col-last even-row-color">
<div class="block">Classes for testing Calcite.</div>
</div>
<div class="col-first odd-row-color"><a href="../graph/package-summary.html">org.apache.calcite.util.graph</a></div>
<div class="col-last odd-row-color">
<div class="block">Graph-theoretic algorithms and data structures.</div>
</div>
<div class="col-first even-row-color"><a href="../javac/package-summary.html">org.apache.calcite.util.javac</a></div>
<div class="col-last even-row-color">
<div class="block">Provides compilers for Java code.</div>
</div>
<div class="col-first odd-row-color"><a href="../trace/package-summary.html">org.apache.calcite.util.trace</a></div>
<div class="col-last odd-row-color">
<div class="block">Tracing services.</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-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</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="AbstractSourceMapping.html" title="class in org.apache.calcite.util.mapping">AbstractSourceMapping</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Simple implementation of
<a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mappings.TargetMapping</code></a> where the
number of sources and targets are specified as constructor parameters, and you
just need to implement one method.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractTargetMapping.html" title="class in org.apache.calcite.util.mapping">AbstractTargetMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Simple implementation of
<a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mappings.TargetMapping</code></a> where the
number of sources and targets are specified as constructor parameters, and you
just need to implement one method.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An immutable pair of integers.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A <dfn>Mapping</dfn> is a relationship between a source domain to target
domain of integers.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Mappings.html" title="class in org.apache.calcite.util.mapping">Mappings</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility functions related to mappings.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Mappings.AbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.AbstractMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract implementation of <a href="Mapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mapping</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Core interface of all mappings.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Mappings.FiniteAbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.FiniteAbstractMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract implementation of mapping where both source and target
domains are finite.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Mapping where every source has a target.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Mappings.IdentityMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.IdentityMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The identity mapping, of a given size, or infinite.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="Mappings.NoElementException.html" title="class in org.apache.calcite.util.mapping">Mappings.NoElementException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a mapping is expected to return one element but returns none.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Mappings.OverridingSourceMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingSourceMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Source mapping that returns the same result as a parent
<a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mappings.SourceMapping</code></a> except for specific overriding elements.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Mappings.OverridingTargetMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingTargetMapping</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Target mapping that returns the same result as a parent
<a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mappings.TargetMapping</code></a> except for specific overriding elements.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Mappings.PartialMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.PartialMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A mapping where a source has at most one target, and every target has at
most one source.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Mapping suitable for sourcing columns.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Mapping suitable for mapping columns to a target.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="Mappings.TooManyElementsException.html" title="class in org.apache.calcite.util.mapping">Mappings.TooManyElementsException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a mapping is expected to return one element but returns
several.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Describes the type of a mapping, from the most general
<a href="MappingType.html#MULTI_FUNCTION"><code>MappingType.MULTI_FUNCTION</code></a> (every element in the source and target domain can
participate in many mappings) to the most restricted <a href="MappingType.html#BIJECTION"><code>MappingType.BIJECTION</code></a> (every
element in the source and target domain must be paired with precisely one
element in the other domain).</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>