javadocAggregate/org/apache/calcite/rel/RelDistributionTraitDef.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>RelDistributionTraitDef (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, class: RelDistributionTraitDef">
 <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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.rel</a></div>
 <h1 title="Class RelDistributionTraitDef" class="title">Class RelDistributionTraitDef</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="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;
 <div class="inheritance">org.apache.calcite.rel.RelDistributionTraitDef</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RelDistributionTraitDef</span>
 <span class="extends-implements">extends <a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</span></div>
 <div class="block">Definition of the distribution trait.

  <p>Distribution is a physical property (i.e. a trait) because it can be
  changed without loss of information. The converter to do this is the
  <a href="core/Exchange.html" title="class in org.apache.calcite.rel.core"><code>Exchange</code></a> operator.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static final <a href="RelDistributionTraitDef.html" title="class in org.apache.calcite.rel">RelDistributionTraitDef</a></code></div>
 <div class="col-second even-row-color"><code><a href="#INSTANCE" class="member-name-link">INSTANCE</a></code></div>
 <div class="col-last even-row-color">&nbsp;</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-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>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelDistribution,org.apache.calcite.rel.RelDistribution)" class="member-name-link">canConvert</a><wbr>(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
  <a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&nbsp;fromTrait,
  <a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&nbsp;toTrait)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelDistribution,boolean)" class="member-name-link">convert</a><wbr>(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
  <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
  <a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&nbsp;toDistribution,
  boolean&nbsp;allowInfiniteCostConverters)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Converts the given RelNode to the given RelTrait.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefault()" class="member-name-link">getDefault</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the default member of this trait.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSimpleName()" class="member-name-link">getSimpleName</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns a simple name for this RelTraitDef (for use in
  <a href="RelNode.html#explain(org.apache.calcite.rel.RelWriter)"><code>RelNode.explain(org.apache.calcite.rel.RelWriter)</code></a>).</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTraitClass()" class="member-name-link">getTraitClass</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the specific RelTrait type associated with this RelTraitDef.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.calcite.plan.RelTraitDef">Methods inherited from class&nbsp;org.apache.calcite.plan.<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></h3>
 <code><a href="../plan/RelTraitDef.html#canonize(T)">canonize</a>, <a href="../plan/RelTraitDef.html#deregisterConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">deregisterConverterRule</a>, <a href="../plan/RelTraitDef.html#multiple()">multiple</a>, <a href="../plan/RelTraitDef.html#registerConverterRule(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.convert.ConverterRule)">registerConverterRule</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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#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/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#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/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#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/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">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="INSTANCE">
 <h3>INSTANCE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="RelDistributionTraitDef.html" title="class in org.apache.calcite.rel">RelDistributionTraitDef</a></span>&nbsp;<span class="element-name">INSTANCE</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="getTraitClass()">
 <h3>getTraitClass</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</span>&nbsp;<span class="element-name">getTraitClass</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../plan/RelTraitDef.html#getTraitClass()">RelTraitDef</a></code></span></div>
 <div class="block">Returns the specific RelTrait type associated with this RelTraitDef.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../plan/RelTraitDef.html#getTraitClass()">getTraitClass</a></code>&nbsp;in class&nbsp;<code><a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getSimpleName()">
 <h3>getSimpleName</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">getSimpleName</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../plan/RelTraitDef.html#getSimpleName()">RelTraitDef</a></code></span></div>
 <div class="block">Returns a simple name for this RelTraitDef (for use in
  <a href="RelNode.html#explain(org.apache.calcite.rel.RelWriter)"><code>RelNode.explain(org.apache.calcite.rel.RelWriter)</code></a>).</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../plan/RelTraitDef.html#getSimpleName()">getSimpleName</a></code>&nbsp;in class&nbsp;<code><a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getDefault()">
 <h3>getDefault</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a></span>&nbsp;<span class="element-name">getDefault</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../plan/RelTraitDef.html#getDefault()">RelTraitDef</a></code></span></div>
 <div class="block">Returns the default member of this trait.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../plan/RelTraitDef.html#getDefault()">getDefault</a></code>&nbsp;in class&nbsp;<code><a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelDistribution,boolean)">
 <h3>convert</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span>&nbsp;<span class="element-name">convert</span><wbr><span class="parameters">(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
  <a href="RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
  <a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&nbsp;toDistribution,
  boolean&nbsp;allowInfiniteCostConverters)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../plan/RelTraitDef.html#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,T,boolean)">RelTraitDef</a></code></span></div>
 <div class="block">Converts the given RelNode to the given RelTrait.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../plan/RelTraitDef.html#convert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelNode,T,boolean)">convert</a></code>&nbsp;in class&nbsp;<code><a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>planner</code> - the planner requesting the conversion</dd>
 <dd><code>rel</code> - RelNode to convert</dd>
 <dd><code>toDistribution</code> - RelTrait to convert to</dd>
 <dd><code>allowInfiniteCostConverters</code> - flag indicating whether infinite cost
                                     converters are allowed</dd>
 <dt>Returns:</dt>
 <dd>a converted RelNode or null if conversion is not possible</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="canConvert(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.RelDistribution,org.apache.calcite.rel.RelDistribution)">
 <h3>canConvert</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">canConvert</span><wbr><span class="parameters">(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
  <a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&nbsp;fromTrait,
  <a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&nbsp;toTrait)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="../plan/RelTraitDef.html#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)">RelTraitDef</a></code></span></div>
 <div class="block">Tests whether the given RelTrait can be converted to another RelTrait.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../plan/RelTraitDef.html#canConvert(org.apache.calcite.plan.RelOptPlanner,T,T)">canConvert</a></code>&nbsp;in class&nbsp;<code><a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&lt;<a href="RelDistribution.html" title="interface in org.apache.calcite.rel">RelDistribution</a>&gt;</code></dd>
 <dt>Parameters:</dt>
 <dd><code>planner</code> - the planner requesting the conversion test</dd>
 <dd><code>fromTrait</code> - the RelTrait to convert from</dd>
 <dd><code>toTrait</code> - the RelTrait to convert to</dd>
 <dt>Returns:</dt>
 <dd>true if fromTrait can be converted to toTrait</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>