| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RelDataType (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.rel.type, interface: RelDataType"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"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"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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"> |
| <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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.rel.type</a></div> |
| <h1 title="Interface RelDataType" class="title">Interface RelDataType</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../sql/type/AbstractSqlType.html" title="class in org.apache.calcite.sql.type">AbstractSqlType</a></code>, <code><a href="../../sql/type/ArraySqlType.html" title="class in org.apache.calcite.sql.type">ArraySqlType</a></code>, <code><a href="../../sql/type/BasicSqlType.html" title="class in org.apache.calcite.sql.type">BasicSqlType</a></code>, <code><a href="DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a></code>, <code><a href="DynamicRecordTypeImpl.html" title="class in org.apache.calcite.rel.type">DynamicRecordTypeImpl</a></code>, <code><a href="../../piglet/DynamicTupleRecordType.html" title="class in org.apache.calcite.piglet">DynamicTupleRecordType</a></code>, <code><a href="../../sql/type/IntervalSqlType.html" title="class in org.apache.calcite.sql.type">IntervalSqlType</a></code>, <code><a href="../../jdbc/JavaRecordType.html" title="class in org.apache.calcite.jdbc">JavaRecordType</a></code>, <code><a href="../../sql/type/MapSqlType.html" title="class in org.apache.calcite.sql.type">MapSqlType</a></code>, <code><a href="../../sql/type/MultisetSqlType.html" title="class in org.apache.calcite.sql.type">MultisetSqlType</a></code>, <code><a href="../../sql/type/ObjectSqlType.html" title="class in org.apache.calcite.sql.type">ObjectSqlType</a></code>, <code><a href="RelCrossType.html" title="class in org.apache.calcite.rel.type">RelCrossType</a></code>, <code><a href="RelDataTypeFactoryImpl.JavaType.html" title="class in org.apache.calcite.rel.type">RelDataTypeFactoryImpl.JavaType</a></code>, <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code>, <code><a href="RelRecordType.html" title="class in org.apache.calcite.rel.type">RelRecordType</a></code></dd> |
| </dl> |
| <hr> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PRECISION_NOT_SPECIFIED">PRECISION_NOT_SPECIFIED</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SCALE_NOT_SPECIFIED">SCALE_NOT_SPECIFIED</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="tableTab" onclick="show(16);">Default Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equalsSansFieldNames(org.apache.calcite.rel.type.RelDataType)">equalsSansFieldNames</a></span>​(@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> that)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the field types are equal with each other by ignoring the |
| field names.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset" class="externalLink">Charset</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharset()">getCharset</a></span>()</code></th> |
| <td class="colLast"> |
| <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 class="altColor" id="i2"> |
| <td class="colFirst"><code>@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollation()">getCollation</a></span>()</code></th> |
| <td class="colLast"> |
| <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 class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComparability()">getComparability</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the category of comparison operators that make sense when applied |
| to values of this type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentType()">getComponentType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the component type if this type is a collection, otherwise null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFamily()">getFamily</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a canonical object representing the family of this type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>@Nullable <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getField(java.lang.String,boolean,boolean)">getField</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</code></th> |
| <td class="colLast"> |
| <div class="block">Looks up a field by name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldCount()">getFieldCount</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldList()">getFieldList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldNames()">getFieldNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of the fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFullTypeString()">getFullTypeString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a string representation of this type with full detail such as |
| character set and nullability.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>@Nullable <a href="../../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntervalQualifier()">getIntervalQualifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets this type's interval qualifier, or null if this is not an interval |
| type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyType()">getKeyType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the key type if this type is a map, otherwise null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code><a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrecedenceList()">getPrecedenceList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the precedence list for this type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrecision()">getPrecision</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the JDBC-defined precision for values of this type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScale()">getScale</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the scale of this type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>@Nullable <a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqlIdentifier()">getSqlIdentifier</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the <a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a> associated with this type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqlTypeName()">getSqlTypeName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the <a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type"><code>SqlTypeName</code></a> of this type.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStructKind()">getStructKind</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the rule for resolving the fields of a structured type, |
| or <a href="StructKind.html#NONE"><code>StructKind.NONE</code></a> if this is not a structured type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueType()">getValueType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the value type if this type is a map, otherwise null.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDynamicStruct()">isDynamicStruct</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this type has dynamic structure (for "schema-on-read" |
| table).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNullable()">isNullable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Queries whether this type allows null values.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isStruct()">isStruct</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Queries whether this is a structured type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets a string representation of this type without detail such as |
| character set and nullability.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="SCALE_NOT_SPECIFIED">SCALE_NOT_SPECIFIED</a></h3> |
| <div class="memberSignature"><span class="modifiers">static final</span> <span class="returnType">int</span> <span class="memberName">SCALE_NOT_SPECIFIED</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="PRECISION_NOT_SPECIFIED">PRECISION_NOT_SPECIFIED</a></h3> |
| <div class="memberSignature"><span class="modifiers">static final</span> <span class="returnType">int</span> <span class="memberName">PRECISION_NOT_SPECIFIED</span></div> |
| <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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isStruct()">isStruct</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">boolean</span> <span class="memberName">isStruct</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFieldList()">getFieldList</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></span> <span class="memberName">getFieldList</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFieldNames()">getFieldNames</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></span> <span class="memberName">getFieldNames</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFieldCount()">getFieldCount</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">getFieldCount</span>()</div> |
| <div class="block">Returns the number of fields in a struct type. |
| |
| <p>This method is equivalent to |
| <code><a href="#getFieldList()"><code>getFieldList()</code></a>.size()</code>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getStructKind()">getStructKind</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="memberName">getStructKind</span>()</div> |
| <div class="block">Returns the rule for resolving the fields of a structured type, |
| or <a href="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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getField(java.lang.String,boolean,boolean)">getField</a></h3> |
| <div class="memberSignature"><span class="returnType">@Nullable <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span> <span class="memberName">getField</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</span></div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isNullable()">isNullable</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">boolean</span> <span class="memberName">isNullable</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getComponentType()">getComponentType</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">getComponentType</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getKeyType()">getKeyType</a></h3> |
| <div class="memberSignature"><span class="returnType">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">getKeyType</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getValueType()">getValueType</a></h3> |
| <div class="memberSignature"><span class="returnType">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">getValueType</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getCharset()">getCharset</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset" class="externalLink">Charset</a></span> <span class="memberName">getCharset</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getCollation()">getCollation</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span> <span class="memberName">getCollation</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getIntervalQualifier()">getIntervalQualifier</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">@Nullable <a href="../../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></span> <span class="memberName">getIntervalQualifier</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getPrecision()">getPrecision</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">getPrecision</span>()</div> |
| <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="#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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getScale()">getScale</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">getScale</span>()</div> |
| <div class="block">Gets the scale of this type. Returns <a href="#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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSqlTypeName()">getSqlTypeName</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></span> <span class="memberName">getSqlTypeName</span>()</div> |
| <div class="block">Gets the <a href="../../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, never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSqlIdentifier()">getSqlIdentifier</a></h3> |
| <div class="memberSignature"><span class="annotations">@Pure |
| </span><span class="returnType">@Nullable <a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span> <span class="memberName">getSqlIdentifier</span>()</div> |
| <div class="block">Gets the <a href="../../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="#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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <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/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>abbreviated type string</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFullTypeString()">getFullTypeString</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getFullTypeString</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFamily()">getFamily</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></span> <span class="memberName">getFamily</span>()</div> |
| <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, never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getPrecedenceList()">getPrecedenceList</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></span> <span class="memberName">getPrecedenceList</span>()</div> |
| <div class="block">Returns the precedence list for this type.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getComparability()">getComparability</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a></span> <span class="memberName">getComparability</span>()</div> |
| <div class="block">Returns the category of comparison operators that make sense when applied |
| to values of this type.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isDynamicStruct()">isDynamicStruct</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">isDynamicStruct</span>()</div> |
| <div class="block">Returns whether this type has dynamic structure (for "schema-on-read" |
| table).</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equalsSansFieldNames(org.apache.calcite.rel.type.RelDataType)">equalsSansFieldNames</a></h3> |
| <div class="memberSignature"><span class="annotations">@API(since="1.24", |
| status=INTERNAL) |
| </span><span class="modifiers">default</span> <span class="returnType">boolean</span> <span class="memberName">equalsSansFieldNames</span>​(<span class="arguments">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> that)</span></div> |
| <div class="block">Returns 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>.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.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"> |
| <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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
