Google Git
Sign in
apache / calcite-site / ea7bd59de63e44ef822bd3c62faa848069cf4d92 / . / apidocs / org / apache / calcite / rel / RelCollations.html
blob: 68e14f7af81181f31827bc4a58f1cc9042b98339 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelCollations (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RelCollations (Apache Calcite API)";
}
}
catch(err) {
}
//-->
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};
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 = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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="class-use/RelCollations.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rel</a></div>
<h2 title="Class RelCollations" class="title">Class RelCollations</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.rel.RelCollations</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">RelCollations</span>
extends java.lang.Object</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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<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>
<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>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RelCollations</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<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>&#8203;(java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collations,
<a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a>&nbsp;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 id="i1" class="rowColor">
<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>&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
java.lang.Iterable&lt;java.lang.Integer&gt;&nbsp;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 id="i2" class="altColor">
<td class="colFirst"><code>private static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(org.apache.calcite.rel.RelCollation,java.util.List)">contains</a></span>&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
java.util.List&lt;java.lang.Integer&gt;&nbsp;keys)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSingleton(int)">createSingleton</a></span>&#8203;(int&nbsp;fieldIndex)</code></th>
<td class="colLast">
<div class="block">Creates a list containing one collation containing one field.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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>&#8203;(java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collationList1,
java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collationList2)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<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>&#8203;(<a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType,
java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collationList,
boolean&nbsp;fail)</code></th>
<td class="colLast">
<div class="block">Checks that a collection of collations is valid.</div>
</td>
</tr>
<tr id="i6" 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="#of(int)">of</a></span>&#8203;(int&nbsp;fieldIndex)</code></th>
<td class="colLast">
<div class="block">Creates a collation containing one field.</div>
</td>
</tr>
<tr id="i7" 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="#of(java.util.List)">of</a></span>&#8203;(java.util.List&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;fieldCollations)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" 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="#of(org.apache.calcite.rel.RelFieldCollation...)">of</a></span>&#8203;(<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>...&nbsp;fieldCollations)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;java.lang.Integer&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ordinals(java.util.List)">ordinals</a></span>&#8203;(java.util.List&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;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 id="i10" class="altColor">
<td class="colFirst"><code>static java.util.List&lt;java.lang.Integer&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ordinals(org.apache.calcite.rel.RelCollation)">ordinals</a></span>&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation)</code></th>
<td class="colLast">
<div class="block">Returns the indexes of the field collations in a given collation.</div>
</td>
</tr>
<tr id="i11" 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="#permute(org.apache.calcite.rel.RelCollation,java.util.Map)">permute</a></span>&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
java.util.Map&lt;java.lang.Integer,&#8203;java.lang.Integer&gt;&nbsp;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 id="i12" 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="#permute(org.apache.calcite.rel.RelCollation,org.apache.calcite.util.mapping.Mappings.TargetMapping)">permute</a></span>&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
<a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a>&nbsp;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 id="i13" 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="#shift(org.apache.calcite.rel.RelCollation,int)">shift</a></span>&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
int&nbsp;offset)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="EMPTY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EMPTY</h4>
<pre>public static final&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> EMPTY</pre>
<div class="block">A collation indicating that a relation is not sorted. Ordering by no
columns.</div>
</li>
</ul>
<a id="PRESERVE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PRESERVE</h4>
<pre>@Deprecated
public static final&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> PRESERVE</pre>
<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>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RelCollations</h4>
<pre>private&nbsp;RelCollations()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="of(org.apache.calcite.rel.RelFieldCollation...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">public static&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;of&#8203;(<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>...&nbsp;fieldCollations)</pre>
</li>
</ul>
<a id="of(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">public static&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;of&#8203;(java.util.List&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;fieldCollations)</pre>
</li>
</ul>
<a id="of(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">public static&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;of&#8203;(int&nbsp;fieldIndex)</pre>
<div class="block">Creates a collation containing one field.</div>
</li>
</ul>
<a id="createSingleton(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSingleton</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;createSingleton&#8203;(int&nbsp;fieldIndex)</pre>
<div class="block">Creates a list containing one collation containing one field.</div>
</li>
</ul>
<a id="isValid(org.apache.calcite.rel.type.RelDataType,java.util.List,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;isValid&#8203;(<a href="type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType,
java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collationList,
boolean&nbsp;fail)</pre>
<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>
</li>
</ul>
<a id="equal(java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equal</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;equal&#8203;(java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collationList1,
java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collationList2)</pre>
</li>
</ul>
<a id="ordinals(org.apache.calcite.rel.RelCollation)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ordinals</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;ordinals&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation)</pre>
<div class="block">Returns the indexes of the field collations in a given collation.</div>
</li>
</ul>
<a id="ordinals(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ordinals</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;java.lang.Integer&gt;&nbsp;ordinals&#8203;(java.util.List&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;fieldCollations)</pre>
<div class="block">Returns the indexes of the fields in a list of field collations.</div>
</li>
</ul>
<a id="contains(org.apache.calcite.rel.RelCollation,java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;contains&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
java.lang.Iterable&lt;java.lang.Integer&gt;&nbsp;keys)</pre>
<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>
</li>
</ul>
<a id="contains(org.apache.calcite.rel.RelCollation,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre class="methodSignature">private static&nbsp;boolean&nbsp;contains&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
java.util.List&lt;java.lang.Integer&gt;&nbsp;keys)</pre>
</li>
</ul>
<a id="contains(java.util.List,org.apache.calcite.util.ImmutableIntList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;contains&#8203;(java.util.List&lt;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;collations,
<a href="../util/ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a>&nbsp;keys)</pre>
<div class="block">Returns whether one of a list of collations indicates that the collection
is sorted on the given list of keys.</div>
</li>
</ul>
<a id="shift(org.apache.calcite.rel.RelCollation,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shift</h4>
<pre class="methodSignature">public static&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;shift&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
int&nbsp;offset)</pre>
</li>
</ul>
<a id="permute(org.apache.calcite.rel.RelCollation,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>permute</h4>
<pre class="methodSignature">public static&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;permute&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
java.util.Map&lt;java.lang.Integer,&#8203;java.lang.Integer&gt;&nbsp;mapping)</pre>
<div class="block">Creates a copy of this collation that changes the ordinals of input
fields.</div>
</li>
</ul>
<a id="permute(org.apache.calcite.rel.RelCollation,org.apache.calcite.util.mapping.Mappings.TargetMapping)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>permute</h4>
<pre class="methodSignature">public static&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;permute&#8203;(<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&nbsp;collation,
<a href="../util/mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a>&nbsp;mapping)</pre>
<div class="block">Creates a copy of this collation that changes the ordinals of input
fields.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="class-use/RelCollations.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>