| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RelDataType (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.rel.type</a></div> |
| <h1 title="Interface RelDataType" class="title">Interface RelDataType</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <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/MeasureSqlType.html" title="class in org.apache.calcite.sql.type">MeasureSqlType</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> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RelDataType</span></div> |
| <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="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#PRECISION_NOT_SPECIFIED" class="member-name-link">PRECISION_NOT_SPECIFIED</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#SCALE_NOT_SPECIFIED" class="member-name-link">SCALE_NOT_SPECIFIED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#equalsSansFieldNames(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">equalsSansFieldNames</a><wbr>(@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> that)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns whether the field types are equal with each other by ignoring the |
| field names.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCharset()" class="member-name-link">getCharset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCollation()" class="member-name-link">getCollation</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets this type's collation, or null if this type cannot carry a collation |
| or has no collation defined.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getComparability()" class="member-name-link">getComparability</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the category of comparison operators that make sense when applied |
| to values of this type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getComponentType()" class="member-name-link">getComponentType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the component type if this type is a collection, otherwise null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFamily()" class="member-name-link">getFamily</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a canonical object representing the family of this type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getField(java.lang.String,boolean,boolean)" class="member-name-link">getField</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Looks up a field by name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFieldCount()" class="member-name-link">getFieldCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the number of fields in a struct type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFieldList()" class="member-name-link">getFieldList</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the fields in a struct type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFieldNames()" class="member-name-link">getFieldNames</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the names of the fields in a struct type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFullTypeString()" class="member-name-link">getFullTypeString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a string representation of this type with full detail such as |
| character set and nullability.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getIntervalQualifier()" class="member-name-link">getIntervalQualifier</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets this type's interval qualifier, or null if this is not an interval |
| type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getKeyType()" class="member-name-link">getKeyType</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the key type if this type is a map, otherwise null.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPrecedenceList()" class="member-name-link">getPrecedenceList</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the precedence list for this type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPrecision()" class="member-name-link">getPrecision</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the JDBC-defined precision for values of this type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScale()" class="member-name-link">getScale</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the scale of this type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSqlIdentifier()" class="member-name-link">getSqlIdentifier</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSqlTypeName()" class="member-name-link">getSqlTypeName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStructKind()" class="member-name-link">getStructKind</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getValueType()" class="member-name-link">getValueType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the value type if this type is a map, otherwise null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isDynamicStruct()" class="member-name-link">isDynamicStruct</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this type has dynamic structure (for "schema-on-read" |
| table).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isNullable()" class="member-name-link">isNullable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Queries whether this type allows null values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isStruct()" class="member-name-link">isStruct</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Queries whether this is a structured type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets a string representation of this type without detail such as |
| character set and nullability.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="SCALE_NOT_SPECIFIED"> |
| <h3>SCALE_NOT_SPECIFIED</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name">SCALE_NOT_SPECIFIED</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.rel.type.RelDataType.SCALE_NOT_SPECIFIED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PRECISION_NOT_SPECIFIED"> |
| <h3>PRECISION_NOT_SPECIFIED</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name">PRECISION_NOT_SPECIFIED</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.calcite.rel.type.RelDataType.PRECISION_NOT_SPECIFIED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isStruct()"> |
| <h3>isStruct</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">boolean</span> <span class="element-name">isStruct</span>()</div> |
| <div class="block">Queries whether this is a structured type.</div> |
| <dl class="notes"> |
| <dt>Returns:</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> |
| <section class="detail" id="getFieldList()"> |
| <h3>getFieldList</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>read-only list of fields</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFieldNames()"> |
| <h3>getFieldNames</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>read-only list of field names</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFieldCount()"> |
| <h3>getFieldCount</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">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> |
| <section class="detail" id="getStructKind()"> |
| <h3>getStructKind</h3> |
| <div class="member-signature"><span class="return-type"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the StructKind that determines how this type's fields are resolved</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getField(java.lang.String,boolean,boolean)"> |
| <h3>getField</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span> <span class="element-name">getField</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">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 class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>named field, or null if not found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNullable()"> |
| <h3>isNullable</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">boolean</span> <span class="element-name">isNullable</span>()</div> |
| <div class="block">Queries whether this type allows null values.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether type allows null values</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponentType()"> |
| <h3>getComponentType</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getComponentType</span>()</div> |
| <div class="block">Gets the component type if this type is a collection, otherwise null.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>canonical type descriptor for components</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getKeyType()"> |
| <h3>getKeyType</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getKeyType</span>()</div> |
| <div class="block">Gets the key type if this type is a map, otherwise null.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>canonical type descriptor for key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValueType()"> |
| <h3>getValueType</h3> |
| <div class="member-signature"><span class="return-type">@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getValueType</span>()</div> |
| <div class="block">Gets the value type if this type is a map, otherwise null.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>canonical type descriptor for value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCharset()"> |
| <h3>getCharset</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>charset of type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCollation()"> |
| <h3>getCollation</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>collation of type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIntervalQualifier()"> |
| <h3>getIntervalQualifier</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">@Nullable <a href="../../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></span> <span class="element-name">getIntervalQualifier</span>()</div> |
| <div class="block">Gets this type's interval qualifier, or null if this is not an interval |
| type.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>interval qualifier</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPrecision()"> |
| <h3>getPrecision</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</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> |
| <section class="detail" id="getScale()"> |
| <h3>getScale</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>number of digits of scale</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSqlTypeName()"> |
| <h3>getSqlTypeName</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>SqlTypeName, never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSqlIdentifier()"> |
| <h3>getSqlIdentifier</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">@Nullable <a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>SqlIdentifier, or null if this is not an SQL type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Gets a string representation of this type without detail such as |
| character set and nullability.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>abbreviated type string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFullTypeString()"> |
| <h3>getFullTypeString</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>full type string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamily()"> |
| <h3>getFamily</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></span> <span class="element-name">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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>canonical object representing type family, never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPrecedenceList()"> |
| <h3>getPrecedenceList</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></span> <span class="element-name">getPrecedenceList</span>()</div> |
| <div class="block">Returns the precedence list for this type.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComparability()"> |
| <h3>getComparability</h3> |
| <div class="member-signature"><span class="return-type"><a href="RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a></span> <span class="element-name">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> |
| <section class="detail" id="isDynamicStruct()"> |
| <h3>isDynamicStruct</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isDynamicStruct</span>()</div> |
| <div class="block">Returns whether this type has dynamic structure (for "schema-on-read" |
| table).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equalsSansFieldNames(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>equalsSansFieldNames</h3> |
| <div class="member-signature"><span class="annotations">@API(since="1.24", |
| status=INTERNAL) |
| </span><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">equalsSansFieldNames</span><wbr><span class="parameters">(@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> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
