| <!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>TypeInfo (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="TypeInfo (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/TypeInfo.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/TupleInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.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/TypeInfo.html" target="_top">Frames</a></li> |
| <li><a href="TypeInfo.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 TypeInfo" class="title">Class TypeInfo</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.TypeInfo</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">TypeInfo</span> |
| extends <a href="../../../../org/trafodion/sql/udr/TMUDRSerializableObject.html" title="class in org.trafodion.sql.udr">TMUDRSerializableObject</a></pre> |
| <div class="block">Data types in the UDR interface |
| |
| <p> Describes an SQL data type and the corresponding C/C++ type, |
| used for scalar parameters, columns of input rows and |
| columns of result rows.</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/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a></strong></code> |
| <div class="block">Character sets</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a></strong></code> |
| <div class="block">Collations</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a></strong></code> |
| <div class="block">Start and end fields of interval columns</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeClassCode</a></strong></code> |
| <div class="block">Classes of types defined in the SQL standard</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a></strong></code> |
| <div class="block">SQL data types</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeSubClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeSubClassCode</a></strong></code> |
| <div class="block">More detailed type information, but not as detailed as the actual type</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/TypeInfo.html#TypeInfo()">TypeInfo</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/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType)</code> |
| <div class="block">Constructor with type</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20boolean,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLIntervalCode,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCollationCode,%20int)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode, |
| int precision, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation, |
| int length)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length)</code> |
| <div class="block">Constructor with type, and length</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int,%20boolean)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable)</code> |
| <div class="block">Constructor with type, length, and nullable</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int,%20boolean,%20int)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale)</code> |
| <div class="block">Constructor with type, length, nullable and scale</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int,%20boolean,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> charset)</code> |
| <div class="block">Constructor with type, length, nullable, scale and charset</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int,%20boolean,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLIntervalCode)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode)</code> |
| <div class="block">Constructor with all parameters except precision and collation</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int,%20boolean,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLIntervalCode,%20int)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode, |
| int precision)</code> |
| <div class="block">Constructor with all parameters except collation</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode,%20int,%20boolean,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCharsetCode,%20org.trafodion.sql.udr.TypeInfo.SQLIntervalCode,%20int,%20org.trafodion.sql.udr.TypeInfo.SQLCollationCode)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode, |
| int precision, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation)</code> |
| <div class="block">Constructor with arguments</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#TypeInfo(org.trafodion.sql.udr.TypeInfo)">TypeInfo</a></strong>(<a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> type)</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>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getByteLength()">getByteLength</a></strong>()</code> |
| <div class="block">Get the length of a value of the type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getCharset()">getCharset</a></strong>()</code> |
| <div class="block">Get the character set of the data type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getCollation()">getCollation</a></strong>()</code> |
| <div class="block">Get the collation for char/varchar data types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getFlags()">getFlags</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getIntervalCode()">getIntervalCode</a></strong>()</code> |
| <div class="block">Get the interval code for start/end fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getIsNullable()">getIsNullable</a></strong>()</code> |
| <div class="block">Get whether the type is nullable.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getMaxCharLength()">getMaxCharLength</a></strong>()</code> |
| <div class="block">Get the maximum number of characters that can be stored in this type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getPrecision()">getPrecision</a></strong>()</code> |
| <div class="block">Get the precision (max.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getScale()">getScale</a></strong>()</code> |
| <div class="block">Get the scale of the data type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getSQLType()">getSQLType</a></strong>()</code> |
| <div class="block">Get the SQL type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/TypeInfo.html#getSQLTypeClass()">getSQLTypeClass</a></strong>()</code> |
| <div class="block">Get the SQL type class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeSubClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeSubClassCode</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getSQLTypeSubClass()">getSQLTypeSubClass</a></strong>()</code> |
| <div class="block">Get the SQL type subclass.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#setNullable(boolean)">setNullable</a></strong>(boolean nullable)</code> |
| <div class="block">Set the nullable attribute of a type |
| |
| Use this method to set types created locally in the UDF |
| to be nullable or not nullable.</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="TypeInfo(org.trafodion.sql.udr.TypeInfo)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.html" title="class in org.trafodion.sql.udr">TypeInfo</a> type)</pre> |
| <div class="block">Copy constructor</div> |
| </li> |
| </ul> |
| <a name="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int, boolean, int, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode, org.trafodion.sql.udr.TypeInfo.SQLIntervalCode, int, org.trafodion.sql.udr.TypeInfo.SQLCollationCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode, |
| int precision, |
| <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">Constructor with arguments |
| |
| <p> Construct a TypeInfo object from an SQL type, with several |
| arguments (including the SQL type). This is mostly used to create |
| formal parameters or output columns in the compiler interface, if |
| a more complex data type is required that is not covered by the |
| TupleInfo.addXXXColumn() methods.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</dd><dd><code>nullable</code> - Determines the NULL / NOT NULL attribute of the type |
| false means NOT NULL</dd><dd><code>scale</code> - Scale for numeric type, fraction precision for |
| fractional seconds, not needed for other types.</dd><dd><code>charset</code> - Character set enum for CHAR/VARCHAR types, not needed |
| for other types.</dd><dd><code>intervalCode</code> - Interval code enum for intervals, not needed otherwise.</dd><dd><code>precision</code> - Precision for numeric types and leading precision for |
| interval data types.</dd><dd><code>collation</code> - Collation enum for CHAR/VARCHAR types, not needed for |
| other types. Note that only one type of collation is |
| currently supported.</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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int, boolean, int, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode, org.trafodion.sql.udr.TypeInfo.SQLIntervalCode, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode, |
| int precision) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with all parameters except collation</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</dd><dd><code>nullable</code> - Determines the NULL / NOT NULL attribute of the type |
| false means NOT NULL</dd><dd><code>scale</code> - Scale for numeric type, fraction precision for |
| fractional seconds, not needed for other types.</dd><dd><code>charset</code> - Character set enum for CHAR/VARCHAR types, not needed |
| for other types.</dd><dd><code>intervalCode</code> - Interval code enum for intervals, not needed otherwise.</dd><dd><code>precision</code> - Precision for numeric types and leading precision for |
| interval data types.</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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int, boolean, int, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode, org.trafodion.sql.udr.TypeInfo.SQLIntervalCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with all parameters except precision and collation</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</dd><dd><code>nullable</code> - Determines the NULL / NOT NULL attribute of the type |
| false means NOT NULL</dd><dd><code>scale</code> - Scale for numeric type, fraction precision for |
| fractional seconds, not needed for other types.</dd><dd><code>charset</code> - Character set enum for CHAR/VARCHAR types, not needed |
| for other types.</dd><dd><code>intervalCode</code> - Interval code enum for intervals, not needed otherwise.</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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int, boolean, int, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> charset) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with type, length, nullable, scale and charset</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</dd><dd><code>nullable</code> - Determines the NULL / NOT NULL attribute of the type |
| false means NOT NULL</dd><dd><code>scale</code> - Scale for numeric type, fraction precision for |
| fractional seconds, not needed for other types.</dd><dd><code>charset</code> - Character set enum for CHAR/VARCHAR types, not needed |
| for other types.</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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int, boolean, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable, |
| int scale) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with type, length, nullable and scale</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</dd><dd><code>nullable</code> - Determines the NULL / NOT NULL attribute of the type |
| false means NOT NULL</dd><dd><code>scale</code> - Scale for numeric type, fraction precision for |
| fractional seconds, not needed for other types.</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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length, |
| boolean nullable) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with type, length, and nullable</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</dd><dd><code>nullable</code> - Determines the NULL / NOT NULL attribute of the type |
| false means NOT 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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| int length) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with type, and length</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</dd><dd><code>length</code> - Length of CHAR/VARCHAR types, not needed for other types. |
| Note that the length for UTF-8 types is in bytes, not |
| characters, so this is equivalent to |
| <br> [VAR]CHAR (<code> <b> length </b> </code> BYTES) CHARACTER SET UTF8</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="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Constructor with type</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - SQL type enum to construct the type from.</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="TypeInfo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo() |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Default constructor</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></dl> |
| </li> |
| </ul> |
| <a name="TypeInfo(org.trafodion.sql.udr.TypeInfo.SQLTypeCode, boolean, int, org.trafodion.sql.udr.TypeInfo.SQLCharsetCode, org.trafodion.sql.udr.TypeInfo.SQLIntervalCode, int, org.trafodion.sql.udr.TypeInfo.SQLCollationCode, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TypeInfo</h4> |
| <pre>public TypeInfo(<a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> sqlType, |
| boolean nullable, |
| int scale, |
| <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.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> intervalCode, |
| int precision, |
| <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> collation, |
| int length) |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <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></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSQLType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSQLType</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeCode</a> getSQLType()</pre> |
| <div class="block">Get the SQL type.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>SQL type enum.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSQLTypeClass()"> |
| <!-- --> |
| </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()</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">Returns:</span></dt><dd>SQL type class enum.</dd></dl> |
| </li> |
| </ul> |
| <a name="getSQLTypeSubClass()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSQLTypeSubClass</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLTypeSubClassCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLTypeSubClassCode</a> getSQLTypeSubClass()</pre> |
| <div class="block">Get the SQL type subclass. |
| This goes to one more level of detail beyond the type class, |
| like exact/approximate numeric, char/varchar, etc.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>SQL type subclass enum.</dd></dl> |
| </li> |
| </ul> |
| <a name="getIsNullable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIsNullable</h4> |
| <pre>public boolean getIsNullable()</pre> |
| <div class="block">Get whether the type is nullable.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>True for nullable types, false for non-nullable types.</dd></dl> |
| </li> |
| </ul> |
| <a name="getScale()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScale</h4> |
| <pre>public int getScale()</pre> |
| <div class="block">Get the scale of the data type. |
| |
| <p> For integer, largeint, etc. types the scale is 0, since these are |
| integer data types. For NUMERIC and DECIMAL types, a scale can |
| be specified. Timestamp and some interval data types have a |
| "fraction precision" value, which is the number of digits |
| allowed after the decimal point for seconds. This fraction precision |
| is returned as the scale, since can be considered the scale of |
| the seconds part. For other data types like CHAR, the scale |
| value is meaningless.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Scale (digits after the decimal point) for numeric types, |
| fraction precision (digits of fractional seconds) for intervals.</dd></dl> |
| </li> |
| </ul> |
| <a name="getCharset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharset</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCharsetCode</a> getCharset()</pre> |
| <div class="block">Get the character set of the data type.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Character set enum.</dd></dl> |
| </li> |
| </ul> |
| <a name="getIntervalCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntervalCode</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLIntervalCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLIntervalCode</a> getIntervalCode()</pre> |
| <div class="block">Get the interval code for start/end fields.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Interval code enum, indicating start and end fields of an interval type.</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrecision()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrecision</h4> |
| <pre>public int getPrecision()</pre> |
| <div class="block">Get the precision (max. number of significant digits). |
| |
| The precision is the maximum number of digits before the decimal |
| point a value can have. For interval types, this is the "leading |
| precision". For example, an INTEGER value can range from |
| -2,147,483,648 to 2,147,483,647. It's precision is 10, since the |
| longest number has 10 digits. Note that not all 10 digit numbers |
| can be represented in an integer. This is called binary |
| precision. NUMERIC and DECIMAL types have decimal precision, |
| meaning that a NUMERIC(10,0) type can represent values from |
| -9,999,999,999 to +9,999,999,999.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Precision of numeric types or interval types.</dd></dl> |
| </li> |
| </ul> |
| <a name="getFlags()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFlags</h4> |
| <pre>public int getFlags()</pre> |
| </li> |
| </ul> |
| <a name="getCollation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCollation</h4> |
| <pre>public <a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCollationCode.html" title="enum in org.trafodion.sql.udr">TypeInfo.SQLCollationCode</a> getCollation()</pre> |
| <div class="block">Get the collation for char/varchar data types. |
| |
| <p> Note that, currently, only one collation is supported. |
| This default collation is a binary collation, except that |
| trailing blanks are ignored.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Collation enum.</dd></dl> |
| </li> |
| </ul> |
| <a name="getByteLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteLength</h4> |
| <pre>public int getByteLength()</pre> |
| <div class="block">Get the length of a value of the type. |
| |
| <p> Getting the length is useful for CHAR/VARCHAR data types |
| but probably not as useful for other types that may have |
| an internal representation unknown to a UDR writer. |
| This returns the length in bytes, not in characters.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Length in bytes.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/trafodion/sql/udr/TypeInfo.html#getMaxCharLength()"><code>getMaxCharLength()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getMaxCharLength()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxCharLength</h4> |
| <pre>public int getMaxCharLength() |
| throws <a href="../../../../org/trafodion/sql/udr/UDRException.html" title="class in org.trafodion.sql.udr">UDRException</a></pre> |
| <div class="block">Get the maximum number of characters that can be stored in this type. |
| |
| <p> This method should be used only for character types that |
| have a fixed-width encoding. For variable-length encoding, like |
| UTF-8, the method returns the highest possible number of characters |
| (assuming single byte characters in the case of UTF-8). Right now, |
| UTF-8 data types all have byte semantics, meaning there is no |
| limit for the number of characters stored in a type, it is only |
| limited by the number of bytes. The method returns 0 for numeric |
| types. It returns the length of the string representation for |
| types that are represented by a string, like datetime types.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Length in bytes.</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/TypeInfo.html#getByteLength()"><code>getByteLength()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setNullable(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setNullable</h4> |
| <pre>public void setNullable(boolean nullable)</pre> |
| <div class="block">Set the nullable attribute of a type |
| |
| Use this method to set types created locally in the UDF |
| to be nullable or not nullable.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>nullable</code> - true to set the type to nullable, false |
| to give the type the NOT NULL attibute.</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/TypeInfo.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/TupleInfo.html" title="class in org.trafodion.sql.udr"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/trafodion/sql/udr/TypeInfo.SQLCharsetCode.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/TypeInfo.html" target="_top">Frames</a></li> |
| <li><a href="TypeInfo.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> |
