| <!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:04 PDT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TupleInfo (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="TupleInfo (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/TupleInfo.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/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class 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/TupleInfo.html" target="_top">Frames</a></li> |
| <li><a href="TupleInfo.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.trafodion.sql.udr</div> |
| <h2 title="Class TupleInfo" class="title">Class TupleInfo</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><a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">org.trafodion.sql.udr.TMUDRSerializableObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.trafodion.sql.udr.TupleInfo</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/trafodion/sql/udr/ParameterListInfo.html" title="class in org.trafodion.sql.udr">ParameterListInfo</a>, <a href="../../../../org/trafodion/sql/udr/TableInfo.html" title="class in org.trafodion.sql.udr">TableInfo</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TupleInfo</span> |
| extends <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></pre> |
| <div class="block">Common base class for parameter lists and row layouts |
| |
| <p> Describes a list of scalars, which could be columns of a table |
| or a parameter list</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="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/TupleInfo.html#addCharColumn(java.lang.String,%20int,%20boolean)">addCharColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable)</code> |
| <div class="block">Add a fixed character output column with UTF8 charset and SYSTEM_COLLATION</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addCharColumn(java.lang.String,%20int,%20boolean,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLCollationCode)">addCharColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> charset, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation)</code> |
| <div class="block">Add a fixed character output column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addColumn(org.trafodion.sql.udr.ColumnInfo)">addColumn</a></strong>(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> column)</code> |
| <div class="block">Add a new column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addColumnAt(org.trafodion.sql.udr.ColumnInfo,%20int)">addColumnAt</a></strong>(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> column, |
| int position)</code> |
| <div class="block">Add a new column at a specified position.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addColumns(java.util.Vector)">addColumns</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a>> columns)</code> |
| <div class="block">Add multiple columns to the table-valued output.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addIntColumn(java.lang.String,%20boolean)">addIntColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| boolean isNullable)</code> |
| <div class="block">Add an integer output column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addLongColumn(java.lang.String,%20boolean)">addLongColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| boolean isNullable)</code> |
| <div class="block">Add a long output column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addVarCharColumn(java.lang.String,%20int,%20boolean)">addVarCharColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable)</code> |
| <div class="block">Add a VARCHAR output column with UTF8 charset and SYSTEM_COLLATION</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#addVarCharColumn(java.lang.String,%20int,%20boolean,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLCollationCode)">addVarCharColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> charset, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation)</code> |
| <div class="block">Add a VARCHAR output column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#deleteColumn(int)">deleteColumn</a></strong>(int i)</code> |
| <div class="block">Delete a column of the table-valued output.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#deleteColumn(java.lang.String)">deleteColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Delete a column with a specified column name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getBoolean(int)">getBoolean</a></strong>(int colNum)</code> |
| <div class="block">Get a boolean value of a column or parameter</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getBoolean(java.lang.String)">getBoolean</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Get a boolean value of a column or parameter identified by name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getColNum(java.lang.String)">getColNum</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Look up a column/parameter number by name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getColumn(int)">getColumn</a></strong>(int colNum)</code> |
| <div class="block">Get the column info for a column identified by its ordinal.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getColumn(java.lang.String)">getColumn</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Get the column info for a column identified by its name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDelimitedRow()">getDelimitedRow</a></strong>()</code> |
| <div class="block">Get all columns of a row as a delimited string, with '|' as field delimiter</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDelimitedRow(char,%20boolean,%20char,%20int,%20int)">getDelimitedRow</a></strong>(char delim, |
| boolean quote, |
| char quoteSymbol, |
| int firstColumn, |
| int lastColumn)</code> |
| <div class="block">Get columns of a row as a delimited string.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDouble(int)">getDouble</a></strong>(int colNum)</code> |
| <div class="block">Get a double value of a column or parameter |
| |
| This method is modeled after the JDBC interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDouble(java.lang.String)">getDouble</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Get double value of a column/parameter identified by name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getInt(int)">getInt</a></strong>(int colNum)</code> |
| <div class="block">Get an integer value of a column or parameter</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getInt(java.lang.String)">getInt</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Get an integer value for a column identified by name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getLong(int)">getLong</a></strong>(int colNum)</code> |
| <div class="block">Get a long value of a column or parameter</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getLong(java.lang.String)">getLong</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Get a long value for a column identified by name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getNumColumns()">getNumColumns</a></strong>()</code> |
| <div class="block">Get the number of columns or parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeClassCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getSQLTypeClass(int)">getSQLTypeClass</a></strong>(int colNum)</code> |
| <div class="block">Get the SQL type class.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getString(int)">getString</a></strong>(int colNum)</code> |
| <div class="block">Get a string value of a column or parameter</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getString(java.lang.String)">getString</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName)</code> |
| <div class="block">Get a string value of a column or parameter identified by name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getTime(int)">getTime</a></strong>(int colNum)</code> |
| <div class="block">Get a datetime or interval column value as time_t</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getType(int)">getType</a></strong>(int colNum)</code> |
| <div class="block">Get the type of a column.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#isAvailable(int)">isAvailable</a></strong>(int colNum)</code> |
| <div class="block">Check whether a parameter is available at compile-time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#print()">print</a></strong>()</code> |
| <div class="block">Print the object, for use in debugging.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setDouble(int,%20double)">setDouble</a></strong>(int colNum, |
| double val)</code> |
| <div class="block">Set an output column to a specified double value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setFromDelimitedRow(java.lang.String)">setFromDelimitedRow</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> row)</code> |
| <div class="block">Set the result row from a string with delimited field values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setFromDelimitedRow(java.lang.String,%20char,%20boolean,%20char,%20int,%20int,%20int)">setFromDelimitedRow</a></strong>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> row, |
| char delim, |
| boolean quote, |
| char quoteSymbol, |
| int firstColumnToSet, |
| int lastColumnToSet, |
| int numDelimColsToSkip)</code> |
| <div class="block">Set the result row from a string with delimited field values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setInt(int,%20int)">setInt</a></strong>(int colNum, |
| int val)</code> |
| <div class="block">Set an output column to a specified integer value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setLong(int,%20long)">setLong</a></strong>(int colNum, |
| long val)</code> |
| <div class="block">Set an output column to a specified long value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setNull(int)">setNull</a></strong>(int colNum)</code> |
| <div class="block">Set an output column to a NULL value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setString(int,%20java.lang.String)">setString</a></strong>(int colNum, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> val)</code> |
| <div class="block">Set an output column to a specified string value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#setTime(int,%20java.util.Date)">setTime</a></strong>(int colNum, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> val)</code> |
| <div class="block">Set a datetime or interval output column to a value specified as Date</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#wasNull()">wasNull</a></strong>()</code> |
| <div class="block">Check whether the last value returned from a getInt() etc.</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getNumColumns()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumColumns</h4> |
| <pre>public int getNumColumns()</pre> |
| <div class="block">Get the number of columns or parameters.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Number of columns/parameters.</dd></dl> |
| </li> |
| </ul> |
| <a name="getColNum(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColNum</h4> |
| <pre>public int getColNum(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Look up a column/parameter number by name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Column/parameter number.</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="getColumn(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumn</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> getColumn(int colNum) |
| 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 info for a column identified by its ordinal.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Column info.</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="getColumn(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getColumn</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> getColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| 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 info for a column identified by its name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Column info.</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="getType(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> getType(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get the type of a column.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Type of the column.</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="getSQLTypeClass(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSQLTypeClass</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeClassCode</a> getSQLTypeClass(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get the SQL type class. |
| Determine whether this is a numeric character, datetime or interval type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>SQL type class enum.</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="getInt(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>public int getInt(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get an integer value of a column or parameter |
| |
| <p> This method is modeled after the JDBC interface. |
| |
| <p> Use this method at runtime. It can also be used for |
| actual parameters that are available at compile time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Integer value. |
| If the value was a NULL value, then 0 is returned. |
| The wasNull() method can be used to determine whether |
| a NULL value was returned.</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="getInt(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInt</h4> |
| <pre>public int getInt(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get an integer value for a column identified by name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Integer value. |
| If the value was a NULL value, then 0 is returned. |
| The wasNull() method can be used to determine whether |
| a NULL value was returned.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getInt(int)"><code>const</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getLong(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre>public long getLong(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a long value of a column or parameter |
| |
| <p> This method is modeled after the JDBC interface. |
| |
| <p> Use this method at runtime. It can also be used for |
| actual parameters that are available at compile time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>long value. |
| If the value was a NULL value, then 0 is returned. |
| The wasNull() method can be used to determine whether |
| a NULL value was returned.</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="getLong(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre>public long getLong(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a long value for a column identified by name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>long value.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getLong(int)"><code>const</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getDouble(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDouble</h4> |
| <pre>public double getDouble(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a double value of a column or parameter |
| |
| This method is modeled after the JDBC interface. |
| |
| Use this method at runtime. It can also be used for |
| actual parameters that are available at compile time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>double value.</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="getDouble(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDouble</h4> |
| <pre>public double getDouble(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get double value of a column/parameter identified by name.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>double value.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDouble(int)"><code>const</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getString(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getString(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a string value of a column or parameter |
| |
| <p> This method is modeled after the JDBC interface. |
| |
| <p> Use this method at runtime. It can also be used for |
| actual parameters that are available at compile time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>String value. |
| If the value was a NULL value, an empty string |
| is returned. The wasNull() method can be used to |
| determine whether a NULL value was returned.</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="getString(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getString(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a string value of a column or parameter identified by name. |
| |
| <p> This method is modeled after the JDBC interface. |
| |
| <p> Use this method at runtime. It cannot be used for |
| actual parameters that are available at compile time, use |
| getString(int colNum) instead, since actual parameters are not named.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>String value. |
| If the value was a NULL value, an empty string |
| is returned. The wasNull() method can be used to |
| determine whether a NULL value was returned.</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="getBoolean(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre>public boolean getBoolean(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a boolean value of a column or parameter |
| |
| <p> This method is modeled after the JDBC interface. |
| It can be used on boolean, numeric and character columns. |
| Numeric columns need to have a value of 0 (false) or 1 (true), |
| character columns need to have a value of "0" (false) or "1" (true). |
| |
| <p> Use this method at runtime. It can also be used for |
| actual parameters that are available at compile time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Boolean value. |
| If the value was a NULL value, false |
| is returned. The wasNull() method can be used to |
| determine whether a NULL value was returned.</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="getBoolean(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre>public boolean getBoolean(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a boolean value of a column or parameter identified by name. |
| |
| <p> This method is modeled after the JDBC interface. |
| It can be used on boolean, numeric and character columns. |
| Numeric columns need to have a value of 0 (false) or 1 (true), |
| character columns need to have a value of "0" (false) or "1" (true). |
| |
| <p> Use this method at runtime. It cannot be used for |
| actual parameters that are available at compile time, use |
| getString(int colNum) instead, since actual parameters are not named.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of an existing column.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Boolean value. |
| If the value was a NULL value, false |
| is returned. The wasNull() method can be used to |
| determine whether a NULL value was returned.</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="getTime(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTime</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getTime(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get a datetime or interval column value as time_t |
| |
| <p> This method can be used to convert column values with |
| a datetime type or a day-second interval type to the |
| POSIX type time_t. Note that this may result in the loss |
| of fractional seconds. |
| |
| <p> Use this method at runtime. It can also be used for |
| actual parameters that are available at compile time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</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="isAvailable(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAvailable</h4> |
| <pre>public boolean isAvailable(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Check whether a parameter is available at compile-time. |
| |
| <p> Use this method to check in the compiler interfaces whether |
| an actual parameter is a constant value that can be read |
| at compile time. If this method returns true, the value |
| can be accessed with the getInt(), getString() etc. methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Column number.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the parameter value is available.</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="getDelimitedRow(char, boolean, char, int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelimitedRow</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDelimitedRow(char delim, |
| boolean quote, |
| char quoteSymbol, |
| int firstColumn, |
| int lastColumn) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get columns of a row as a delimited string. |
| |
| <p> This method is useful to interface with tools that take a delimited |
| record format. It is also useful for printing rows</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>delim</code> - US ASCII field delimiter to use.</dd><dd><code>quote</code> - Whether to quote character field values that contain |
| the delimiter symbol or a quote symbol. Quote symbols |
| will be duplicated to escape them.</dd><dd><code>quoteSymbol</code> - US ASCII quote character to use, if quote is true.</dd><dd><code>firstColumn</code> - First column to read.</dd><dd><code>lastColumn</code> - Last column to read (inclusive) or -1 to read until |
| the last column in the row.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>String String in which the result delimited row |
| will be returned.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.DebugFlags.html#TRACE_ROWS"><code><p> Only use this method at runtime. |
| |
| <p> Note: This method may return a string that contains multiple |
| character sets, if columns with different character sets |
| are involved. Using this method with UCS-2 columns is not |
| recommended.</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getDelimitedRow()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDelimitedRow</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDelimitedRow() |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get all columns of a row as a delimited string, with '|' as field delimiter |
| |
| <p> This method is useful to interface with tools that take a delimited |
| record format. It is also useful for printing rows</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>String String in which the result delimited row |
| will be returned.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.DebugFlags.html#TRACE_ROWS"><code><p> Only use this method at runtime. |
| |
| <p> Note: This method may return a string that contains multiple |
| character sets, if columns with different character sets |
| are involved. Using this method with UCS-2 columns is not |
| recommended.</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="wasNull()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wasNull</h4> |
| <pre>public boolean wasNull()</pre> |
| <div class="block">Check whether the last value returned from a getInt() etc. method was NULL. |
| |
| <p> This method is modeled after the JDBC interface.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if the last value returned from a getInt(), getString() |
| etc. method was a NULL value, false otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="setInt(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInt</h4> |
| <pre>public void setInt(int colNum, |
| int val) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set an output column to a specified integer value. |
| |
| <p> Use this method at runtime.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Index/ordinal of the column to set.</dd><dd><code>val</code> - The new integer value for the column to set.</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="setLong(int, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLong</h4> |
| <pre>public void setLong(int colNum, |
| long val) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set an output column to a specified long value. |
| |
| <p> Use this method at runtime.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Index/ordinal of the column to set.</dd><dd><code>val</code> - The new long value for the column to set.</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="setDouble(int, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDouble</h4> |
| <pre>public void setDouble(int colNum, |
| double val) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set an output column to a specified double value. |
| |
| <p> Use this method at runtime.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Index/ordinal of the column to set.</dd><dd><code>val</code> - The new double value for the column to set.</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="setString(int, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setString</h4> |
| <pre>public void setString(int colNum, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> val) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set an output column to a specified string value. |
| |
| <p> Use this method at runtime.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Index/ordinal of the column to set.</dd><dd><code>val</code> - The new string value for the column to set.</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="setTime(int, java.util.Date)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTime</h4> |
| <pre>public void setTime(int colNum, |
| <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> val) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set a datetime or interval output column to a value specified as Date |
| |
| <p> This method cannot be used with year-month intervals or data types that |
| are not datetime or interval types. It is not possible to set fractional |
| seconds with this method. |
| |
| <p> Use this method at runtime.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Index/ordinal of the column to set.</dd><dd><code>val</code> - The new Date value for the column to set.</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="setFromDelimitedRow(java.lang.String, char, boolean, char, int, int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFromDelimitedRow</h4> |
| <pre>public int setFromDelimitedRow(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> row, |
| char delim, |
| boolean quote, |
| char quoteSymbol, |
| int firstColumnToSet, |
| int lastColumnToSet, |
| int numDelimColsToSkip) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set the result row from a string with delimited field values. |
| |
| <p> This method can be used to read delimited text files and |
| conveniently produce a result table from them. For example, |
| if the following string is passed in as row:</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - A string with delimited field values to read.</dd><dd><code>delim</code> - Delimiter between field values. Use a US ASCII symbol |
| as the delimiter.</dd><dd><code>quote</code> - true if the method should assume that text fields |
| use quotes to quote special symbols like delimiters |
| that are embedded within fields, and that quote symbols |
| embedded in text fields will be doubled.</dd><dd><code>quoteSymbol</code> - US ASCII Quote symbol used to quote text. Meaningful |
| only if quote is set to true.</dd><dd><code>firstColumnToSet</code> - First column in the output table to be set |
| from the delimited row (0-based).</dd><dd><code>lastColumnToSet</code> - Last column in the output table to be set |
| (inclusive) or -1 to indicate to set all |
| remaining columns of the table.</dd><dd><code>numDelimColsToSkip</code> - Number of fields to skip in the delimited |
| row before using the values to set output |
| columns.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Number of character read from row. Can be used |
| to process text that is not yet consumed.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDelimitedRow(char,%20boolean,%20char,%20int,%20int)"><code>getDelimitedRow(char,boolean,char,int,int)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setFromDelimitedRow(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFromDelimitedRow</h4> |
| <pre>public int setFromDelimitedRow(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> row) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set the result row from a string with delimited field values. |
| |
| <p> Calls other version of setFromDelimitedRow with these arguments</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - A string with delimited field values to read.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Number of character read from row. Can be used |
| to process text that is not yet consumed.</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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TupleInfo.html#getDelimitedRow()"><code>getDelimitedRow( )</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setNull(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNull</h4> |
| <pre>public void setNull(int colNum) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Set an output column to a NULL value. |
| |
| <p> Use this method at runtime.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colNum</code> - Index/ordinal of the column to set to NULL.</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="addColumn(org.trafodion.sql.udr.ColumnInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumn</h4> |
| <pre>public void addColumn(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> column)</pre> |
| <div class="block">Add a new column. |
| |
| Only use this method from within the following method: |
| <ul> |
| <li> UDR::describeParamsAndColumns() |
| </ul></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Info of the new column to add.</dd></dl> |
| </li> |
| </ul> |
| <a name="addIntColumn(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addIntColumn</h4> |
| <pre>public void addIntColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| boolean isNullable) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add an integer output column. |
| |
| <p> The new column is added at the end. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column to add. Use UPPER CASE letters, |
| digits and underscore, otherwise you will need to |
| use delimited column names with matching case in |
| Trafodion.</dd><dd><code>isNullable</code> - true if the added column should be nullable, |
| false if the added column should have the NOT NULL |
| constraint.</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="addLongColumn(java.lang.String, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLongColumn</h4> |
| <pre>public void addLongColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| boolean isNullable) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add a long output column. |
| |
| <p> The new column is added at the end. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column to add. Use UPPER CASE letters, |
| digits and underscore, otherwise you will need to |
| use delimited column names with matching case in |
| Trafodion.</dd><dd><code>isNullable</code> - true if the added column should be nullable, |
| false if the added column should have the NOT NULL |
| constraint.</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="addCharColumn(java.lang.String, int, boolean, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode, org.trafodion.sql.udr.TypeInfo.SQLCollationCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCharColumn</h4> |
| <pre>public void addCharColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> charset, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add a fixed character output column. |
| |
| <p> The new column is added at the end. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column to add. Use UPPER CASE letters, |
| digits and underscore, otherwise you will need to |
| use delimited column names with matching case in |
| Trafodion.</dd><dd><code>length</code> - Length of the new character column. |
| For single-byte and variable byte character sets, |
| the length is specified in bytes. For UTF-8, this |
| is equivalent to CHAR(length BYTES) in SQL. For UCS2, |
| the length is in UCS2 16-bit characters.</dd><dd><code>isNullable</code> - true if the added column should be nullable, |
| false if the added column should have the NOT NULL |
| constraint.</dd><dd><code>charset</code> - Character set of the new column.</dd><dd><code>collation</code> - Collation of the new column.</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="addCharColumn(java.lang.String, int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addCharColumn</h4> |
| <pre>public void addCharColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add a fixed character output column with UTF8 charset and SYSTEM_COLLATION |
| |
| <p> The new column is added at the end. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column to add. Use UPPER CASE letters, |
| digits and underscore, otherwise you will need to |
| use delimited column names with matching case in |
| Trafodion.</dd><dd><code>length</code> - Length of the new character column. |
| For single-byte and variable byte character sets, |
| the length is specified in bytes. For UTF-8, this |
| is equivalent to CHAR(length BYTES) in SQL. For UCS2, |
| the length is in UCS2 16-bit characters.</dd><dd><code>isNullable</code> - true if the added column should be nullable, |
| false if the added column should have the NOT NULL |
| constraint.</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="addVarCharColumn(java.lang.String, int, boolean, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode, org.trafodion.sql.udr.TypeInfo.SQLCollationCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addVarCharColumn</h4> |
| <pre>public void addVarCharColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> charset, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add a VARCHAR output column. |
| |
| <p> The new column is added at the end. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column to add. Use UPPER CASE letters, |
| digits and underscore, otherwise you will need to |
| use delimited column names with matching case in |
| Trafodion.</dd><dd><code>length</code> - Length of the new character column. |
| For single-byte and variable byte character sets, |
| the length is specified in bytes. For UTF-8, this |
| is equivalent to CHAR(length BYTES) in SQL. For UCS2, |
| the length is in UCS2 16-bit characters.</dd><dd><code>isNullable</code> - true if the added column should be nullable, |
| false if the added column should have the NOT NULL |
| constraint.</dd><dd><code>charset</code> - Character set of the new column.</dd><dd><code>collation</code> - Collation of the new column.</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="addVarCharColumn(java.lang.String, int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addVarCharColumn</h4> |
| <pre>public void addVarCharColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> colName, |
| int length, |
| boolean isNullable) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Add a VARCHAR output column with UTF8 charset and SYSTEM_COLLATION |
| |
| <p> The new column is added at the end. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - Name of the column to add. Use UPPER CASE letters, |
| digits and underscore, otherwise you will need to |
| use delimited column names with matching case in |
| Trafodion.</dd><dd><code>length</code> - Length of the new character column. |
| For single-byte and variable byte character sets, |
| the length is specified in bytes. For UTF-8, this |
| is equivalent to CHAR(length BYTES) in SQL. For UCS2, |
| the length is in UCS2 16-bit characters.</dd><dd><code>isNullable</code> - true if the added column should be nullable, |
| false if the added column should have the NOT NULL |
| constraint.</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="addColumns(java.util.Vector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumns</h4> |
| <pre>public void addColumns(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a><<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a>> columns)</pre> |
| <div class="block">Add multiple columns to the table-valued output. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>columns</code> - Vector of ColumnInfo objects describing the columns to add.</dd></dl> |
| </li> |
| </ul> |
| <a name="addColumnAt(org.trafodion.sql.udr.ColumnInfo, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addColumnAt</h4> |
| <pre>public void addColumnAt(<a href="../../../../org/trafodion/sql/udr/ColumnInfo.html" title="class in org.trafodion.sql.udr">ColumnInfo</a> column, |
| int position)</pre> |
| <div class="block">Add a new column at a specified position. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - ColumnInfo object describing the new column.</dd><dd><code>position</code> - Position/ordinal number of the new column. |
| All existing columns with ordinal numbers |
| greater or equal to position will be shifted by one.</dd></dl> |
| </li> |
| </ul> |
| <a name="deleteColumn(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteColumn</h4> |
| <pre>public void deleteColumn(int i) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Delete a column of the table-valued output. |
| |
| <p> Only use this method from within the |
| UDR#describeParamsAndColumns() method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Position/ordinal (0-based) of column to be deleted.</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="deleteColumn(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteColumn</h4> |
| <pre>public void deleteColumn(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Delete a column with a specified column name. |
| |
| <p> The first column that matches the specified column name |
| will be deleted.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the column to be deleted.</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="print()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>print</h4> |
| <pre>public void print() |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Print the object, for use in debugging.</div> |
| <dl><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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/UDR.html#debugLoop()"><code>UDR.debugLoop()</code></a>, |
| <a href="../../../../org/trafodion/sql/udr/UDRInvocationInfo.DebugFlags.html#PRINT_INVOCATION_INFO_AT_RUN_TIME"><code>UDRInvocationInfo.DebugFlags.PRINT_INVOCATION_INFO_AT_RUN_TIME</code></a></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/TupleInfo.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/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class 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/TupleInfo.html" target="_top">Frames</a></li> |
| <li><a href="TupleInfo.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p> |
| </body> |
| </html> |
