| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MappingType (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, enum: MappingType"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <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="class-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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#enum-constant-summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum-constant-detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.util.mapping</a></div> |
| <h1 title="Enum MappingType" class="title">Enum MappingType</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>> |
| <div class="inheritance">org.apache.calcite.util.mapping.MappingType</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">MappingType</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>></span></div> |
| <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 restricted <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#BIJECTION" class="member-name-link">BIJECTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#ELEVEN" class="member-name-link">ELEVEN</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="#FOURTEEN" class="member-name-link">FOURTEEN</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#FUNCTION" class="member-name-link">FUNCTION</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="#INJECTION" class="member-name-link">INJECTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#INVERSE_FUNCTION" class="member-name-link">INVERSE_FUNCTION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">An inverse function has a source for every target, but a source might |
| have 0, 1 or more targets.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#INVERSE_INJECTION" class="member-name-link">INVERSE_INJECTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#INVERSE_PARTIAL_FUNCTION" class="member-name-link">INVERSE_PARTIAL_FUNCTION</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="#INVERSE_PARTIAL_INJECTION" class="member-name-link">INVERSE_PARTIAL_INJECTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#INVERSE_SURJECTION" class="member-name-link">INVERSE_SURJECTION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">An inverse surjection has a source for every target, and no source has |
| more than one target.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#MULTI_FUNCTION" class="member-name-link">MULTI_FUNCTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#PARTIAL_FUNCTION" class="member-name-link">PARTIAL_FUNCTION</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="#PARTIAL_INJECTION" class="member-name-link">PARTIAL_INJECTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#PARTIAL_SURJECTION" class="member-name-link">PARTIAL_SURJECTION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#SURJECTION" class="member-name-link">SURJECTION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="#TEN" class="member-name-link">TEN</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#inverse()" class="member-name-link">inverse</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isA(org.apache.calcite.util.mapping.MappingType)" class="member-name-link">isA</a><wbr>(<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> mappingType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this mapping type is (possibly a weaker form of) a given |
| mapping type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isBijection()" class="member-name-link">isBijection</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A mapping is a bijection if it is a surjection and it is an injection.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFunction()" class="member-name-link">isFunction</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A mapping is a total function if every source has precisely one target.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInjection()" class="member-name-link">isInjection</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A mapping is an injection if it is a function and no target has more than |
| one source.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMandatorySource()" class="member-name-link">isMandatorySource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Constraint that every target has at least one source.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMandatoryTarget()" class="member-name-link">isMandatoryTarget</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Constraint that every source has at least one target.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPartialFunction()" class="member-name-link">isPartialFunction</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A mapping is a partial function if every source has at most one target.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSingleSource()" class="member-name-link">isSingleSource</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Constraint that every target has at most one source.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSingleTarget()" class="member-name-link">isSingleTarget</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Constraint that every source has at most one target.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSurjection()" class="member-name-link">isSurjection</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A mapping is a surjection if it is a function and every target has at |
| least one source.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="BIJECTION"> |
| <h3>BIJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">BIJECTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SURJECTION"> |
| <h3>SURJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">SURJECTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INJECTION"> |
| <h3>INJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">INJECTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FUNCTION"> |
| <h3>FUNCTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">FUNCTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INVERSE_SURJECTION"> |
| <h3>INVERSE_SURJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">INVERSE_SURJECTION</span></div> |
| <div class="block">An inverse surjection has a source for every target, and no source has |
| more than one target.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PARTIAL_SURJECTION"> |
| <h3>PARTIAL_SURJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">PARTIAL_SURJECTION</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PARTIAL_INJECTION"> |
| <h3>PARTIAL_INJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">PARTIAL_INJECTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PARTIAL_FUNCTION"> |
| <h3>PARTIAL_FUNCTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">PARTIAL_FUNCTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INVERSE_INJECTION"> |
| <h3>INVERSE_INJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">INVERSE_INJECTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INVERSE_PARTIAL_INJECTION"> |
| <h3>INVERSE_PARTIAL_INJECTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">INVERSE_PARTIAL_INJECTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TEN"> |
| <h3>TEN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">TEN</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ELEVEN"> |
| <h3>ELEVEN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">ELEVEN</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INVERSE_FUNCTION"> |
| <h3>INVERSE_FUNCTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">INVERSE_FUNCTION</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INVERSE_PARTIAL_FUNCTION"> |
| <h3>INVERSE_PARTIAL_FUNCTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">INVERSE_PARTIAL_FUNCTION</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FOURTEEN"> |
| <h3>FOURTEEN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">FOURTEEN</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MULTI_FUNCTION"> |
| <h3>MULTI_FUNCTION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">MULTI_FUNCTION</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="inverse()"> |
| <h3>inverse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">inverse</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isA(org.apache.calcite.util.mapping.MappingType)"> |
| <h3>isA</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isA</span><wbr><span class="parameters">(<a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a> mappingType)</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFunction()"> |
| <h3>isFunction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFunction</span>()</div> |
| <div class="block">A mapping is a total function if every source has precisely one target.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isPartialFunction()"> |
| <h3>isPartialFunction</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isPartialFunction</span>()</div> |
| <div class="block">A mapping is a partial function if every source has at most one target.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSurjection()"> |
| <h3>isSurjection</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSurjection</span>()</div> |
| <div class="block">A mapping is a surjection if it is a function and every target has at |
| least one source.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInjection()"> |
| <h3>isInjection</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isInjection</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBijection()"> |
| <h3>isBijection</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isBijection</span>()</div> |
| <div class="block">A mapping is a bijection if it is a surjection and it is an injection. |
| (In other words,</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMandatoryTarget()"> |
| <h3>isMandatoryTarget</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMandatoryTarget</span>()</div> |
| <div class="block">Constraint that every source has at least one target.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSingleTarget()"> |
| <h3>isSingleTarget</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSingleTarget</span>()</div> |
| <div class="block">Constraint that every source has at most one target.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMandatorySource()"> |
| <h3>isMandatorySource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMandatorySource</span>()</div> |
| <div class="block">Constraint that every target has at least one source.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSingleSource()"> |
| <h3>isSingleSource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSingleSource</span>()</div> |
| <div class="block">Constraint that every target has at most one source.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
