blob: 36fd2ac5fdb9529187ac70a00c2da0f2d2a48014 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.util.mapping (Apache Calcite calcite API)</title>
<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.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="package-declaration">
<script type="text/javascript">var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.util.mapping</h1>
</div>
<div class="contentContainer">
<section class="packageDescription"><a id="package.description">
<!-- -->
</a>
<div class="block">Support for algebraic maps.</div>
</section>
<section class="summary">
<ul class="blockList">
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></th>
<td class="colLast">
<div class="block">A <dfn>Mapping</dfn> is a relationship between a source domain to target
domain of integers.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></th>
<td class="colLast">
<div class="block">Core interface of all mappings.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></th>
<td class="colLast">
<div class="block">Mapping where every source has a target.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></th>
<td class="colLast">
<div class="block">Mapping suitable for sourcing columns.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></th>
<td class="colLast">
<div class="block">Mapping suitable for mapping columns to a target.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AbstractSourceMapping.html" title="class in org.apache.calcite.util.mapping">AbstractSourceMapping</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="AbstractTargetMapping.html" title="class in org.apache.calcite.util.mapping">AbstractTargetMapping</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a></th>
<td class="colLast">
<div class="block">An immutable pair of integers.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.html" title="class in org.apache.calcite.util.mapping">Mappings</a></th>
<td class="colLast">
<div class="block">Utility functions related to mappings.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mappings.AbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.AbstractMapping</a></th>
<td class="colLast">
<div class="block">Abstract implementation of <a href="Mapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mapping</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.FiniteAbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.FiniteAbstractMapping</a></th>
<td class="colLast">
<div class="block">Abstract implementation of mapping where both source and target
domains are finite.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mappings.IdentityMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.IdentityMapping</a></th>
<td class="colLast">
<div class="block">The identity mapping, of a given size, or infinite.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.OverridingSourceMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingSourceMapping</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mappings.OverridingTargetMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingTargetMapping</a></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.PartialMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.PartialMapping</a></th>
<td class="colLast">
<div class="block">A mapping where a source has at most one target, and every target has at
most one source.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></th>
<td class="colLast">
<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>
</td>
</tr>
</tbody>
</table>
</div>
</li>
<li class="blockList">
<div class="typeSummary">
<table>
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Mappings.NoElementException.html" title="class in org.apache.calcite.util.mapping">Mappings.NoElementException</a></th>
<td class="colLast">
<div class="block">Thrown when a mapping is expected to return one element but returns none.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Mappings.TooManyElementsException.html" title="class in org.apache.calcite.util.mapping">Mappings.TooManyElementsException</a></th>
<td class="colLast">
<div class="block">Thrown when a mapping is expected to return one element but returns
several.</div>
</td>
</tr>
</tbody>
</table>
</div>
</li>
</ul>
</section>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>