| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SortOrder.Builder</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SortOrder.Builder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.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"> |
| <li><a href="../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/SortOrder.Builder.html" target="_top">Frames</a></li> |
| <li><a href="SortOrder.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg</div> |
| <h2 title="Class SortOrder.Builder" class="title">Class SortOrder.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.SortOrder.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg">SortOrderBuilder</a><<a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a>></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg">SortOrder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">SortOrder.Builder</span> |
| extends java.lang.Object |
| implements <a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg">SortOrderBuilder</a><<a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a>></pre> |
| <div class="block">A builder used to create valid <a href="../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg"><code>sort orders</code></a>. |
| <p> |
| Call <a href="../../../org/apache/iceberg/SortOrder.html#builderFor-org.apache.iceberg.Schema-"><code>SortOrder.builderFor(Schema)</code></a> to create a new builder.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#asc-org.apache.iceberg.expressions.Term-org.apache.iceberg.NullOrder-">asc</a></span>(<a href="../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</code> |
| <div class="block">Add an expression term to the sort, ascending with the given null order.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg">SortOrder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#build--">build</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#caseSensitive-boolean-">caseSensitive</a></span>(boolean sortCaseSensitive)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#desc-org.apache.iceberg.expressions.Term-org.apache.iceberg.NullOrder-">desc</a></span>(<a href="../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</code> |
| <div class="block">Add an expression term to the sort, ascending with the given null order.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#sortBy-java.lang.String-org.apache.iceberg.SortDirection-org.apache.iceberg.NullOrder-">sortBy</a></span>(java.lang.String name, |
| <a href="../../../org/apache/iceberg/SortDirection.html" title="enum in org.apache.iceberg">SortDirection</a> direction, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#sortBy-org.apache.iceberg.expressions.Term-org.apache.iceberg.SortDirection-org.apache.iceberg.NullOrder-">sortBy</a></span>(<a href="../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term, |
| <a href="../../../org/apache/iceberg/SortDirection.html" title="enum in org.apache.iceberg">SortDirection</a> direction, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/SortOrder.Builder.html#withOrderId-int-">withOrderId</a></span>(int newOrderId)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.SortOrderBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg">SortOrderBuilder</a></h3> |
| <code><a href="../../../org/apache/iceberg/SortOrderBuilder.html#asc-java.lang.String-">asc</a>, <a href="../../../org/apache/iceberg/SortOrderBuilder.html#asc-java.lang.String-org.apache.iceberg.NullOrder-">asc</a>, <a href="../../../org/apache/iceberg/SortOrderBuilder.html#asc-org.apache.iceberg.expressions.Term-">asc</a>, <a href="../../../org/apache/iceberg/SortOrderBuilder.html#desc-java.lang.String-">desc</a>, <a href="../../../org/apache/iceberg/SortOrderBuilder.html#desc-java.lang.String-org.apache.iceberg.NullOrder-">desc</a>, <a href="../../../org/apache/iceberg/SortOrderBuilder.html#desc-org.apache.iceberg.expressions.Term-">desc</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="asc-org.apache.iceberg.expressions.Term-org.apache.iceberg.NullOrder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>asc</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a> asc(<a href="../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</pre> |
| <div class="block">Add an expression term to the sort, ascending with the given null order.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/SortOrderBuilder.html#asc-org.apache.iceberg.expressions.Term-org.apache.iceberg.NullOrder-">asc</a></code> in interface <code><a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg">SortOrderBuilder</a><<a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>term</code> - an expression term</dd> |
| <dd><code>nullOrder</code> - a null order (first or last)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="desc-org.apache.iceberg.expressions.Term-org.apache.iceberg.NullOrder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>desc</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a> desc(<a href="../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</pre> |
| <div class="block">Add an expression term to the sort, ascending with the given null order.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/SortOrderBuilder.html#desc-org.apache.iceberg.expressions.Term-org.apache.iceberg.NullOrder-">desc</a></code> in interface <code><a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg">SortOrderBuilder</a><<a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>term</code> - an expression term</dd> |
| <dd><code>nullOrder</code> - a null order (first or last)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this for method chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sortBy-java.lang.String-org.apache.iceberg.SortDirection-org.apache.iceberg.NullOrder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sortBy</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a> sortBy(java.lang.String name, |
| <a href="../../../org/apache/iceberg/SortDirection.html" title="enum in org.apache.iceberg">SortDirection</a> direction, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</pre> |
| </li> |
| </ul> |
| <a name="sortBy-org.apache.iceberg.expressions.Term-org.apache.iceberg.SortDirection-org.apache.iceberg.NullOrder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sortBy</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a> sortBy(<a href="../../../org/apache/iceberg/expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a> term, |
| <a href="../../../org/apache/iceberg/SortDirection.html" title="enum in org.apache.iceberg">SortDirection</a> direction, |
| <a href="../../../org/apache/iceberg/NullOrder.html" title="enum in org.apache.iceberg">NullOrder</a> nullOrder)</pre> |
| </li> |
| </ul> |
| <a name="withOrderId-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withOrderId</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a> withOrderId(int newOrderId)</pre> |
| </li> |
| </ul> |
| <a name="caseSensitive-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>caseSensitive</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.Builder.html" title="class in org.apache.iceberg">SortOrder.Builder</a> caseSensitive(boolean sortCaseSensitive)</pre> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg">SortOrder</a> build()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.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"> |
| <li><a href="../../../org/apache/iceberg/SortOrder.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/SortOrderBuilder.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/SortOrder.Builder.html" target="_top">Frames</a></li> |
| <li><a href="SortOrder.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |