| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Mapping (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.util.mapping, interface: Mapping"> |
| <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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface Mapping" class="title">Interface Mapping</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>></code>, <code><a href="Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></code>, <code><a href="Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code>, <code><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code>, <code><a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractSourceMapping.html" title="class in org.apache.calcite.util.mapping">AbstractSourceMapping</a></code>, <code><a href="AbstractTargetMapping.html" title="class in org.apache.calcite.util.mapping">AbstractTargetMapping</a></code>, <code><a href="Mappings.AbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.AbstractMapping</a></code>, <code><a href="Mappings.FiniteAbstractMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.FiniteAbstractMapping</a></code>, <code><a href="Mappings.IdentityMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.IdentityMapping</a></code>, <code><a href="Mappings.OverridingSourceMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingSourceMapping</a></code>, <code><a href="Mappings.OverridingTargetMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.OverridingTargetMapping</a></code>, <code><a href="Mappings.PartialMapping.html" title="class in org.apache.calcite.util.mapping">Mappings.PartialMapping</a></code>, <code><a href="../Permutation.html" title="class in org.apache.calcite.util">Permutation</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Mapping</span><span class="extends-implements"> |
| extends <a href="Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a>, <a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a>, <a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>></span></div> |
| <div class="block">A <dfn>Mapping</dfn> is a relationship between a source domain to target |
| domain of integers. |
| |
| <p>This interface represents the most general possible mapping. Depending on |
| the <a href="MappingType.html" title="enum in org.apache.calcite.util.mapping"><code>MappingType</code></a> of a particular mapping, some of the operations may |
| not be applicable. If you call the method, you will receive a runtime error. |
| For instance: |
| |
| <ul> |
| <li>If a target has more than one source, then the method |
| <a href="Mappings.SourceMapping.html#getSource(int)"><code>Mappings.SourceMapping.getSource(int)</code></a> will throw |
| <a href="Mappings.TooManyElementsException.html" title="class in org.apache.calcite.util.mapping"><code>Mappings.TooManyElementsException</code></a>. |
| <li>If a source has no targets, then the method <a href="Mappings.FunctionMapping.html#getTarget(int)"><code>Mappings.FunctionMapping.getTarget(int)</code></a> will throw |
| <a href="Mappings.NoElementException.html" title="class in org.apache.calcite.util.mapping"><code>Mappings.NoElementException</code></a>. |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Removes all elements in the mapping.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab2 method-summary-table-tab3"><code><a href="#getMappingType()" class="member-name-link">getMappingType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the mapping type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSourceCount()" class="member-name-link">getSourceCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of sources.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTargetCount()" class="member-name-link">getTargetCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of targets.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isIdentity()" class="member-name-link">isIdentity</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this mapping is the identity.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns an iterator over the elements in this mapping.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of elements in the mapping.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.util.mapping.Mappings.SourceMapping">Methods inherited from interface org.apache.calcite.util.mapping.<a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></h3> |
| <code><a href="Mappings.SourceMapping.html#getSource(int)">getSource</a>, <a href="Mappings.SourceMapping.html#getSourceOpt(int)">getSourceOpt</a>, <a href="Mappings.SourceMapping.html#getTargetOpt(int)">getTargetOpt</a>, <a href="Mappings.SourceMapping.html#inverse()">inverse</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.util.mapping.Mappings.TargetMapping">Methods inherited from interface org.apache.calcite.util.mapping.<a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></h3> |
| <code><a href="Mappings.TargetMapping.html#getSourceOpt(int)">getSourceOpt</a>, <a href="Mappings.TargetMapping.html#getTarget(int)">getTarget</a>, <a href="Mappings.TargetMapping.html#getTargetOpt(int)">getTargetOpt</a>, <a href="Mappings.TargetMapping.html#inverse()">inverse</a>, <a href="Mappings.TargetMapping.html#set(int,int)">set</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="iterator()"> |
| <h3>iterator</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>></span> <span class="element-name">iterator</span>()</div> |
| <div class="block">Returns an iterator over the elements in this mapping. |
| |
| <p>This method is optional; implementations may throw |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link"><code>UnsupportedOperationException</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSourceCount()"> |
| <h3>getSourceCount</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getSourceCount</span>()</div> |
| <div class="block">Returns the number of sources. Valid sources will be in the range 0 .. |
| sourceCount.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.FunctionMapping.html#getSourceCount()">getSourceCount</a></code> in interface <code><a href="Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.SourceMapping.html#getSourceCount()">getSourceCount</a></code> in interface <code><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.TargetMapping.html#getSourceCount()">getSourceCount</a></code> in interface <code><a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTargetCount()"> |
| <h3>getTargetCount</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getTargetCount</span>()</div> |
| <div class="block">Returns the number of targets. Valid targets will be in the range 0 .. |
| targetCount.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.SourceMapping.html#getTargetCount()">getTargetCount</a></code> in interface <code><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.TargetMapping.html#getTargetCount()">getTargetCount</a></code> in interface <code><a href="Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMappingType()"> |
| <h3>getMappingType</h3> |
| <div class="member-signature"><span class="return-type"><a href="MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span> <span class="element-name">getMappingType</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Mappings.CoreMapping.html#getMappingType()">Mappings.CoreMapping</a></code></span></div> |
| <div class="block">Returns the mapping type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.CoreMapping.html#getMappingType()">getMappingType</a></code> in interface <code><a href="Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.FunctionMapping.html#getMappingType()">getMappingType</a></code> in interface <code><a href="Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.SourceMapping.html#getMappingType()">getMappingType</a></code> in interface <code><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Mapping type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isIdentity()"> |
| <h3>isIdentity</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isIdentity</span>()</div> |
| <div class="block">Returns whether this mapping is the identity.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.SourceMapping.html#isIdentity()">isIdentity</a></code> in interface <code><a href="Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <div class="block">Removes all elements in the mapping.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">size</span>()</div> |
| <div class="block">Returns the number of elements in the mapping.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Mappings.CoreMapping.html#size()">size</a></code> in interface <code><a href="Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></code></dd> |
| </dl> |
| </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> |
