| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>DynamicRecordTypeImpl (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, class: DynamicRecordTypeImpl"> |
| <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><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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="Class DynamicRecordTypeImpl" class="title">Class DynamicRecordTypeImpl</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance"><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">org.apache.calcite.rel.type.RelDataTypeImpl</a> |
| <div class="inheritance"><a href="DynamicRecordType.html" title="class in org.apache.calcite.rel.type">org.apache.calcite.rel.type.DynamicRecordType</a> |
| <div class="inheritance">org.apache.calcite.rel.type.DynamicRecordTypeImpl</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code>, <code><a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../../piglet/DynamicTupleRecordType.html" title="class in org.apache.calcite.piglet">DynamicTupleRecordType</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DynamicRecordTypeImpl</span> |
| <span class="extends-implements">extends <a href="DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a></span></div> |
| <div class="block">Implementation of <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a> for a dynamic table. |
| |
| <p>It's used during SQL validation, where the field list is mutable for |
| the getField() call. After SQL validation, a normal <a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type"><code>RelDataTypeImpl</code></a> |
| with an immutable field list takes the place of the DynamicRecordTypeImpl |
| instance.</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="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.type.DynamicRecordType">Fields inherited from class org.apache.calcite.rel.type.<a href="DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a></h3> |
| <code><a href="DynamicRecordType.html#DYNAMIC_STAR_PREFIX">DYNAMIC_STAR_PREFIX</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.type.RelDataTypeImpl">Fields inherited from class org.apache.calcite.rel.type.<a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></h3> |
| <code><a href="RelDataTypeImpl.html#digest">digest</a>, <a href="RelDataTypeImpl.html#fieldList">fieldList</a>, <a href="RelDataTypeImpl.html#NON_NULLABLE_SUFFIX">NON_NULLABLE_SUFFIX</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.rel.type.RelDataType">Fields inherited from interface org.apache.calcite.rel.type.<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3> |
| <code><a href="RelDataType.html#PRECISION_NOT_SPECIFIED">PRECISION_NOT_SPECIFIED</a>, <a href="RelDataType.html#SCALE_NOT_SPECIFIED">SCALE_NOT_SPECIFIED</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataTypeFactory)" class="member-name-link">DynamicRecordTypeImpl</a><wbr>(<a href="RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a DynamicRecordTypeImpl.</div> |
| </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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateTypeString(java.lang.StringBuilder,boolean)" class="member-name-link">generateTypeString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb, |
| boolean withDetail)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Generates a string representation of this type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><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-tab4"> |
| <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-tab4"><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-tab4"><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-tab4"> |
| <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-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"> |
| <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-tab4"><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-tab4"><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-tab4"> |
| <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-tab4"><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-tab4"><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-tab4"> |
| <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-tab4"><code><a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrecedenceList()" class="member-name-link">getPrecedenceList</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the precedence list for this type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"><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-tab4"> |
| <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-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4"> |
| <div class="block">Queries whether this is a structured type.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.DynamicRecordType">Methods inherited from class org.apache.calcite.rel.type.<a href="DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</a></h3> |
| <code><a href="DynamicRecordType.html#isDynamicStarColName(java.lang.String)">isDynamicStarColName</a>, <a href="DynamicRecordType.html#isDynamicStruct()">isDynamicStruct</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.RelDataTypeImpl">Methods inherited from class org.apache.calcite.rel.type.<a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></h3> |
| <code><a href="RelDataTypeImpl.html#computeDigest()">computeDigest</a>, <a href="RelDataTypeImpl.html#equals(java.lang.Object)">equals</a>, <a href="RelDataTypeImpl.html#extra(org.apache.calcite.rel.type.RelDataType)">extra</a>, <a href="RelDataTypeImpl.html#getCharset()">getCharset</a>, <a href="RelDataTypeImpl.html#getCollation()">getCollation</a>, <a href="RelDataTypeImpl.html#getComparability()">getComparability</a>, <a href="RelDataTypeImpl.html#getComponentType()">getComponentType</a>, <a href="RelDataTypeImpl.html#getFieldMap()">getFieldMap</a>, <a href="RelDataTypeImpl.html#getFullTypeString()">getFullTypeString</a>, <a href="RelDataTypeImpl.html#getIntervalQualifier()">getIntervalQualifier</a>, <a href="RelDataTypeImpl.html#getKeyType()">getKeyType</a>, <a href="RelDataTypeImpl.html#getPrecision()">getPrecision</a>, <a href="RelDataTypeImpl.html#getScale()">getScale</a>, <a href="RelDataTypeImpl.html#getSqlIdentifier()">getSqlIdentifier</a>, <a href="RelDataTypeImpl.html#getStructKind()">getStructKind</a>, <a href="RelDataTypeImpl.html#getValueType()">getValueType</a>, <a href="RelDataTypeImpl.html#hashCode()">hashCode</a>, <a href="RelDataTypeImpl.html#isNullable()">isNullable</a>, <a href="RelDataTypeImpl.html#proto(org.apache.calcite.rel.type.RelDataType)">proto</a>, <a href="RelDataTypeImpl.html#proto(org.apache.calcite.sql.type.SqlTypeName,boolean)">proto</a>, <a href="RelDataTypeImpl.html#proto(org.apache.calcite.sql.type.SqlTypeName,int,boolean)">proto</a>, <a href="RelDataTypeImpl.html#proto(org.apache.calcite.sql.type.SqlTypeName,int,int,boolean)">proto</a>, <a href="RelDataTypeImpl.html#toString()">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.RelDataType">Methods inherited from interface org.apache.calcite.rel.type.<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3> |
| <code><a href="RelDataType.html#equalsSansFieldNames(org.apache.calcite.rel.type.RelDataType)">equalsSansFieldNames</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.rel.type.RelDataTypeFactory)"> |
| <h3>DynamicRecordTypeImpl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DynamicRecordTypeImpl</span><wbr><span class="parameters">(<a href="RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</span></div> |
| <div class="block">Creates a DynamicRecordTypeImpl.</div> |
| </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="getFieldList()"> |
| <h3>getFieldList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#getFieldList()">RelDataType</a></code></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>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getFieldList()">getFieldList</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getFieldList()">getFieldList</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>read-only list of fields</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFieldCount()"> |
| <h3>getFieldCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getFieldCount</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#getFieldCount()">RelDataType</a></code></span></div> |
| <div class="block">Returns the number of fields in a struct type. |
| |
| <p>This method is equivalent to |
| <code><a href="RelDataType.html#getFieldList()"><code>RelDataType.getFieldList()</code></a>.size()</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getFieldCount()">getFieldCount</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getFieldCount()">getFieldCount</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getField(java.lang.String,boolean,boolean)"> |
| <h3>getField</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#getField(java.lang.String,boolean,boolean)">RelDataType</a></code></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>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getField(java.lang.String,boolean,boolean)">getField</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getField(java.lang.String,boolean,boolean)">getField</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <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="getFieldNames()"> |
| <h3>getFieldNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#getFieldNames()">RelDataType</a></code></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>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getFieldNames()">getFieldNames</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getFieldNames()">getFieldNames</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>read-only list of field names</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSqlTypeName()"> |
| <h3>getSqlTypeName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from class: <code><a href="RelDataTypeImpl.html#getSqlTypeName()">RelDataTypeImpl</a></code></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. |
| Sub-classes must override the method to ensure the resulting value is non-nullable.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getSqlTypeName()">getSqlTypeName</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getSqlTypeName()">getSqlTypeName</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>SqlTypeName, never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPrecedenceList()"> |
| <h3>getPrecedenceList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#getPrecedenceList()">RelDataType</a></code></span></div> |
| <div class="block">Returns the precedence list for this type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getPrecedenceList()">getPrecedenceList</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getPrecedenceList()">getPrecedenceList</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="generateTypeString(java.lang.StringBuilder,boolean)"> |
| <h3>generateTypeString</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">generateTypeString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb, |
| boolean withDetail)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="RelDataTypeImpl.html#generateTypeString(java.lang.StringBuilder,boolean)">RelDataTypeImpl</a></code></span></div> |
| <div class="block">Generates a string representation of this type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#generateTypeString(java.lang.StringBuilder,boolean)">generateTypeString</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sb</code> - StringBuilder into which to generate the string</dd> |
| <dd><code>withDetail</code> - when true, all detail information needed to compute a |
| unique digest (and return from getFullTypeString) should |
| be included;</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStruct()"> |
| <h3>isStruct</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStruct</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#isStruct()">RelDataType</a></code></span></div> |
| <div class="block">Queries whether this is a structured type.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#isStruct()">isStruct</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#isStruct()">isStruct</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <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="getFamily()"> |
| <h3>getFamily</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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"><span class="descfrm-type-label">Description copied from interface: <code><a href="RelDataType.html#getFamily()">RelDataType</a></code></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>Specified by:</dt> |
| <dd><code><a href="RelDataType.html#getFamily()">getFamily</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="RelDataTypeImpl.html#getFamily()">getFamily</a></code> in class <code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>canonical object representing type family, never null</dd> |
| </dl> |
| </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> |
