blob: c6b47f978f4502f078389ad39981be2acf4eae75 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SortOrder</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.5.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="SortOrder";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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="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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.iceberg</a></div>
<h2 title="Class SortOrder" class="title">Class SortOrder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.SortOrder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">SortOrder</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A sort order that defines how data and delete files should be ordered in a table.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#org.apache.iceberg.SortOrder">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></span></code></th>
<td class="colLast">
<div class="block">A builder used to create valid <a href="SortOrder.html" title="class in org.apache.iceberg"><code>sort orders</code></a>.</div>
</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></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 <a href="SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#builderFor(org.apache.iceberg.Schema)">builderFor</a></span>&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="SortOrder.Builder.html" title="class in org.apache.iceberg"><code>sort order builder</code></a> for the given <a href="Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkCompatibility(org.apache.iceberg.SortOrder,org.apache.iceberg.Schema)">checkCompatibility</a></span>&#8203;(<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;sortOrder,
<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<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;other)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="SortField.html" title="class in org.apache.iceberg">SortField</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fields()">fields</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the list of <a href="SortField.html" title="class in org.apache.iceberg"><code>sort fields</code></a> for this sort order</div>
</td>
</tr>
<tr id="i4" 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">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSorted()">isSorted</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the sort order is sorted</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUnsorted()">isUnsorted</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the sort order is unsorted</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#orderId()">orderId</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the ID of this sort order</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sameOrder(org.apache.iceberg.SortOrder)">sameOrder</a></span>&#8203;(<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;anotherSortOrder)</code></th>
<td class="colLast">
<div class="block">Checks whether this order is equivalent to another order while ignoring the order id.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#satisfies(org.apache.iceberg.SortOrder)">satisfies</a></span>&#8203;(<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;anotherSortOrder)</code></th>
<td class="colLast">
<div class="block">Checks whether this order satisfies another order.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="Schema.html" title="class in org.apache.iceberg">Schema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#schema()">schema</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the <a href="Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> for this sort order</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="UnboundSortOrder.html" title="class in org.apache.iceberg">UnboundSortOrder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toUnbound()">toUnbound</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unsorted()">unsorted</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a sort order for unsorted tables.</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">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="schema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre class="methodSignature">public&nbsp;<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema()</pre>
<div class="block">Returns the <a href="Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a> for this sort order</div>
</li>
</ul>
<a id="orderId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>orderId</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;orderId()</pre>
<div class="block">Returns the ID of this sort order</div>
</li>
</ul>
<a id="fields()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fields</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="SortField.html" title="class in org.apache.iceberg">SortField</a>&gt;&nbsp;fields()</pre>
<div class="block">Returns the list of <a href="SortField.html" title="class in org.apache.iceberg"><code>sort fields</code></a> for this sort order</div>
</li>
</ul>
<a id="isSorted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSorted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isSorted()</pre>
<div class="block">Returns true if the sort order is sorted</div>
</li>
</ul>
<a id="isUnsorted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUnsorted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isUnsorted()</pre>
<div class="block">Returns true if the sort order is unsorted</div>
</li>
</ul>
<a id="satisfies(org.apache.iceberg.SortOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>satisfies</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;satisfies&#8203;(<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;anotherSortOrder)</pre>
<div class="block">Checks whether this order satisfies another order.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>anotherSortOrder</code> - a different sort order</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this order satisfies the given order</dd>
</dl>
</li>
</ul>
<a id="sameOrder(org.apache.iceberg.SortOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sameOrder</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;sameOrder&#8203;(<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;anotherSortOrder)</pre>
<div class="block">Checks whether this order is equivalent to another order while ignoring the order id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>anotherSortOrder</code> - a different sort order</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this order is equivalent to the given order</dd>
</dl>
</li>
</ul>
<a id="toUnbound()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toUnbound</h4>
<pre class="methodSignature">public&nbsp;<a href="UnboundSortOrder.html" title="class in org.apache.iceberg">UnboundSortOrder</a>&nbsp;toUnbound()</pre>
</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>
<dl>
<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="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;other)</pre>
<dl>
<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="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<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="unsorted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsorted</h4>
<pre class="methodSignature">public static&nbsp;<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;unsorted()</pre>
<div class="block">Returns a sort order for unsorted tables.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an unsorted order</dd>
</dl>
</li>
</ul>
<a id="builderFor(org.apache.iceberg.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>builderFor</h4>
<pre class="methodSignature">public static&nbsp;<a href="SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a>&nbsp;builderFor&#8203;(<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</pre>
<div class="block">Creates a new <a href="SortOrder.Builder.html" title="class in org.apache.iceberg"><code>sort order builder</code></a> for the given <a href="Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - a schema</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a sort order builder for the given schema</dd>
</dl>
</li>
</ul>
<a id="checkCompatibility(org.apache.iceberg.SortOrder,org.apache.iceberg.Schema)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>checkCompatibility</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;checkCompatibility&#8203;(<a href="SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;sortOrder,
<a href="Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</pre>
</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="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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>
</footer>
</body>
</html>