| <!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 (1.7.0_251) on Sat May 02 18:54:03 PDT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>OrderInfo (trafodion-sql 2.4.0 API)</title> |
| <meta name="date" content="2020-05-02"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OrderInfo (trafodion-sql 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/OrderInfo.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"> |
| <li><a href="../../../../org/trafodion/sql/udr/LmUtility.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/trafodion/sql/udr/OrderInfo.html" target="_top">Frames</a></li> |
| <li><a href="OrderInfo.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.trafodion.sql.udr</div> |
| <h2 title="Class OrderInfo" class="title">Class OrderInfo</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.trafodion.sql.udr.OrderInfo</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">OrderInfo</span> |
| extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Ordering of a table by some ascending or descending columns |
| |
| <p> A list of columns, represented by column numbers, with an |
| ascending/descending indicator for each column.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a></strong></code> |
| <div class="block">Ascending/descending order of columns</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#OrderInfo()">OrderInfo</a></strong>()</code> |
| <div class="block">Default constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#OrderInfo(org.trafodion.sql.udr.OrderInfo)">OrderInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/OrderInfo.html" title="class in org.trafodion.sql.udr">OrderInfo</a> o)</code> |
| <div class="block">Copy constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#addEntry(int)">addEntry</a></strong>(int colNum)</code> |
| <div class="block">Append an entry to the ordering with ASCENDING orderType.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#addEntry(int,%20org.trafodion.sql.udr.OrderInfo.OrderTypeCode)">addEntry</a></strong>(int colNum, |
| <a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a> orderType)</code> |
| <div class="block">Append an entry to the ordering.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#addEntryAt(int,%20int)">addEntryAt</a></strong>(int pos, |
| int colNum)</code> |
| <div class="block">Insert an entry at any position of the ordering with orderType ASCENDING.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#addEntryAt(int,%20int,%20org.trafodion.sql.udr.OrderInfo.OrderTypeCode)">addEntryAt</a></strong>(int pos, |
| int colNum, |
| <a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a> orderType)</code> |
| <div class="block">Insert an entry at any position of the ordering.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#getColumnNum(int)">getColumnNum</a></strong>(int i)</code> |
| <div class="block">Get the column number of an entry of the ordering.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#getNumEntries()">getNumEntries</a></strong>()</code> |
| <div class="block">Get the number of entries (columns) in the ordering.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/OrderInfo.html#getOrderType(int)">getOrderType</a></strong>(int i)</code> |
| <div class="block">Get the order type of an entry of the ordering.</div> |
| </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.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="OrderInfo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OrderInfo</h4> |
| <pre>public OrderInfo()</pre> |
| <div class="block">Default constructor.</div> |
| </li> |
| </ul> |
| <a name="OrderInfo(org.trafodion.sql.udr.OrderInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OrderInfo</h4> |
| <pre>public OrderInfo(<a href="../../../../org/trafodion/sql/udr/OrderInfo.html" title="class in org.trafodion.sql.udr">OrderInfo</a> o)</pre> |
| <div class="block">Copy constructor.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getNumEntries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumEntries</h4> |
| <pre>public int getNumEntries()</pre> |
| <div class="block">Get the number of entries (columns) in the ordering.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Number of entries/columns that make up the ordering.</dd></dl> |
| </li> |
| </ul> |
| <a name="getColumnNum(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumnNum</h4> |
| <pre>public int getColumnNum(int i) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get the column number of an entry of the ordering.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - the position (0-based) of the ordering, 0 meaning the leading position.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The column number of the n-th entry of the ordering (both are 0-based).</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getOrderType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrderType</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a> getOrderType(int i) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get the order type of an entry of the ordering.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - the position (0-based) of the ordering, 0 meaning the leading position.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>The order type of the n-th entry of the ordering (0-based).</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="addEntry(int, org.trafodion.sql.udr.OrderInfo.OrderTypeCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEntry</h4> |
| <pre>public void addEntry(int colNum, |
| <a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a> orderType)</pre> |
| <div class="block">Append an entry to the ordering.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number to append to the ordering.</dd><dd><code>orderType</code> - Order type (ascending or descending) to use.</dd></dl> |
| </li> |
| </ul> |
| <a name="addEntry(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEntry</h4> |
| <pre>public void addEntry(int colNum)</pre> |
| <div class="block">Append an entry to the ordering with ASCENDING orderType.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number to append to the ordering.</dd></dl> |
| </li> |
| </ul> |
| <a name="addEntryAt(int, int, org.trafodion.sql.udr.OrderInfo.OrderTypeCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEntryAt</h4> |
| <pre>public void addEntryAt(int pos, |
| int colNum, |
| <a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr">OrderInfo.OrderTypeCode</a> orderType) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Insert an entry at any position of the ordering. |
| |
| <p> A quick example to illustrate this: Let's say we have a table |
| with columns (a,b,c). Their column numbers are 0, 1, and 2. |
| We produce an ordering (C ASCENDING):</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - Position (0-based) at which we want to insert. The new |
| entry will be position "pos" after the insertion, any |
| existing entries will be moved up.</dd><dd><code>colNum</code> - Number of the column by which we want to order</dd><dd><code>orderType</code> - Order type (ascending or descending) to use</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="addEntryAt(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addEntryAt</h4> |
| <pre>public void addEntryAt(int pos, |
| int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Insert an entry at any position of the ordering with orderType ASCENDING. |
| |
| <p> A quick example to illustrate this: Let's say we have a table |
| with columns (a,b,c). Their column numbers are 0, 1, and 2. |
| We produce an ordering (C ASCENDING):</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - Position (0-based) at which we want to insert. The new |
| entry will be position "pos" after the insertion, any |
| existing entries will be moved up.</dd><dd><code>colNum</code> - Number of the column by which we want to order</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/OrderInfo.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"> |
| <li><a href="../../../../org/trafodion/sql/udr/LmUtility.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/OrderInfo.OrderTypeCode.html" title="enum in org.trafodion.sql.udr"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/trafodion/sql/udr/OrderInfo.html" target="_top">Frames</a></li> |
| <li><a href="OrderInfo.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><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p> |
| </body> |
| </html> |
