| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelFieldTrimmer.TrimResult (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.sql2rel, class: RelFieldTrimmer, class: TrimResult"> |
| <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 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><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li>Method</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.sql2rel</a></div> |
| <h1 title="Class RelFieldTrimmer.TrimResult" class="title">Class RelFieldTrimmer.TrimResult</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="../util/Pair.html" title="class in org.apache.calcite.util">org.apache.calcite.util.Pair</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>> |
| <div class="inheritance">org.apache.calcite.sql2rel.RelFieldTrimmer.TrimResult</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="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="RelFieldTrimmer.html" title="class in org.apache.calcite.sql2rel">RelFieldTrimmer</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">protected static class </span><span class="element-name type-name-label">RelFieldTrimmer.TrimResult</span> |
| <span class="extends-implements">extends <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="../util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>></span></div> |
| <div class="block">Result of an attempt to trim columns from a relational expression. |
| |
| <p>The mapping describes where to find the columns wanted by the parent |
| of the current relational expression. |
| |
| <p>The mapping is a |
| <a href="../util/mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping"><code>Mappings.SourceMapping</code></a>, which means |
| that no column can be used more than once, and some columns are not used. |
| <code>columnsUsed.getSource(i)</code> returns the source of the i'th output |
| field. |
| |
| <p>For example, consider the mapping for a relational expression that |
| has 4 output columns but only two are being used. The mapping |
| {2 → 1, 3 → 0} would give the following behavior: |
| |
| <ul> |
| <li>columnsUsed.getSourceCount() returns 4 |
| <li>columnsUsed.getTargetCount() returns 2 |
| <li>columnsUsed.getSource(0) returns 3 |
| <li>columnsUsed.getSource(1) returns 2 |
| <li>columnsUsed.getSource(2) throws IndexOutOfBounds |
| <li>columnsUsed.getTargetOpt(3) returns 0 |
| <li>columnsUsed.getTargetOpt(0) returns -1 |
| </ul></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.calcite.sql2rel.RelFieldTrimmer.TrimResult">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.util.Pair">Fields inherited from class org.apache.calcite.util.<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a></h3> |
| <code><a href="../util/Pair.html#left">left</a>, <a href="../util/Pair.html#right">right</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.RelNode,org.apache.calcite.util.mapping.Mapping)" class="member-name-link">TrimResult</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a> right)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a TrimResult.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.util.Pair">Methods inherited from class org.apache.calcite.util.<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a></h3> |
| <code><a href="../util/Pair.html#adjacents(java.lang.Iterable)">adjacents</a>, <a href="../util/Pair.html#compareTo(org.apache.calcite.util.Pair)">compareTo</a>, <a href="../util/Pair.html#equals(java.lang.Object)">equals</a>, <a href="../util/Pair.html#firstAnd(java.lang.Iterable)">firstAnd</a>, <a href="../util/Pair.html#forEach(java.lang.Iterable,java.util.function.BiConsumer)">forEach</a>, <a href="../util/Pair.html#forEach(java.lang.Iterable,java.lang.Iterable,java.util.function.BiConsumer)">forEach</a>, <a href="../util/Pair.html#getKey()">getKey</a>, <a href="../util/Pair.html#getValue()">getValue</a>, <a href="../util/Pair.html#hashCode()">hashCode</a>, <a href="../util/Pair.html#left(java.lang.Iterable)">left</a>, <a href="../util/Pair.html#left(java.util.List)">left</a>, <a href="../util/Pair.html#of(java.util.Map.Entry)">of</a>, <a href="../util/Pair.html#of(T1,T2)">of</a>, <a href="../util/Pair.html#right(java.lang.Iterable)">right</a>, <a href="../util/Pair.html#right(java.util.List)">right</a>, <a href="../util/Pair.html#setValue(T2)">setValue</a>, <a href="../util/Pair.html#toMap(java.lang.Iterable)">toMap</a>, <a href="../util/Pair.html#toString()">toString</a>, <a href="../util/Pair.html#zip(java.lang.Iterable,java.lang.Iterable)">zip</a>, <a href="../util/Pair.html#zip(java.util.List,java.util.List)">zip</a>, <a href="../util/Pair.html#zip(java.util.List,java.util.List,boolean)">zip</a>, <a href="../util/Pair.html#zip(K%5B%5D,V%5B%5D)">zip</a>, <a href="../util/Pair.html#zipMutable(java.util.List,java.util.List)">zipMutable</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#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/Object.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/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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.rel.RelNode,org.apache.calcite.util.mapping.Mapping)"> |
| <h3>TrimResult</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TrimResult</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> left, |
| <a href="../util/mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a> right)</span></div> |
| <div class="block">Creates a TrimResult.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>left</code> - New relational expression</dd> |
| <dd><code>right</code> - Mapping of fields onto original fields</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> |