| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Converter (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.rel.convert, interface: Converter"> |
| <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>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.rel.convert</a></div> |
| <h1 title="Interface Converter" class="title">Interface Converter</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/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code>, <code><a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../plan/volcano/AbstractConverter.html" title="class in org.apache.calcite.plan.volcano">AbstractConverter</a></code>, <code><a href="../../adapter/cassandra/CassandraToEnumerableConverter.html" title="class in org.apache.calcite.adapter.cassandra">CassandraToEnumerableConverter</a></code>, <code><a href="ConverterImpl.html" title="class in org.apache.calcite.rel.convert">ConverterImpl</a></code>, <code><a href="../../adapter/elasticsearch/ElasticsearchToEnumerableConverter.html" title="class in org.apache.calcite.adapter.elasticsearch">ElasticsearchToEnumerableConverter</a></code>, <code><a href="../../adapter/enumerable/EnumerableBindable.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableBindable</a></code>, <code><a href="../../adapter/enumerable/EnumerableInterpretable.html" title="class in org.apache.calcite.adapter.enumerable">EnumerableInterpretable</a></code>, <code><a href="../../adapter/spark/EnumerableToSparkConverter.html" title="class in org.apache.calcite.adapter.spark">EnumerableToSparkConverter</a></code>, <code><a href="../../adapter/geode/rel/GeodeToEnumerableConverter.html" title="class in org.apache.calcite.adapter.geode.rel">GeodeToEnumerableConverter</a></code>, <code><a href="../../adapter/innodb/InnodbToEnumerableConverter.html" title="class in org.apache.calcite.adapter.innodb">InnodbToEnumerableConverter</a></code>, <code><a href="../../interpreter/InterpretableConverter.html" title="class in org.apache.calcite.interpreter">InterpretableConverter</a></code>, <code><a href="../../adapter/jdbc/JdbcToEnumerableConverter.html" title="class in org.apache.calcite.adapter.jdbc">JdbcToEnumerableConverter</a></code>, <code><a href="../../adapter/spark/JdbcToSparkConverter.html" title="class in org.apache.calcite.adapter.spark">JdbcToSparkConverter</a></code>, <code><a href="../../adapter/mongodb/MongoToEnumerableConverter.html" title="class in org.apache.calcite.adapter.mongodb">MongoToEnumerableConverter</a></code>, <code><a href="NoneConverter.html" title="class in org.apache.calcite.rel.convert">NoneConverter</a></code>, <code><a href="../../adapter/pig/PigToEnumerableConverter.html" title="class in org.apache.calcite.adapter.pig">PigToEnumerableConverter</a></code>, <code><a href="../../adapter/spark/SparkToEnumerableConverter.html" title="class in org.apache.calcite.adapter.spark">SparkToEnumerableConverter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Converter</span><span class="extends-implements"> |
| extends <a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span></div> |
| <div class="block">A relational expression implements the interface <code>Converter</code> to |
| indicate that it converts a physical attribute, or |
| <a href="../../plan/RelTrait.html" title="interface in org.apache.calcite.plan"><code>trait</code></a>, of a relational expression |
| from one value to another. |
| |
| <p>Sometimes this conversion is expensive; for example, to convert a |
| non-distinct to a distinct object stream, we have to clone every object in |
| the input.</p> |
| |
| <p>A converter does not change the logical expression being evaluated; after |
| conversion, the number of rows and the values of those rows will still be the |
| same. By declaring itself to be a converter, a relational expression is |
| telling the planner about this equivalence, and the planner groups |
| expressions which are logically equivalent but have different physical traits |
| into groups called <code>RelSet</code>s. |
| |
| <p>In principle one could devise converters which change multiple traits |
| simultaneously (say change the sort-order and the physical location of a |
| relational expression). In which case, the method <a href="#getInputTraits()"><code>getInputTraits()</code></a> |
| would return a <a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan"><code>RelTraitSet</code></a>. But for |
| simplicity, this class only allows one trait to be converted at a |
| time; all other traits are assumed to be preserved.</p></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-org.apache.calcite.rel.RelNode">Nested classes/interfaces inherited from interface org.apache.calcite.rel.<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h2> |
| <code><a href="../RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></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-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><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getInput()" class="member-name-link">getInput</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 sole input relational expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getInputTraits()" class="member-name-link">getInputTraits</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 trait of the input relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTraitDef()" class="member-name-link">getTraitDef</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 definition of trait which this converter works on.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.RelNode">Methods inherited from interface org.apache.calcite.rel.<a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3> |
| <code><a href="../RelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../RelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../RelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../RelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a>, <a href="../RelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a>, <a href="../RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a>, <a href="../RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a>, <a href="../RelNode.html#deepEquals(java.lang.Object)">deepEquals</a>, <a href="../RelNode.html#deepHashCode()">deepHashCode</a>, <a href="../RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a>, <a href="../RelNode.html#explain()">explain</a>, <a href="../RelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a>, <a href="../RelNode.html#fieldIsNullable(int)">fieldIsNullable</a>, <a href="../RelNode.html#getConvention()">getConvention</a>, <a href="../RelNode.html#getCorrelVariable()">getCorrelVariable</a>, <a href="../RelNode.html#getDigest()">getDigest</a>, <a href="../RelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../RelNode.html#getInput(int)">getInput</a>, <a href="../RelNode.html#getInputs()">getInputs</a>, <a href="../RelNode.html#getRelDigest()">getRelDigest</a>, <a href="../RelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../RelNode.html#getRowType()">getRowType</a>, <a href="../RelNode.html#getTable()">getTable</a>, <a href="../RelNode.html#getVariablesSet()">getVariablesSet</a>, <a href="../RelNode.html#isEnforcer()">isEnforcer</a>, <a href="../RelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a>, <a href="../RelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../RelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../RelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../RelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../RelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelOptNode">Methods inherited from interface org.apache.calcite.plan.<a href="../../plan/RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></h3> |
| <code><a href="../../plan/RelOptNode.html#getCluster()">getCluster</a>, <a href="../../plan/RelOptNode.html#getDescription()">getDescription</a>, <a href="../../plan/RelOptNode.html#getId()">getId</a>, <a href="../../plan/RelOptNode.html#getTraitSet()">getTraitSet</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="getInputTraits()"> |
| <h3>getInputTraits</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../plan/RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></span> <span class="element-name">getInputTraits</span>()</div> |
| <div class="block">Returns the trait of the input relational expression.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>input trait</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTraitDef()"> |
| <h3>getTraitDef</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="../../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></span> <span class="element-name">getTraitDef</span>()</div> |
| <div class="block">Returns the definition of trait which this converter works on. |
| |
| <p>The input relational expression (matched by the rule) must possess |
| this trait and have the value given by <a href="#getInputTraits()"><code>getInputTraits()</code></a>, and the |
| traits of the output of this converter given by <a href="../../plan/RelOptNode.html#getTraitSet()"><code>RelOptNode.getTraitSet()</code></a> will |
| have one trait altered and the other orthogonal traits will be the same.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>trait which this converter modifies</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInput()"> |
| <h3>getInput</h3> |
| <div class="member-signature"><span class="return-type"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">getInput</span>()</div> |
| <div class="block">Returns the sole input relational expression.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>child relational expression</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> |
