| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RelDataType (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RelDataType (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/rel/type/RelCrossType.html" title="class in org.apache.calcite.rel.type"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/rel/type/RelDataType.html" target="_top">Frames</a></li> |
| <li><a href="RelDataType.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.rel.type</div> |
| <h2 title="Interface RelDataType" class="title">Interface RelDataType</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/calcite/sql/type/AbstractSqlType.html" title="class in org.apache.calcite.sql.type">AbstractSqlType</a>, <a href="../../../../../org/apache/calcite/sql/type/ArraySqlType.html" title="class in org.apache.calcite.sql.type">ArraySqlType</a>, <a href="../../../../../org/apache/calcite/sql/type/BasicSqlType.html" title="class in org.apache.calcite.sql.type">BasicSqlType</a>, <a href="../../../../../org/apache/calcite/rel/type/DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a>, <a href="../../../../../org/apache/calcite/rel/type/DynamicRecordTypeImpl.html" title="class in org.apache.calcite.rel.type">DynamicRecordTypeImpl</a>, <a href="../../../../../org/apache/calcite/piglet/DynamicTupleRecordType.html" title="class in org.apache.calcite.piglet">DynamicTupleRecordType</a>, <a href="../../../../../org/apache/calcite/sql/type/IntervalSqlType.html" title="class in org.apache.calcite.sql.type">IntervalSqlType</a>, <a href="../../../../../org/apache/calcite/jdbc/JavaRecordType.html" title="class in org.apache.calcite.jdbc">JavaRecordType</a>, <a href="../../../../../org/apache/calcite/sql/type/MapSqlType.html" title="class in org.apache.calcite.sql.type">MapSqlType</a>, <a href="../../../../../org/apache/calcite/sql/type/MultisetSqlType.html" title="class in org.apache.calcite.sql.type">MultisetSqlType</a>, <a href="../../../../../org/apache/calcite/sql/type/ObjectSqlType.html" title="class in org.apache.calcite.sql.type">ObjectSqlType</a>, <a href="../../../../../org/apache/calcite/rel/type/RelCrossType.html" title="class in org.apache.calcite.rel.type">RelCrossType</a>, <a href="../../../../../org/apache/calcite/rel/type/RelDataTypeFactoryImpl.JavaType.html" title="class in org.apache.calcite.rel.type">RelDataTypeFactoryImpl.JavaType</a>, <a href="../../../../../org/apache/calcite/rel/type/RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a>, <a href="../../../../../org/apache/calcite/rel/type/RelRecordType.html" title="class in org.apache.calcite.rel.type">RelRecordType</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">RelDataType</span></pre> |
| <div class="block">RelDataType represents the type of a scalar expression or entire row returned |
| from a relational expression. |
| |
| <p>This is a somewhat "fat" interface which unions the attributes of many |
| different type classes into one. Inelegant, but since our type system was |
| defined before the advent of Java generics, it avoids a lot of typecasting.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#PRECISION_NOT_SPECIFIED">PRECISION_NOT_SPECIFIED</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#SCALE_NOT_SPECIFIED">SCALE_NOT_SPECIFIED</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#equalsSansFieldNames-org.apache.calcite.rel.type.RelDataType-">equalsSansFieldNames</a></span>(<a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> that)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getCharset--">getCharset</a></span>()</code> |
| <div class="block">Gets this type's character set, or null if this type cannot carry a |
| character set or has no character set defined.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getCollation--">getCollation</a></span>()</code> |
| <div class="block">Gets this type's collation, or null if this type cannot carry a collation |
| or has no collation defined.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getComparability--">getComparability</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getComponentType--">getComponentType</a></span>()</code> |
| <div class="block">Gets the component type if this type is a collection, otherwise null.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getFamily--">getFamily</a></span>()</code> |
| <div class="block">Gets a canonical object representing the family of this type.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getField-java.lang.String-boolean-boolean-">getField</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</code> |
| <div class="block">Looks up a field by name.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getFieldCount--">getFieldCount</a></span>()</code> |
| <div class="block">Returns the number of fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/calcite/rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getFieldList--">getFieldList</a></span>()</code> |
| <div class="block">Gets the fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getFieldNames--">getFieldNames</a></span>()</code> |
| <div class="block">Returns the names of the fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getFullTypeString--">getFullTypeString</a></span>()</code> |
| <div class="block">Gets a string representation of this type with full detail such as |
| character set and nullability.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getIntervalQualifier--">getIntervalQualifier</a></span>()</code> |
| <div class="block">Gets this type's interval qualifier, or null if this is not an interval |
| type.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getKeyType--">getKeyType</a></span>()</code> |
| <div class="block">Gets the key type if this type is a map, otherwise null.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getPrecedenceList--">getPrecedenceList</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getPrecision--">getPrecision</a></span>()</code> |
| <div class="block">Gets the JDBC-defined precision for values of this type.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getScale--">getScale</a></span>()</code> |
| <div class="block">Gets the scale of this type.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getSqlIdentifier--">getSqlIdentifier</a></span>()</code> |
| <div class="block">Gets the <a href="../../../../../org/apache/calcite/sql/SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a> associated with this type.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getSqlTypeName--">getSqlTypeName</a></span>()</code> |
| <div class="block">Gets the <a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type"><code>SqlTypeName</code></a> of this type.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getStructKind--">getStructKind</a></span>()</code> |
| <div class="block">Returns the rule for resolving the fields of a structured type, |
| or <a href="../../../../../org/apache/calcite/rel/type/StructKind.html#NONE"><code>StructKind.NONE</code></a> if this is not a structured type.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getValueType--">getValueType</a></span>()</code> |
| <div class="block">Gets the value type if this type is a map, otherwise null.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#isDynamicStruct--">isDynamicStruct</a></span>()</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#isNullable--">isNullable</a></span>()</code> |
| <div class="block">Queries whether this type allows null values.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#isStruct--">isStruct</a></span>()</code> |
| <div class="block">Queries whether this is a structured type.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#toString--">toString</a></span>()</code> |
| <div class="block">Gets a string representation of this type without detail such as |
| character set and nullability.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="SCALE_NOT_SPECIFIED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCALE_NOT_SPECIFIED</h4> |
| <pre>static final int SCALE_NOT_SPECIFIED</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.calcite.rel.type.RelDataType.SCALE_NOT_SPECIFIED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PRECISION_NOT_SPECIFIED"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PRECISION_NOT_SPECIFIED</h4> |
| <pre>static final int PRECISION_NOT_SPECIFIED</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.calcite.rel.type.RelDataType.PRECISION_NOT_SPECIFIED">Constant Field Values</a></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="isStruct--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStruct</h4> |
| <pre>boolean isStruct()</pre> |
| <div class="block">Queries whether this is a structured type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this type has fields; examples include rows and |
| user-defined structured types in SQL, and classes in Java</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFieldList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldList</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/calcite/rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>> getFieldList()</pre> |
| <div class="block">Gets the fields in a struct type. The field count is equal to the size of |
| the returned list.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>read-only list of fields</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFieldNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldNames</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getFieldNames()</pre> |
| <div class="block">Returns the names of the fields in a struct type. The field count is |
| equal to the size of the returned list.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>read-only list of field names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFieldCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldCount</h4> |
| <pre>int getFieldCount()</pre> |
| <div class="block">Returns the number of fields in a struct type. |
| |
| <p>This method is equivalent to |
| <code><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getFieldList--"><code>getFieldList()</code></a>.size()</code>.</div> |
| </li> |
| </ul> |
| <a name="getStructKind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStructKind</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a> getStructKind()</pre> |
| <div class="block">Returns the rule for resolving the fields of a structured type, |
| or <a href="../../../../../org/apache/calcite/rel/type/StructKind.html#NONE"><code>StructKind.NONE</code></a> if this is not a structured type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the StructKind that determines how this type's fields are resolved</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getField-java.lang.String-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a> getField(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</pre> |
| <div class="block">Looks up a field by name. |
| |
| <p>NOTE: Be careful choosing the value of <code>caseSensitive</code>:</p> |
| <ul> |
| <li>If the field name was supplied by an end-user (e.g. as a column alias |
| in SQL), use your session's case-sensitivity setting.</li> |
| <li>Only hard-code <code>true</code> if you are sure that the field name is |
| internally generated.</li> |
| <li>Hard-coding <code>false</code> is almost certainly wrong.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - Name of field to find</dd> |
| <dd><code>caseSensitive</code> - Whether match is case-sensitive</dd> |
| <dd><code>elideRecord</code> - Whether to find fields nested within records</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>named field, or null if not found</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isNullable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNullable</h4> |
| <pre>boolean isNullable()</pre> |
| <div class="block">Queries whether this type allows null values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether type allows null values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getComponentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentType</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getComponentType()</pre> |
| <div class="block">Gets the component type if this type is a collection, otherwise null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>canonical type descriptor for components</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyType</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getKeyType()</pre> |
| <div class="block">Gets the key type if this type is a map, otherwise null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>canonical type descriptor for key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getValueType()</pre> |
| <div class="block">Gets the value type if this type is a map, otherwise null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>canonical type descriptor for value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCharset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharset</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a> getCharset()</pre> |
| <div class="block">Gets this type's character set, or null if this type cannot carry a |
| character set or has no character set defined.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>charset of type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCollation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCollation</h4> |
| <pre><a href="../../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a> getCollation()</pre> |
| <div class="block">Gets this type's collation, or null if this type cannot carry a collation |
| or has no collation defined.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>collation of type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getIntervalQualifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntervalQualifier</h4> |
| <pre><a href="../../../../../org/apache/calcite/sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a> getIntervalQualifier()</pre> |
| <div class="block">Gets this type's interval qualifier, or null if this is not an interval |
| type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>interval qualifier</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrecision--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrecision</h4> |
| <pre>int getPrecision()</pre> |
| <div class="block">Gets the JDBC-defined precision for values of this type. Note that this |
| is not always the same as the user-specified precision. For example, the |
| type INTEGER has no user-specified precision, but this method returns 10 |
| for an INTEGER type. |
| |
| <p>Returns <a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#PRECISION_NOT_SPECIFIED"><code>PRECISION_NOT_SPECIFIED</code></a> (-1) if precision is not |
| applicable for this type.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of decimal digits for exact numeric types; number of |
| decimal digits in mantissa for approximate numeric types; number of |
| decimal digits for fractional seconds of datetime types; length in |
| characters for character types; length in bytes for binary types; length |
| in bits for bit types; 1 for BOOLEAN; -1 if precision is not valid for |
| this type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getScale--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScale</h4> |
| <pre>int getScale()</pre> |
| <div class="block">Gets the scale of this type. Returns <a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#SCALE_NOT_SPECIFIED"><code>SCALE_NOT_SPECIFIED</code></a> (-1) if |
| scale is not valid for this type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of digits of scale</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSqlTypeName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlTypeName</h4> |
| <pre><a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> getSqlTypeName()</pre> |
| <div class="block">Gets the <a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type"><code>SqlTypeName</code></a> of this type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SqlTypeName, or null if this is not an SQL predefined type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSqlIdentifier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlIdentifier</h4> |
| <pre><a href="../../../../../org/apache/calcite/sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> getSqlIdentifier()</pre> |
| <div class="block">Gets the <a href="../../../../../org/apache/calcite/sql/SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a> associated with this type. For a |
| predefined type, this is a simple identifier based on |
| <a href="../../../../../org/apache/calcite/rel/type/RelDataType.html#getSqlTypeName--"><code>getSqlTypeName()</code></a>. For a user-defined type, this is a compound |
| identifier which uniquely names the type.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SqlIdentifier, or null if this is not an SQL type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block">Gets a string representation of this type without detail such as |
| character set and nullability.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>abbreviated type string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFullTypeString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullTypeString</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getFullTypeString()</pre> |
| <div class="block">Gets a string representation of this type with full detail such as |
| character set and nullability. The string must serve as a "digest" for |
| this type, meaning two types can be considered identical iff their |
| digests are equal.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>full type string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamily--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamily</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a> getFamily()</pre> |
| <div class="block">Gets a canonical object representing the family of this type. Two values |
| can be compared if and only if their types are in the same family.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>canonical object representing type family</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrecedenceList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrecedenceList</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a> getPrecedenceList()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>precedence list for this type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getComparability--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComparability</h4> |
| <pre><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a> getComparability()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the category of comparison operators which make sense when |
| applied to values of this type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDynamicStruct--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDynamicStruct</h4> |
| <pre>boolean isDynamicStruct()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether it has dynamic structure (for "schema-on-read" table)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="equalsSansFieldNames-org.apache.calcite.rel.type.RelDataType-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>equalsSansFieldNames</h4> |
| <pre>@API(since="1.24", |
| status=INTERNAL) |
| default boolean equalsSansFieldNames(<a href="../../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> that)</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the field types are equal with each other by ignoring |
| the field names. If it is not a struct, just return the result of |
| <code>#equals(Object)</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/rel/type/RelCrossType.html" title="class in org.apache.calcite.rel.type"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/rel/type/RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/rel/type/RelDataType.html" target="_top">Frames</a></li> |
| <li><a href="RelDataType.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><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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 © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
