| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RelCollations (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">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="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.rel.RelCollations</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">RelCollations</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <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="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMPTY">EMPTY</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A collation indicating that a relation is not sorted.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PRESERVE">PRESERVE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collationsContainKeysOrderless(java.util.List,java.util.List)">collationsContainKeysOrderless</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether one of a list of collations contains the given list of keys |
| regardless the order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(java.util.List,org.apache.calcite.util.ImmutableIntList)">contains</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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></th> |
| <td class="colLast"> |
| <div class="block">Returns whether one of a list of collations indicates that the collection |
| is sorted on the given list of keys.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(org.apache.calcite.rel.RelCollation,java.lang.Iterable)">contains</a></span>​(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether a collation indicates that the collection is sorted on |
| a given list of keys.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsOrderless(java.util.List,org.apache.calcite.rel.RelCollation)">containsOrderless</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys, |
| <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether a collation is contained by a given list of keys regardless ordering.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsOrderless(org.apache.calcite.rel.RelCollation,java.util.List)">containsOrderless</a></span>​(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether a collation contains a given list of keys regardless |
| the order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSingleton(int)">createSingleton</a></span>​(int fieldIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a list containing one collation containing one field.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equal(java.util.List,java.util.List)">equal</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList1, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList2)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValid(org.apache.calcite.rel.type.RelDataType,java.util.List,boolean)">isValid</a></span>​(<a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList, |
| boolean fail)</code></th> |
| <td class="colLast"> |
| <div class="block">Checks that a collection of collations is valid.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keysContainCollationsOrderless(java.util.List,java.util.List)">keysContainCollationsOrderless</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether one of a list of collations is contained by the given list of keys |
| regardless the order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(int)">of</a></span>​(int fieldIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a collation containing one field.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.util.List)">of</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(org.apache.calcite.rel.RelFieldCollation...)">of</a></span>​(<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>... fieldCollations)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(org.apache.calcite.util.ImmutableIntList)">of</a></span>​(<a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> keys)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a collation containing multiple fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ordinals(java.util.List)">ordinals</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the indexes of the fields in a list of field collations.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ordinals(org.apache.calcite.rel.RelCollation)">ordinals</a></span>​(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the indexes of the field collations in a given collation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#permute(org.apache.calcite.rel.RelCollation,java.util.Map)">permute</a></span>​(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> mapping)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a copy of this collation that changes the ordinals of input |
| fields.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#permute(org.apache.calcite.rel.RelCollation,org.apache.calcite.util.mapping.Mappings.TargetMapping)">permute</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block">Creates a copy of this collation that changes the ordinals of input |
| fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code>static <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shift(org.apache.calcite.rel.RelCollation,int)">shift</a></span>​(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| int offset)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="EMPTY">EMPTY</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">EMPTY</span></div> |
| <div class="block">A collation indicating that a relation is not sorted. Ordering by no |
| columns.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="PRESERVE">PRESERVE</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">PRESERVE</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">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 class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(org.apache.calcite.rel.RelFieldCollation...)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">of</span>​(<span class="arguments"><a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>... fieldCollations)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(java.util.List)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">of</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>> fieldCollations)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(int)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">of</span>​(<span class="arguments">int fieldIndex)</span></div> |
| <div class="block">Creates a collation containing one field.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(org.apache.calcite.util.ImmutableIntList)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">of</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="createSingleton(int)">createSingleton</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>></span> <span class="memberName">createSingleton</span>​(<span class="arguments">int fieldIndex)</span></div> |
| <div class="block">Creates a list containing one collation containing one field.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isValid(org.apache.calcite.rel.type.RelDataType,java.util.List,boolean)">isValid</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">isValid</span>​(<span class="arguments"><a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equal(java.util.List,java.util.List)">equal</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">equal</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList1, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collationList2)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="ordinals(org.apache.calcite.rel.RelCollation)">ordinals</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></span> <span class="memberName">ordinals</span>​(<span class="arguments"><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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="ordinals(java.util.List)">ordinals</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></span> <span class="memberName">ordinals</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="contains(org.apache.calcite.rel.RelCollation,java.lang.Iterable)">contains</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">contains</span>​(<span class="arguments"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collation</code> - Collation</dd> |
| <dd><code>keys</code> - List of keys</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the collection is sorted on the given keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="contains(java.util.List,org.apache.calcite.util.ImmutableIntList)">contains</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">contains</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="containsOrderless(org.apache.calcite.rel.RelCollation,java.util.List)">containsOrderless</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">containsOrderless</span>​(<span class="arguments"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys)</span></div> |
| <div class="block">Returns whether a collation contains a given list of keys regardless |
| the order.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collation</code> - Collation</dd> |
| <dd><code>keys</code> - List of keys</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the collection contains the given keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="containsOrderless(java.util.List,org.apache.calcite.rel.RelCollation)">containsOrderless</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">containsOrderless</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>collation</code> - Collation</dd> |
| <dd><code>keys</code> - List of keys</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the collection contains the given keys</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collationsContainKeysOrderless(java.util.List,java.util.List)">collationsContainKeysOrderless</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">collationsContainKeysOrderless</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> collations, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="keysContainCollationsOrderless(java.util.List,java.util.List)">keysContainCollationsOrderless</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">keysContainCollationsOrderless</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> keys, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="shift(org.apache.calcite.rel.RelCollation,int)">shift</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">shift</span>​(<span class="arguments"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| int offset)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="permute(org.apache.calcite.rel.RelCollation,java.util.Map)">permute</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">permute</span>​(<span class="arguments"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> collation, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="permute(org.apache.calcite.rel.RelCollation,org.apache.calcite.util.mapping.Mappings.TargetMapping)">permute</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></span> <span class="memberName">permute</span>​(<span class="arguments"><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> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
