Google Git
Sign in
apache / calcite-site / f3651d86b6f63f8b6bbb735c74220c093b7bf506 / . / apidocs / org / apache / calcite / util / mapping / MappingType.html
blob: 41c76b61ad4adca295c87cb0f76092f62b18fdb5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>MappingType (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MappingType (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"i12":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MappingType.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.util.mapping</a></div>
<h2 title="Enum MappingType" class="title">Enum MappingType</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.util.mapping.MappingType</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable&lt;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&gt;</code></dd>
</dl>
<hr>
<pre>public enum <span class="typeNameLabel">MappingType</span>
extends java.lang.Enum&lt;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&gt;</pre>
<div class="block">Describes the type of a mapping, from the most general
<a href="#MULTI_FUNCTION"><code>MULTI_FUNCTION</code></a> (every element in the source and target domain can
participate in many mappings) to the most retricted <a href="#BIJECTION"><code>BIJECTION</code></a> (every
element in the source and target domain must be paired with precisely one
element in the other domain).
<p>Some common types:
<ul>
<li>A surjection is a mapping if every target has at least one source; also
known as an 'onto' mapping.
<li>A mapping is a partial function if every source has at most one target.
<li>A mapping is a function if every source has precisely one target.
<li>An injection is a mapping where a target has at most one source; also
somewhat confusingly known as a 'one-to-one' mapping.
<li>A bijection is a mapping which is both an injection and a surjection.
Every source has precisely one target, and vice versa.
</ul>
<p>Once you know what type of mapping you want, call
<a href="Mappings.html#create(org.apache.calcite.util.mapping.MappingType,int,int)"><code>Mappings.create(MappingType, int, int)</code></a> to create an efficient
implementation of that mapping.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#BIJECTION">BIJECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ELEVEN">ELEVEN</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FOURTEEN">FOURTEEN</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FUNCTION">FUNCTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INJECTION">INJECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INVERSE_FUNCTION">INVERSE_FUNCTION</a></span></code></th>
<td class="colLast">
<div class="block">An inverse function has a source for every target, but a source might
have 0, 1 or more targets.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INVERSE_INJECTION">INVERSE_INJECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INVERSE_PARTIAL_FUNCTION">INVERSE_PARTIAL_FUNCTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INVERSE_PARTIAL_INJECTION">INVERSE_PARTIAL_INJECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INVERSE_SURJECTION">INVERSE_SURJECTION</a></span></code></th>
<td class="colLast">
<div class="block">An inverse surjection has a source for every target, and no source has
more than one target.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MULTI_FUNCTION">MULTI_FUNCTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PARTIAL_FUNCTION">PARTIAL_FUNCTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PARTIAL_INJECTION">PARTIAL_INJECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#PARTIAL_SURJECTION">PARTIAL_SURJECTION</a></span></code></th>
<td class="colLast">
<div class="block">A partial surjection has no more than one source for any target, and no
more than one target for any source.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SURJECTION">SURJECTION</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#TEN">TEN</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inverseOrdinal">inverseOrdinal</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MULTIPLE_SOURCE">MULTIPLE_SOURCE</a></span></code></th>
<td class="colLast">
<div class="block">Allow more than one source for a given target.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MULTIPLE_TARGET">MULTIPLE_TARGET</a></span></code></th>
<td class="colLast">
<div class="block">Allow more than one target for a given source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#OPTIONAL_SOURCE">OPTIONAL_SOURCE</a></span></code></th>
<td class="colLast">
<div class="block">Allow less than one source for a given target.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#OPTIONAL_TARGET">OPTIONAL_TARGET</a></span></code></th>
<td class="colLast">
<div class="block">Allow less than one target for a given source.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">MappingType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inverse()">inverse</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isA(org.apache.calcite.util.mapping.MappingType)">isA</a></span>&#8203;(<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&nbsp;mappingType)</code></th>
<td class="colLast">
<div class="block">Returns whether this mapping type is (possibly a weaker form of) a given
mapping type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBijection()">isBijection</a></span>()</code></th>
<td class="colLast">
<div class="block">A mapping is a bijection if it is a surjection and it is an injection.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFunction()">isFunction</a></span>()</code></th>
<td class="colLast">
<div class="block">A mapping is a total function if every source has precisely one target.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInjection()">isInjection</a></span>()</code></th>
<td class="colLast">
<div class="block">A mapping is an injection if it is a function and no target has more than
one source.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMandatorySource()">isMandatorySource</a></span>()</code></th>
<td class="colLast">
<div class="block">Constraint that every target has at least one source.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isMandatoryTarget()">isMandatoryTarget</a></span>()</code></th>
<td class="colLast">
<div class="block">Constraint that every source has at least one target.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isPartialFunction()">isPartialFunction</a></span>()</code></th>
<td class="colLast">
<div class="block">A mapping is a partial function if every source has at most one target.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSingleSource()">isSingleSource</a></span>()</code></th>
<td class="colLast">
<div class="block">Constraint that every target has at most one source.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSingleTarget()">isSingleTarget</a></span>()</code></th>
<td class="colLast">
<div class="block">Constraint that every source has at most one target.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSurjection()">isSurjection</a></span>()</code></th>
<td class="colLast">
<div class="block">A mapping is a surjection if it is a function and every target has at
least one source.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="BIJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BIJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> BIJECTION</pre>
</li>
</ul>
<a id="SURJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SURJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> SURJECTION</pre>
</li>
</ul>
<a id="INJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> INJECTION</pre>
</li>
</ul>
<a id="FUNCTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUNCTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> FUNCTION</pre>
</li>
</ul>
<a id="INVERSE_SURJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVERSE_SURJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> INVERSE_SURJECTION</pre>
<div class="block">An inverse surjection has a source for every target, and no source has
more than one target.</div>
</li>
</ul>
<a id="PARTIAL_SURJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTIAL_SURJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> PARTIAL_SURJECTION</pre>
<div class="block">A partial surjection has no more than one source for any target, and no
more than one target for any source.</div>
</li>
</ul>
<a id="PARTIAL_INJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTIAL_INJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> PARTIAL_INJECTION</pre>
</li>
</ul>
<a id="PARTIAL_FUNCTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTIAL_FUNCTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> PARTIAL_FUNCTION</pre>
</li>
</ul>
<a id="INVERSE_INJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVERSE_INJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> INVERSE_INJECTION</pre>
</li>
</ul>
<a id="INVERSE_PARTIAL_INJECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVERSE_PARTIAL_INJECTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> INVERSE_PARTIAL_INJECTION</pre>
</li>
</ul>
<a id="TEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TEN</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> TEN</pre>
</li>
</ul>
<a id="ELEVEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ELEVEN</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> ELEVEN</pre>
</li>
</ul>
<a id="INVERSE_FUNCTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVERSE_FUNCTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> INVERSE_FUNCTION</pre>
<div class="block">An inverse function has a source for every target, but a source might
have 0, 1 or more targets.
<p>Obeys the constaints <a href="#isMandatorySource()"><code>isMandatorySource()</code></a>,
<a href="#isSingleSource()"><code>isSingleSource()</code></a>.
<p>Similar types:
<ul>
<li> <a href="#INVERSE_SURJECTION"><code>INVERSE_SURJECTION</code></a> is stronger (a source may not have
multiple targets);
<li><a href="#INVERSE_PARTIAL_FUNCTION"><code>INVERSE_PARTIAL_FUNCTION</code></a> is weaker (a target may have 0 or 1
sources).
</ul></div>
</li>
</ul>
<a id="INVERSE_PARTIAL_FUNCTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVERSE_PARTIAL_FUNCTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> INVERSE_PARTIAL_FUNCTION</pre>
</li>
</ul>
<a id="FOURTEEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FOURTEEN</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> FOURTEEN</pre>
</li>
</ul>
<a id="MULTI_FUNCTION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MULTI_FUNCTION</h4>
<pre>public static final&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> MULTI_FUNCTION</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="inverseOrdinal">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inverseOrdinal</h4>
<pre>private final&nbsp;int inverseOrdinal</pre>
</li>
</ul>
<a id="OPTIONAL_SOURCE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPTIONAL_SOURCE</h4>
<pre>private static final&nbsp;int OPTIONAL_SOURCE</pre>
<div class="block">Allow less than one source for a given target.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.calcite.util.mapping.MappingType.OPTIONAL_SOURCE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MULTIPLE_SOURCE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MULTIPLE_SOURCE</h4>
<pre>private static final&nbsp;int MULTIPLE_SOURCE</pre>
<div class="block">Allow more than one source for a given target.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.calcite.util.mapping.MappingType.MULTIPLE_SOURCE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="OPTIONAL_TARGET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OPTIONAL_TARGET</h4>
<pre>private static final&nbsp;int OPTIONAL_TARGET</pre>
<div class="block">Allow less than one target for a given source.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.calcite.util.mapping.MappingType.OPTIONAL_TARGET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MULTIPLE_TARGET">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MULTIPLE_TARGET</h4>
<pre>private static final&nbsp;int MULTIPLE_TARGET</pre>
<div class="block">Allow more than one target for a given source.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.calcite.util.mapping.MappingType.MULTIPLE_TARGET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MappingType</h4>
<pre>private&nbsp;MappingType()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (MappingType c : MappingType.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a id="inverse()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inverse</h4>
<pre class="methodSignature">public&nbsp;<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&nbsp;inverse()</pre>
</li>
</ul>
<a id="isA(org.apache.calcite.util.mapping.MappingType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isA</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isA&#8203;(<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>&nbsp;mappingType)</pre>
<div class="block">Returns whether this mapping type is (possibly a weaker form of) a given
mapping type.
<p>For example, a <a href="#BIJECTION"><code>BIJECTION</code></a> is a <a href="#FUNCTION"><code>FUNCTION</code></a>, but not
every {link #Function} is a <a href="#BIJECTION"><code>BIJECTION</code></a>.</div>
</li>
</ul>
<a id="isFunction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFunction</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isFunction()</pre>
<div class="block">A mapping is a total function if every source has precisely one target.</div>
</li>
</ul>
<a id="isPartialFunction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPartialFunction</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isPartialFunction()</pre>
<div class="block">A mapping is a partial function if every source has at most one target.</div>
</li>
</ul>
<a id="isSurjection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSurjection</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSurjection()</pre>
<div class="block">A mapping is a surjection if it is a function and every target has at
least one source.</div>
</li>
</ul>
<a id="isInjection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInjection</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isInjection()</pre>
<div class="block">A mapping is an injection if it is a function and no target has more than
one source. (In other words, every source has precisely one target.)</div>
</li>
</ul>
<a id="isBijection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBijection</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBijection()</pre>
<div class="block">A mapping is a bijection if it is a surjection and it is an injection.
(In other words,</div>
</li>
</ul>
<a id="isMandatoryTarget()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMandatoryTarget</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMandatoryTarget()</pre>
<div class="block">Constraint that every source has at least one target.</div>
</li>
</ul>
<a id="isSingleTarget()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSingleTarget</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSingleTarget()</pre>
<div class="block">Constraint that every source has at most one target.</div>
</li>
</ul>
<a id="isMandatorySource()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMandatorySource</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isMandatorySource()</pre>
<div class="block">Constraint that every target has at least one source.</div>
</li>
</ul>
<a id="isSingleSource()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isSingleSource</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSingleSource()</pre>
<div class="block">Constraint that every target has at most one source.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MappingType.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>