Google Git
Sign in
apache / calcite-site / ea7bd59de63e44ef822bd3c62faa848069cf4d92 / . / apidocs / org / apache / calcite / rel / RelCollationImpl.html
blob: e7493f4d0fb70f2d2130825ed65cc0dced5ac812 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelCollationImpl (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="RelCollationImpl (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":41,"i2":41,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":41,"i9":41,"i10":41,"i11":41,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/RelCollationImpl.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 RelCollationImpl" class="title">Class RelCollationImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.rel.RelCollationImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Comparable&lt;<a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a>&gt;</code>, <code><a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a></code>, <code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code>, <code><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RelCollationImpl</span>
extends java.lang.Object
implements <a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></pre>
<div class="block">Simple implementation of <a href="RelCollation.html" title="interface in org.apache.calcite.rel"><code>RelCollation</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"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private com.google.common.collect.ImmutableList&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fieldCollations">fieldCollations</a></span></code></th>
<td class="colLast">&nbsp;</td>
</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="#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>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.google.common.collect.ImmutableList)">RelCollationImpl</a></span>&#8203;(com.google.common.collect.ImmutableList&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>
</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(org.apache.calcite.plan.RelMultipleTrait)">compareTo</a></span>&#8203;(<a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a>&nbsp;o)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" 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"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i2" 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">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldCollations()">getFieldCollations</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the ordinals and directions of the columns in this ordering.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTraitDef()">getTraitDef</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the RelTraitDef that defines this RelTrait.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTop()">isTop</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this trait is satisfied by every instance of the trait
(including itself).</div>
</td>
</tr>
<tr id="i8" class="altColor">
<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"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i9" 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">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i10" 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">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i11" 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(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"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(org.apache.calcite.plan.RelOptPlanner)">register</a></span>&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block">Registers a trait instance with the planner.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a></span>&#8203;(<a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;trait)</code></th>
<td class="colLast">
<div class="block">Returns whether this trait satisfies a given trait.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a string representation of this collation, suitably terse given
that it will appear in plan traces.</div>
</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, finalize, getClass, notify, notifyAll, 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>@Deprecated
public static final&nbsp;<a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a> EMPTY</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="PRESERVE">
<!-- -->
</a>
<ul class="blockList">
<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>
</li>
</ul>
<a id="fieldCollations">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fieldCollations</h4>
<pre>private final&nbsp;com.google.common.collect.ImmutableList&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt; fieldCollations</pre>
</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;(com.google.common.collect.ImmutableList)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RelCollationImpl</h4>
<pre>protected&nbsp;RelCollationImpl&#8203;(com.google.common.collect.ImmutableList&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;fieldCollations)</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">@Deprecated
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>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="of(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre class="methodSignature">@Deprecated
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>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="getTraitDef()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTraitDef</h4>
<pre class="methodSignature">public&nbsp;<a href="../plan/RelTraitDef.html" title="class in org.apache.calcite.plan">RelTraitDef</a>&nbsp;getTraitDef()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelTrait.html#getTraitDef()">RelTrait</a></code></span></div>
<div class="block">Returns the RelTraitDef that defines this RelTrait.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelTrait.html#getTraitDef()">getTraitDef</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the RelTraitDef that defines this RelTrait</dd>
</dl>
</li>
</ul>
<a id="getFieldCollations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFieldCollations</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="RelFieldCollation.html" title="class in org.apache.calcite.rel">RelFieldCollation</a>&gt;&nbsp;getFieldCollations()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelCollation.html#getFieldCollations()">RelCollation</a></code></span></div>
<div class="block">Returns the ordinals and directions of the columns in this ordering.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelCollation.html#getFieldCollations()">getFieldCollations</a></code>&nbsp;in interface&nbsp;<code><a href="RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a></code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelTrait.html#hashCode()">RelTrait</a></code></span></div>
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelTrait.html#hashCode()">hashCode</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;obj)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelTrait.html#equals(java.lang.Object)">RelTrait</a></code></span></div>
<div class="block">See <a href="#EqualsHashCodeNote">note about equals() and hashCode()</a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelTrait.html#equals(java.lang.Object)">equals</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="isTop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTop</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isTop()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelMultipleTrait.html#isTop()">RelMultipleTrait</a></code></span></div>
<div class="block">Returns whether this trait is satisfied by every instance of the trait
(including itself).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelMultipleTrait.html#isTop()">isTop</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a></code></dd>
</dl>
</li>
</ul>
<a id="compareTo(org.apache.calcite.plan.RelMultipleTrait)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;compareTo&#8203;(@Nonnull
<a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a>&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="../plan/RelMultipleTrait.html" title="interface in org.apache.calcite.plan">RelMultipleTrait</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="register(org.apache.calcite.plan.RelOptPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;register&#8203;(<a href="../plan/RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">RelTrait</a></code></span></div>
<div class="block">Registers a trait instance with the planner.
<p>This is an opportunity to add rules that relate to that trait. However,
typical implementations will do nothing.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelTrait.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planner</code> - Planner</dd>
</dl>
</li>
</ul>
<a id="satisfies(org.apache.calcite.plan.RelTrait)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>satisfies</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;satisfies&#8203;(<a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;trait)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../plan/RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">RelTrait</a></code></span></div>
<div class="block">Returns whether this trait satisfies a given trait.
<p>A trait satisfies another if it is the same or stricter. For example,
<code>ORDER BY x, y</code> satisfies <code>ORDER BY x</code>.
<p>A trait's <code>satisfies</code> relation must be a partial order (reflexive,
anti-symmetric, transitive). Many traits cannot be "loosened"; their
<code>satisfies</code> is an equivalence relation, where only X satisfies X.
<p>If a trait has multiple values
(see <a href="../plan/RelCompositeTrait.html" title="class in org.apache.calcite.plan"><code>RelCompositeTrait</code></a>)
a collection (T0, T1, ...) satisfies T if any Ti satisfies T.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelTrait.html#satisfies(org.apache.calcite.plan.RelTrait)">satisfies</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trait</code> - Given trait</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether this trait subsumes a given trait</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns a string representation of this collation, suitably terse given
that it will appear in plan traces. Examples:
"[]", "[2]", "[0 DESC, 1]", "[0 DESC, 1 ASC NULLS LAST]".</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../plan/RelTrait.html#toString()">toString</a></code>&nbsp;in interface&nbsp;<code><a href="../plan/RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="createSingleton(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSingleton</h4>
<pre class="methodSignature">@Deprecated
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="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></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">@Deprecated
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="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="equal(java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equal</h4>
<pre class="methodSignature">@Deprecated
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>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="ordinals(org.apache.calcite.rel.RelCollation)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ordinals</h4>
<pre class="methodSignature">@Deprecated
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="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></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/RelCollationImpl.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>