blob: a7ec212815d82da29554012e233cc1196ad23d2f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.calcite.util.mapping (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.util.mapping (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/util/javac/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/calcite/util/trace/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/util/mapping/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.util.mapping</h1>
<div class="docSummary">
<div class="block">Support for algebraic maps.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></td>
<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">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></td>
<td class="colLast">
<div class="block">Core interface of all mappings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></td>
<td class="colLast">
<div class="block">Mapping where every source has a target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></td>
<td class="colLast">
<div class="block">Mapping suitable for sourcing columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></td>
<td class="colLast">
<div class="block">Mapping suitable for mapping columns to a target.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/AbstractSourceMapping.html" title="class in org.apache.calcite.util.mapping">AbstractSourceMapping</a></td>
<td class="colLast">
<div class="block">Simple implementation of
<a href="../../../../../org/apache/calcite/util/mapping/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">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/AbstractTargetMapping.html" title="class in org.apache.calcite.util.mapping">AbstractTargetMapping</a></td>
<td class="colLast">
<div class="block">Simple implementation of
<a href="../../../../../org/apache/calcite/util/mapping/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">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a></td>
<td class="colLast">
<div class="block">An immutable pair of integers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.html" title="class in org.apache.calcite.util.mapping">Mappings</a></td>
<td class="colLast">
<div class="block">Utility functions related to mappings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.AbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.AbstractMapping</a></td>
<td class="colLast">
<div class="block">Abstract implementation of <a href="../../../../../org/apache/calcite/util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mapping</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.FiniteAbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.FiniteAbstractMapping</a></td>
<td class="colLast">
<div class="block">Abstract implementation of mapping where both source and target
domains are finite.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.IdentityMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.IdentityMapping</a></td>
<td class="colLast">
<div class="block">The identity mapping, of a given size, or infinite.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.OverridingSourceMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingSourceMapping</a></td>
<td class="colLast">
<div class="block">Source mapping that returns the same result as a parent
<a href="../../../../../org/apache/calcite/util/mapping/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">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.OverridingTargetMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingTargetMapping</a></td>
<td class="colLast">
<div class="block">Target mapping that returns the same result as a parent
<a href="../../../../../org/apache/calcite/util/mapping/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">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.PartialMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.PartialMapping</a></td>
<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>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></td>
<td class="colLast">
<div class="block">Describes the type of a mapping, from the most general
<a href="../../../../../org/apache/calcite/util/mapping/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 retricted <a href="../../../../../org/apache/calcite/util/mapping/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>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.NoElementException.html" title="class in org.apache.calcite.util.mapping">Mappings.NoElementException</a></td>
<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">
<td class="colFirst"><a href="../../../../../org/apache/calcite/util/mapping/Mappings.TooManyElementsException.html" title="class in org.apache.calcite.util.mapping">Mappings.TooManyElementsException</a></td>
<td class="colLast">
<div class="block">Thrown when a mapping is expected to return one element but returns
several.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.util.mapping Description">Package org.apache.calcite.util.mapping Description</h2>
<div class="block">Support for algebraic maps.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/util/javac/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/calcite/util/trace/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/util/mapping/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>