| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelCollations (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: RelCollations"> |
| <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><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </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</a></div> |
| <h1 title="Class RelCollations" class="title">Class RelCollations</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.RelCollations</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">RelCollations</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">Utilities concerning <a href="RelCollation.html" title="interface in org.apache.calcite.rel"><code>RelCollation</code></a> |
| and <a href="RelFieldCollation.html" title="class in org.apache.calcite.rel"><code>RelFieldCollation</code></a>.</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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#EMPTY" class="member-name-link">EMPTY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A collation indicating that a relation is not sorted.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#PRESERVE" class="member-name-link">PRESERVE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#collationsContainKeysOrderless(java.util.List,java.util.List)" class="member-name-link">collationsContainKeysOrderless</a><wbr>(<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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations, |
| <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="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>> keys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether one of a list of collations contains the given list of keys |
| regardless the order.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#contains(java.util.List,org.apache.calcite.util.ImmutableIntList)" class="member-name-link">contains</a><wbr>(<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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations, |
| <a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> keys)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether one of a list of collations indicates that the collection |
| is sorted on the given list of keys.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#contains(org.apache.calcite.rel.RelCollation,java.lang.Iterable)" class="member-name-link">contains</a><wbr>(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="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>> keys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a collation indicates that the collection is sorted on |
| a given list of keys.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#containsOrderless(java.util.List,org.apache.calcite.rel.RelCollation)" class="member-name-link">containsOrderless</a><wbr>(<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="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>> keys, |
| <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a collation is contained by a given list of keys regardless ordering.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#containsOrderless(org.apache.calcite.rel.RelCollation,java.util.List)" class="member-name-link">containsOrderless</a><wbr>(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <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="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>> keys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a collation contains a given list of keys regardless |
| the order.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createSingleton(int)" class="member-name-link">createSingleton</a><wbr>(int fieldIndex)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a list containing one collation containing one field.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#equal(java.util.List,java.util.List)" class="member-name-link">equal</a><wbr>(<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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList1, |
| <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList2)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isValid(org.apache.calcite.rel.type.RelDataType,java.util.List,boolean)" class="member-name-link">isValid</a><wbr>(<a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList, |
| boolean fail)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Checks that a collection of collations is valid.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#keysContainCollationsOrderless(java.util.List,java.util.List)" class="member-name-link">keysContainCollationsOrderless</a><wbr>(<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="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>> keys, |
| <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether one of a list of collations is contained by the given list of keys |
| regardless the order.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(int)" class="member-name-link">of</a><wbr>(int fieldIndex)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a collation containing one field.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(java.util.List)" class="member-name-link">of</a><wbr>(<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="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.calcite.rel.RelFieldCollation...)" class="member-name-link">of</a><wbr>(<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>... fieldCollations)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.calcite.util.ImmutableIntList)" class="member-name-link">of</a><wbr>(<a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> keys)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a collation containing multiple fields.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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="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-tab1 method-summary-table-tab4"><code><a href="#ordinals(java.util.List)" class="member-name-link">ordinals</a><wbr>(<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="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the indexes of the fields in a list of field collations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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="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 even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#ordinals(org.apache.calcite.rel.RelCollation)" class="member-name-link">ordinals</a><wbr>(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the indexes of the field collations in a given collation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#permute(org.apache.calcite.rel.RelCollation,java.util.Map)" class="member-name-link">permute</a><wbr>(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><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>> mapping)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a copy of this collation that changes the ordinals of input |
| fields.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#permute(org.apache.calcite.rel.RelCollation,org.apache.calcite.util.mapping.Mappings.TargetMapping)" class="member-name-link">permute</a><wbr>(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a> mapping)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a copy of this collation that changes the ordinals of input |
| fields.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#shift(org.apache.calcite.rel.RelCollation,int)" class="member-name-link">shift</a><wbr>(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| int offset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="EMPTY"> |
| <h3>EMPTY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">EMPTY</span></div> |
| <div class="block">A collation indicating that a relation is not sorted. Ordering by no |
| columns.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PRESERVE"> |
| <h3>PRESERVE</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 static final</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">PRESERVE</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">A collation that cannot be replicated by applying a sort. The only |
| implementation choice is to apply operations that preserve order.</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="of(org.apache.calcite.rel.RelFieldCollation...)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>... fieldCollations)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="of(java.util.List)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">of</span><wbr><span class="parameters">(<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="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="of(int)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">of</span><wbr><span class="parameters">(int fieldIndex)</span></div> |
| <div class="block">Creates a collation containing one field.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="of(org.apache.calcite.util.ImmutableIntList)"> |
| <h3>of</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">of</span><wbr><span class="parameters">(<a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> keys)</span></div> |
| <div class="block">Creates a collation containing multiple fields.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSingleton(int)"> |
| <h3>createSingleton</h3> |
| <div class="member-signature"><span class="modifiers">public static</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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>></span> <span class="element-name">createSingleton</span><wbr><span class="parameters">(int fieldIndex)</span></div> |
| <div class="block">Creates a list containing one collation containing one field.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid(org.apache.calcite.rel.type.RelDataType,java.util.List,boolean)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(<a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList, |
| boolean fail)</span></div> |
| <div class="block">Checks that a collection of collations is valid.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rowType</code> - Row type of the relational expression</dd> |
| <dd><code>collationList</code> - List of collations</dd> |
| <dd><code>fail</code> - Whether to fail if invalid</dd> |
| <dt>Returns:</dt> |
| <dd>Whether valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equal(java.util.List,java.util.List)"> |
| <h3>equal</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">equal</span><wbr><span class="parameters">(<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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList1, |
| <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList2)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ordinals(org.apache.calcite.rel.RelCollation)"> |
| <h3>ordinals</h3> |
| <div class="member-signature"><span class="modifiers">public static</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="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">ordinals</span><wbr><span class="parameters">(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</span></div> |
| <div class="block">Returns the indexes of the field collations in a given collation.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ordinals(java.util.List)"> |
| <h3>ordinals</h3> |
| <div class="member-signature"><span class="modifiers">public static</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="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">ordinals</span><wbr><span class="parameters">(<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="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</span></div> |
| <div class="block">Returns the indexes of the fields in a list of field collations.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contains(org.apache.calcite.rel.RelCollation,java.lang.Iterable)"> |
| <h3>contains</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">contains</span><wbr><span class="parameters">(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="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>> keys)</span></div> |
| <div class="block">Returns whether a collation indicates that the collection is sorted on |
| a given list of keys.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>collation</code> - Collation</dd> |
| <dd><code>keys</code> - List of keys</dd> |
| <dt>Returns:</dt> |
| <dd>Whether the collection is sorted on the given keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contains(java.util.List,org.apache.calcite.util.ImmutableIntList)"> |
| <h3>contains</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">contains</span><wbr><span class="parameters">(<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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations, |
| <a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> keys)</span></div> |
| <div class="block">Returns whether one of a list of collations indicates that the collection |
| is sorted on the given list of keys.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsOrderless(org.apache.calcite.rel.RelCollation,java.util.List)"> |
| <h3>containsOrderless</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">containsOrderless</span><wbr><span class="parameters">(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <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="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>> keys)</span></div> |
| <div class="block">Returns whether a collation contains a given list of keys regardless |
| the order.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>collation</code> - Collation</dd> |
| <dd><code>keys</code> - List of keys</dd> |
| <dt>Returns:</dt> |
| <dd>Whether the collection contains the given keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsOrderless(java.util.List,org.apache.calcite.rel.RelCollation)"> |
| <h3>containsOrderless</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">containsOrderless</span><wbr><span class="parameters">(<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="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>> keys, |
| <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</span></div> |
| <div class="block">Returns whether a collation is contained by a given list of keys regardless ordering.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>collation</code> - Collation</dd> |
| <dd><code>keys</code> - List of keys</dd> |
| <dt>Returns:</dt> |
| <dd>Whether the collection contains the given keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="collationsContainKeysOrderless(java.util.List,java.util.List)"> |
| <h3>collationsContainKeysOrderless</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">collationsContainKeysOrderless</span><wbr><span class="parameters">(<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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations, |
| <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="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>> keys)</span></div> |
| <div class="block">Returns whether one of a list of collations contains the given list of keys |
| regardless the order.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keysContainCollationsOrderless(java.util.List,java.util.List)"> |
| <h3>keysContainCollationsOrderless</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">keysContainCollationsOrderless</span><wbr><span class="parameters">(<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="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>> keys, |
| <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="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations)</span></div> |
| <div class="block">Returns whether one of a list of collations is contained by the given list of keys |
| regardless the order.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shift(org.apache.calcite.rel.RelCollation,int)"> |
| <h3>shift</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">shift</span><wbr><span class="parameters">(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| int offset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="permute(org.apache.calcite.rel.RelCollation,java.util.Map)"> |
| <h3>permute</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">permute</span><wbr><span class="parameters">(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><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>> mapping)</span></div> |
| <div class="block">Creates a copy of this collation that changes the ordinals of input |
| fields.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="permute(org.apache.calcite.rel.RelCollation,org.apache.calcite.util.mapping.Mappings.TargetMapping)"> |
| <h3>permute</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="element-name">permute</span><wbr><span class="parameters">(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a> mapping)</span></div> |
| <div class="block">Creates a copy of this collation that changes the ordinals of input |
| fields.</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> |
