| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>LoptMultiJoin (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.rules, class: LoptMultiJoin"> |
| <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><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><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.rules</a></div> |
| <h1 title="Class LoptMultiJoin" class="title">Class LoptMultiJoin</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">org.apache.calcite.rel.rules.LoptMultiJoin</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">LoptMultiJoin</span> |
| <span class="extends-implements">extends <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></span></div> |
| <div class="block">Utility class that keeps track of the join factors that |
| make up a <a href="MultiJoin.html" title="class in org.apache.calcite.rel.rules"><code>MultiJoin</code></a>.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== 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.rules.MultiJoin)" class="member-name-link">LoptMultiJoin</a><wbr>(<a href="MultiJoin.html" title="class in org.apache.calcite.rel.rules">MultiJoin</a> multiJoin)</code></div> |
| <div class="col-last even-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-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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRemovableOuterJoinFactor(int)" class="member-name-link">addRemovableOuterJoinFactor</a><wbr>(int factIdx)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a join factor to the set of factors that can be removed because the |
| factor is the null-generating factor in an outer join, its join keys are |
| unique, and the factor is not projected in the query.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRemovableSelfJoinPair(int,int)" class="member-name-link">addRemovableSelfJoinPair</a><wbr>(int factor1, |
| int factor2)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds to a map that keeps track of removable self-join pairs.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.calcite.rel.rules.LoptMultiJoin.Edge</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createEdge(org.apache.calcite.rex.RexNode)" class="member-name-link">createEdge</a><wbr>(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> condition)</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>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findRef(int)" class="member-name-link">findRef</a><wbr>(int rexInputRef)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines the join factor corresponding to a RexInputRef.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getChildFactors(org.apache.calcite.rel.rules.LoptJoinTree,org.apache.calcite.util.ImmutableBitSet.Builder)" class="member-name-link">getChildFactors</a><wbr>(<a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> joinTree, |
| <a href="../../util/ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a> childFactors)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFactorsRefByFactor(int)" class="member-name-link">getFactorsRefByFactor</a><wbr>(int factIdx)</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 bitmap corresponding to the factors referenced by the specified |
| factor in the various join filters that correspond to comparisons.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFactorsRefByJoinFilter(org.apache.calcite.rex.RexNode)" class="member-name-link">getFactorsRefByJoinFilter</a><wbr>(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> joinFilter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a bitmap corresponding to the factors referenced within |
| the specified join filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int[] @Nullable []</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFactorWeights()" class="member-name-link">getFactorWeights</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 weights of the different factors relative to one another.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFieldsRefByJoinFilter(org.apache.calcite.rex.RexNode)" class="member-name-link">getFieldsRefByJoinFilter</a><wbr>(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> joinFilter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a bitmap corresponding to the fields referenced by a join filter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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="#getJoinFactor(int)" class="member-name-link">getJoinFactor</a><wbr>(int factIdx)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the factor corresponding to the given factor index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinFieldRefCounts(int)" class="member-name-link">getJoinFieldRefCounts</a><wbr>(int factIdx)</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 join field reference counts for a factor.</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinFields(org.apache.calcite.rel.rules.LoptJoinTree,org.apache.calcite.rel.rules.LoptJoinTree)" class="member-name-link">getJoinFields</a><wbr>(<a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> left, |
| <a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> right)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Retrieves the fields corresponding to a join between a left and right |
| tree.</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinFilters()" class="member-name-link">getJoinFilters</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 all non-outer join filters in this multi-join.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinRemovalFactor(int)" class="member-name-link">getJoinRemovalFactor</a><wbr>(int dimIdx)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the factor id of the fact table corresponding to a dimension |
| table in a semi-join, in the case where the join with the dimension table |
| can be removed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../logical/LogicalJoin.html" title="class in org.apache.calcite.rel.logical">LogicalJoin</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinRemovalSemiJoin(int)" class="member-name-link">getJoinRemovalSemiJoin</a><wbr>(int dimIdx)</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 semi-join that allows the join of a dimension table to be |
| removed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoinStart(int)" class="member-name-link">getJoinStart</a><wbr>(int factIdx)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the starting offset within the multi-join for the specified factor.</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMultiJoinFields()" class="member-name-link">getMultiJoinFields</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 an array of fields contained within the multi-join.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MultiJoin.html" title="class in org.apache.calcite.rel.rules">MultiJoin</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMultiJoinRel()" class="member-name-link">getMultiJoinRel</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 the MultiJoin corresponding to this multi-join.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumFieldsInJoinFactor(int)" class="member-name-link">getNumFieldsInJoinFactor</a><wbr>(int factIdx)</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 number of fields in a given factor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumJoinFactors()" class="member-name-link">getNumJoinFactors</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 the number of factors in this multi-join.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumTotalFields()" class="member-name-link">getNumTotalFields</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 total number of fields in the multi-join.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOtherSelfJoinFactor(int)" class="member-name-link">getOtherSelfJoinFactor</a><wbr>(int factIdx)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the other factor in a self-join pair if the factor passed in is |
| a factor in a removable self-join; otherwise, returns null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOuterJoinCond(int)" class="member-name-link">getOuterJoinCond</a><wbr>(int factIdx)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns outer join conditions associated with the specified null-generating |
| factor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOuterJoinFactors(int)" class="member-name-link">getOuterJoinFactors</a><wbr>(int factIdx)</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 bitmap containing the factors that a null-generating factor is |
| dependent upon, if the factor is null-generating in a left or right outer |
| join; otherwise null is returned.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProjFields(int)" class="member-name-link">getProjFields</a><wbr>(int factIdx)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a bitmap containing the fields that are projected from a factor.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRightColumnMapping(int,int)" class="member-name-link">getRightColumnMapping</a><wbr>(int rightFactor, |
| int rightOffset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether there is a mapping from a column in the right factor |
| of a self-join to a column from the left factor.</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="#hasAllFactors(org.apache.calcite.rel.rules.LoptJoinTree,java.util.BitSet)" class="member-name-link">hasAllFactors</a><wbr>(<a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> joinTree, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/BitSet.html" title="class or interface in java.util" class="external-link">BitSet</a> factorsNeeded)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether if a join tree contains all factors required.</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="#isLeftFactorInRemovableSelfJoin(int)" class="member-name-link">isLeftFactorInRemovableSelfJoin</a><wbr>(int factIdx)</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 the factor is the left factor in a self-join.</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="#isNullGenerating(int)" class="member-name-link">isNullGenerating</a><wbr>(int factIdx)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether the factor corresponds to a null-generating factor |
| in a left or right outer join.</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="#isRemovableOuterJoinFactor(int)" class="member-name-link">isRemovableOuterJoinFactor</a><wbr>(int factIdx)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return whether the factor corresponds to the null-generating factor in |
| an outer join that can be removed.</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="#isRightFactorInRemovableSelfJoin(int)" class="member-name-link">isRightFactorInRemovableSelfJoin</a><wbr>(int factIdx)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether the factor is the right factor in a self-join.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFactorWeights()" class="member-name-link">setFactorWeights</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets weighting for each combination of factors, depending on which join |
| filters reference which factors.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setJoinRemovalFactor(int,int)" class="member-name-link">setJoinRemovalFactor</a><wbr>(int dimIdx, |
| int factIdx)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Indicates that a dimension factor's join can be removed because of a |
| semijoin with a fact table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setJoinRemovalSemiJoin(int,org.apache.calcite.rel.logical.LogicalJoin)" class="member-name-link">setJoinRemovalSemiJoin</a><wbr>(int dimIdx, |
| <a href="../logical/LogicalJoin.html" title="class in org.apache.calcite.rel.logical">LogicalJoin</a> semiJoin)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Indicates the semi-join that allows the join of a dimension table to be |
| removed.</div> |
| </div> |
| </div> |
| </div> |
| </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#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"> |
| <!-- ========= 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.rules.MultiJoin)"> |
| <h3>LoptMultiJoin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LoptMultiJoin</span><wbr><span class="parameters">(<a href="MultiJoin.html" title="class in org.apache.calcite.rel.rules">MultiJoin</a> multiJoin)</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="getMultiJoinRel()"> |
| <h3>getMultiJoinRel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MultiJoin.html" title="class in org.apache.calcite.rel.rules">MultiJoin</a></span> <span class="element-name">getMultiJoinRel</span>()</div> |
| <div class="block">Returns the MultiJoin corresponding to this multi-join.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumJoinFactors()"> |
| <h3>getNumJoinFactors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumJoinFactors</span>()</div> |
| <div class="block">Returns the number of factors in this multi-join.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinFactor(int)"> |
| <h3>getJoinFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">getJoinFactor</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns the factor corresponding to the given factor index.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor to be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumTotalFields()"> |
| <h3>getNumTotalFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumTotalFields</span>()</div> |
| <div class="block">Returns the total number of fields in the multi-join.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumFieldsInJoinFactor(int)"> |
| <h3>getNumFieldsInJoinFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNumFieldsInJoinFactor</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns the number of fields in a given factor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Desired factor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinFilters()"> |
| <h3>getJoinFilters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></span> <span class="element-name">getJoinFilters</span>()</div> |
| <div class="block">Returns all non-outer join filters in this multi-join.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFactorsRefByJoinFilter(org.apache.calcite.rex.RexNode)"> |
| <h3>getFactorsRefByJoinFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getFactorsRefByJoinFilter</span><wbr><span class="parameters">(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> joinFilter)</span></div> |
| <div class="block">Returns a bitmap corresponding to the factors referenced within |
| the specified join filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>joinFilter</code> - Filter for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMultiJoinFields()"> |
| <h3>getMultiJoinFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></span> <span class="element-name">getMultiJoinFields</span>()</div> |
| <div class="block">Returns an array of fields contained within the multi-join.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFieldsRefByJoinFilter(org.apache.calcite.rex.RexNode)"> |
| <h3>getFieldsRefByJoinFilter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getFieldsRefByJoinFilter</span><wbr><span class="parameters">(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> joinFilter)</span></div> |
| <div class="block">Returns a bitmap corresponding to the fields referenced by a join filter.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>joinFilter</code> - the filter for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFactorWeights()"> |
| <h3>getFactorWeights</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int[] @Nullable []</span> <span class="element-name">getFactorWeights</span>()</div> |
| <div class="block">Returns weights of the different factors relative to one another.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFactorsRefByFactor(int)"> |
| <h3>getFactorsRefByFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getFactorsRefByFactor</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns a bitmap corresponding to the factors referenced by the specified |
| factor in the various join filters that correspond to comparisons.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinStart(int)"> |
| <h3>getJoinStart</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getJoinStart</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns the starting offset within the multi-join for the specified factor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNullGenerating(int)"> |
| <h3>isNullGenerating</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isNullGenerating</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns whether the factor corresponds to a null-generating factor |
| in a left or right outer join.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOuterJoinFactors(int)"> |
| <h3>getOuterJoinFactors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getOuterJoinFactors</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns a bitmap containing the factors that a null-generating factor is |
| dependent upon, if the factor is null-generating in a left or right outer |
| join; otherwise null is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOuterJoinCond(int)"> |
| <h3>getOuterJoinCond</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">getOuterJoinCond</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns outer join conditions associated with the specified null-generating |
| factor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProjFields(int)"> |
| <h3>getProjFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="element-name">getProjFields</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns a bitmap containing the fields that are projected from a factor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinFieldRefCounts(int)"> |
| <h3>getJoinFieldRefCounts</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int[]</span> <span class="element-name">getJoinFieldRefCounts</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns the join field reference counts for a factor.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinRemovalFactor(int)"> |
| <h3>getJoinRemovalFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getJoinRemovalFactor</span><wbr><span class="parameters">(int dimIdx)</span></div> |
| <div class="block">Returns the factor id of the fact table corresponding to a dimension |
| table in a semi-join, in the case where the join with the dimension table |
| can be removed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dimIdx</code> - Dimension factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinRemovalSemiJoin(int)"> |
| <h3>getJoinRemovalSemiJoin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../logical/LogicalJoin.html" title="class in org.apache.calcite.rel.logical">LogicalJoin</a></span> <span class="element-name">getJoinRemovalSemiJoin</span><wbr><span class="parameters">(int dimIdx)</span></div> |
| <div class="block">Returns the semi-join that allows the join of a dimension table to be |
| removed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dimIdx</code> - Dimension factor for which information will be returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setJoinRemovalFactor(int,int)"> |
| <h3>setJoinRemovalFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setJoinRemovalFactor</span><wbr><span class="parameters">(int dimIdx, |
| int factIdx)</span></div> |
| <div class="block">Indicates that a dimension factor's join can be removed because of a |
| semijoin with a fact table.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dimIdx</code> - Dimension factor</dd> |
| <dd><code>factIdx</code> - Fact factor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setJoinRemovalSemiJoin(int,org.apache.calcite.rel.logical.LogicalJoin)"> |
| <h3>setJoinRemovalSemiJoin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setJoinRemovalSemiJoin</span><wbr><span class="parameters">(int dimIdx, |
| <a href="../logical/LogicalJoin.html" title="class in org.apache.calcite.rel.logical">LogicalJoin</a> semiJoin)</span></div> |
| <div class="block">Indicates the semi-join that allows the join of a dimension table to be |
| removed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dimIdx</code> - Dimension factor</dd> |
| <dd><code>semiJoin</code> - the semijoin</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findRef(int)"> |
| <h3>findRef</h3> |
| <div class="member-signature"><span class="annotations">@RequiresNonNull({"joinStart","nFieldsInJoinFactor"}) |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">findRef</span><wbr><span class="parameters">(@UnknownInitialization LoptMultiJoin this, |
| int rexInputRef)</span></div> |
| <div class="block">Determines the join factor corresponding to a RexInputRef.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rexInputRef</code> - rexInputRef index</dd> |
| <dt>Returns:</dt> |
| <dd>index corresponding to join factor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFactorWeights()"> |
| <h3>setFactorWeights</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setFactorWeights</span>()</div> |
| <div class="block">Sets weighting for each combination of factors, depending on which join |
| filters reference which factors. Greater weight is given to equality |
| conditions. Also, sets bitmaps indicating which factors are referenced by |
| each factor within join filters that are comparisons.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasAllFactors(org.apache.calcite.rel.rules.LoptJoinTree,java.util.BitSet)"> |
| <h3>hasAllFactors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">hasAllFactors</span><wbr><span class="parameters">(<a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> joinTree, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/BitSet.html" title="class or interface in java.util" class="external-link">BitSet</a> factorsNeeded)</span></div> |
| <div class="block">Returns whether if a join tree contains all factors required.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>joinTree</code> - Join tree to be examined</dd> |
| <dd><code>factorsNeeded</code> - Bitmap of factors required</dd> |
| <dt>Returns:</dt> |
| <dd>true if join tree contains all required factors</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getChildFactors(org.apache.calcite.rel.rules.LoptJoinTree,org.apache.calcite.util.ImmutableBitSet.Builder)"> |
| <h3>getChildFactors</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">getChildFactors</span><wbr><span class="parameters">(<a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> joinTree, |
| <a href="../../util/ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a> childFactors)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Sets a bitmap indicating all child RelNodes in a join tree.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>joinTree</code> - join tree to be examined</dd> |
| <dd><code>childFactors</code> - bitmap to be set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJoinFields(org.apache.calcite.rel.rules.LoptJoinTree,org.apache.calcite.rel.rules.LoptJoinTree)"> |
| <h3>getJoinFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></span> <span class="element-name">getJoinFields</span><wbr><span class="parameters">(<a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> left, |
| <a href="LoptJoinTree.html" title="class in org.apache.calcite.rel.rules">LoptJoinTree</a> right)</span></div> |
| <div class="block">Retrieves the fields corresponding to a join between a left and right |
| tree.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>left</code> - left hand side of the join</dd> |
| <dd><code>right</code> - right hand side of the join</dd> |
| <dt>Returns:</dt> |
| <dd>fields of the join</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRemovableOuterJoinFactor(int)"> |
| <h3>addRemovableOuterJoinFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addRemovableOuterJoinFactor</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Adds a join factor to the set of factors that can be removed because the |
| factor is the null-generating factor in an outer join, its join keys are |
| unique, and the factor is not projected in the query.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Join factor</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRemovableOuterJoinFactor(int)"> |
| <h3>isRemovableOuterJoinFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRemovableOuterJoinFactor</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Return whether the factor corresponds to the null-generating factor in |
| an outer join that can be removed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor in question</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRemovableSelfJoinPair(int,int)"> |
| <h3>addRemovableSelfJoinPair</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addRemovableSelfJoinPair</span><wbr><span class="parameters">(int factor1, |
| int factor2)</span></div> |
| <div class="block">Adds to a map that keeps track of removable self-join pairs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factor1</code> - one of the factors in the self-join</dd> |
| <dd><code>factor2</code> - the second factor in the self-join</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOtherSelfJoinFactor(int)"> |
| <h3>getOtherSelfJoinFactor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getOtherSelfJoinFactor</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns the other factor in a self-join pair if the factor passed in is |
| a factor in a removable self-join; otherwise, returns null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - one of the factors in a self-join pair</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLeftFactorInRemovableSelfJoin(int)"> |
| <h3>isLeftFactorInRemovableSelfJoin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isLeftFactorInRemovableSelfJoin</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns whether the factor is the left factor in a self-join.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor in a self-join</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isRightFactorInRemovableSelfJoin(int)"> |
| <h3>isRightFactorInRemovableSelfJoin</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isRightFactorInRemovableSelfJoin</span><wbr><span class="parameters">(int factIdx)</span></div> |
| <div class="block">Returns whether the factor is the right factor in a self-join.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>factIdx</code> - Factor in a self-join</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRightColumnMapping(int,int)"> |
| <h3>getRightColumnMapping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getRightColumnMapping</span><wbr><span class="parameters">(int rightFactor, |
| int rightOffset)</span></div> |
| <div class="block">Determines whether there is a mapping from a column in the right factor |
| of a self-join to a column from the left factor. Assumes that the right |
| factor is a part of a self-join.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rightFactor</code> - the index of the right factor</dd> |
| <dd><code>rightOffset</code> - the column offset of the right factor</dd> |
| <dt>Returns:</dt> |
| <dd>the offset of the corresponding column in the left factor, if |
| such a column mapping exists; otherwise, null is returned</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createEdge(org.apache.calcite.rex.RexNode)"> |
| <h3>createEdge</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.calcite.rel.rules.LoptMultiJoin.Edge</span> <span class="element-name">createEdge</span><wbr><span class="parameters">(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a> condition)</span></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> |
