blob: db963f42c62eb2234f4482f33aa8f3fbf7d3de45 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelDataTypeImpl (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, class: RelDataTypeImpl">
<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":10,"i1":10,"i2":9,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":9,"i28":9,"i29":9,"i30":9,"i31":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.rel.type</a></div>
<h1 title="Class RelDataTypeImpl" class="title">Class RelDataTypeImpl</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.rel.type.RelDataTypeImpl</div>
</div>
<section class="description">
<dl>
<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>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../sql/type/AbstractSqlType.html" title="class in org.apache.calcite.sql.type">AbstractSqlType</a></code>, <code><a href="DynamicRecordType.html" title="class in org.apache.calcite.rel.type">DynamicRecordType</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="RelRecordType.html" title="class in org.apache.calcite.rel.type">RelRecordType</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">RelDataTypeImpl</span>
extends <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>
implements <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>, <a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></pre>
<div class="block">RelDataTypeImpl is an abstract base for implementations of
<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelDataType</code></a>.
<p>Identity is based upon the <a href="#digest"><code>digest</code></a> field, which each derived class
should set during construction.</p></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">&nbsp;</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>protected <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="#digest">digest</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <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>&lt;<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fieldList">fieldList</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
<div class="inheritedList">
<h3>Fields inherited from interface&nbsp;org.apache.calcite.rel.type.<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3>
<a id="fields.inherited.from.class.org.apache.calcite.rel.type.RelDataType">
<!-- -->
</a><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 class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">RelDataTypeImpl</a></span>()</code></th>
<td class="colLast">
<div class="block">Default constructor, to allow derived classes such as
<a href="../../sql/type/BasicSqlType.html" title="class in org.apache.calcite.sql.type"><code>BasicSqlType</code></a> to be <a href="https://docs.oracle.com/javase/9/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>Serializable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.util.List)">RelDataTypeImpl</a></span>&#8203;(<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>&lt;? extends <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>&gt;&nbsp;fieldList)</code></th>
<td class="colLast">
<div class="block">Creates a RelDataTypeImpl.</div>
</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="t1" class="tableTab" onclick="show(1);">Static 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="t4" class="tableTab" onclick="show(8);">Concrete 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>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeDigest()">computeDigest</a></span>()</code></th>
<td class="colLast">
<div class="block">Computes the digest field.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(<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>&nbsp;obj)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static <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="#extra(org.apache.calcite.rel.type.RelDataType)">extra</a></span>&#8203;(<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType)</code></th>
<td class="colLast">
<div class="block">Returns the "extra" field in a row type whose presence signals that
fields will come into existence just by asking for them.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>protected abstract void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateTypeString(java.lang.StringBuilder,boolean)">generateTypeString</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink">StringBuilder</a>&nbsp;sb,
boolean&nbsp;withDetail)</code></th>
<td class="colLast">
<div class="block">Generates a string representation of this type.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code><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="rowColor" id="i5">
<td class="colFirst"><code><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="altColor" id="i6">
<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="rowColor" id="i7">
<td class="colFirst"><code><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="altColor" id="i8">
<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="rowColor" id="i9">
<td class="colFirst"><code><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>&#8203;(<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>&nbsp;fieldName,
boolean&nbsp;caseSensitive,
boolean&nbsp;elideRecord)</code></th>
<td class="colLast">
<div class="block">Looks up a field by name.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<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="rowColor" id="i11">
<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>&lt;<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>&gt;</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="altColor" id="i12">
<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>&lt;<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>&gt;</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="rowColor" id="i13">
<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="altColor" id="i14">
<td class="colFirst"><code><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="rowColor" id="i15">
<td class="colFirst"><code><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="altColor" id="i16">
<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="rowColor" id="i17">
<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="altColor" id="i18">
<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="rowColor" id="i19">
<td class="colFirst"><code><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="altColor" id="i20">
<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="rowColor" id="i21">
<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="altColor" id="i22">
<td class="colFirst"><code><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="rowColor" id="i23">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i24">
<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="i25">
<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="i26">
<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="i27">
<td class="colFirst"><code>static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proto(org.apache.calcite.rel.type.RelDataType)">proto</a></span>&#8203;(<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;protoType)</code></th>
<td class="colLast">
<div class="block">Returns an implementation of
<a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that copies a given type using the given type factory.</div>
</td>
</tr>
<tr class="altColor" id="i28">
<td class="colFirst"><code>static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proto(org.apache.calcite.sql.type.SqlTypeName,boolean)">proto</a></span>&#8203;(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;typeName,
boolean&nbsp;nullable)</code></th>
<td class="colLast">
<div class="block">Returns a <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that will create a type <code>typeName</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i29">
<td class="colFirst"><code>static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proto(org.apache.calcite.sql.type.SqlTypeName,int,boolean)">proto</a></span>&#8203;(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;typeName,
int&nbsp;precision,
boolean&nbsp;nullable)</code></th>
<td class="colLast">
<div class="block">Returns a <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that will create a type <code>typeName(precision)</code>.</div>
</td>
</tr>
<tr class="altColor" id="i30">
<td class="colFirst"><code>static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#proto(org.apache.calcite.sql.type.SqlTypeName,int,int,boolean)">proto</a></span>&#8203;(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;typeName,
int&nbsp;precision,
int&nbsp;scale,
boolean&nbsp;nullable)</code></th>
<td class="colLast">
<div class="block">Returns a <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that will create a type <code>typeName(precision, scale)</code>.</div>
</td>
</tr>
<tr class="rowColor" id="i31">
<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>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.<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></h3>
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.apache.calcite.rel.type.<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3>
<a id="methods.inherited.from.class.org.apache.calcite.rel.type.RelDataType">
<!-- -->
</a><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="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="fieldList">fieldList</a></h3>
<div class="memberSignature"><span class="modifiers">protected final</span>&nbsp;<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>&lt;<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>&gt;</span>&nbsp;<span class="memberName">fieldList</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="digest">digest</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<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>&nbsp;<span class="memberName">digest</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;(java.util.List)">RelDataTypeImpl</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="memberName">RelDataTypeImpl</span>&#8203;(<span class="arguments"><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>&lt;? extends <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>&gt;&nbsp;fieldList)</span></div>
<div class="block">Creates a RelDataTypeImpl.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldList</code> - List of fields</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">RelDataTypeImpl</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="memberName">RelDataTypeImpl</span>()</div>
<div class="block">Default constructor, to allow derived classes such as
<a href="../../sql/type/BasicSqlType.html" title="class in org.apache.calcite.sql.type"><code>BasicSqlType</code></a> to be <a href="https://docs.oracle.com/javase/9/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>Serializable</code></a>.
<p>(The serialization specification says that a class can be serializable
even if its base class is not serializable, provided that the base class
has a public or protected zero-args constructor.)</div>
</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="getField(java.lang.String,boolean,boolean)">getField</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span>&nbsp;<span class="memberName">getField</span>&#8203;(<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>&nbsp;fieldName,
boolean&nbsp;caseSensitive,
boolean&nbsp;elideRecord)</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getField(java.lang.String,boolean,boolean)">getField</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="getFieldList()">getFieldList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<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>&lt;<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>&gt;</span>&nbsp;<span class="memberName">getFieldList</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getFieldList()">getFieldList</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<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>&lt;<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>&gt;</span>&nbsp;<span class="memberName">getFieldNames</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getFieldNames()">getFieldNames</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">getFieldCount</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getFieldCount()">getFieldCount</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getStructKind()">getStructKind</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a></span>&nbsp;<span class="memberName">getStructKind</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getStructKind()">RelDataType</a></code></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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getStructKind()">getStructKind</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="getComponentType()">getComponentType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="memberName">getComponentType</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getComponentType()">RelDataType</a></code></span></div>
<div class="block">Gets the component type if this type is a collection, otherwise null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getComponentType()">getComponentType</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="memberName">getKeyType</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getKeyType()">RelDataType</a></code></span></div>
<div class="block">Gets the key type if this type is a map, otherwise null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getKeyType()">getKeyType</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="memberName">getValueType</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getValueType()">RelDataType</a></code></span></div>
<div class="block">Gets the value type if this type is a map, otherwise null.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getValueType()">getValueType</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="isStruct()">isStruct</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">isStruct</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#isStruct()">RelDataType</a></code></span></div>
<div class="block">Queries whether this is a structured type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#isStruct()">isStruct</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="equals(java.lang.Object)">equals</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">equals</span>&#8203;(<span class="arguments"><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>&nbsp;obj)</span></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#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code>&nbsp;in class&nbsp;<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>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="hashCode()">hashCode</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">hashCode</span>()</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#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code>&nbsp;in class&nbsp;<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>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getFullTypeString()">getFullTypeString</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="memberName">getFullTypeString</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getFullTypeString()">RelDataType</a></code></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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getFullTypeString()">getFullTypeString</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>full type string</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="isNullable()">isNullable</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">isNullable</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#isNullable()">RelDataType</a></code></span></div>
<div class="block">Queries whether this type allows null values.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#isNullable()">isNullable</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="getCharset()">getCharset</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><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>&nbsp;<span class="memberName">getCharset</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getCharset()">RelDataType</a></code></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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getCharset()">getCharset</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span>&nbsp;<span class="memberName">getCollation</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getCollation()">RelDataType</a></code></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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getCollation()">getCollation</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a></span>&nbsp;<span class="memberName">getIntervalQualifier</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getIntervalQualifier()">RelDataType</a></code></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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getIntervalQualifier()">getIntervalQualifier</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">getPrecision</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getPrecision()">RelDataType</a></code></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="RelDataType.html#PRECISION_NOT_SPECIFIED"><code>RelDataType.PRECISION_NOT_SPECIFIED</code></a> (-1) if precision is not
applicable for this type.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getPrecision()">getPrecision</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">getScale</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getScale()">RelDataType</a></code></span></div>
<div class="block">Gets the scale of this type. Returns <a href="RelDataType.html#SCALE_NOT_SPECIFIED"><code>RelDataType.SCALE_NOT_SPECIFIED</code></a> (-1) if
scale is not valid for this type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getScale()">getScale</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></span>&nbsp;<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.
Sub-classes must override the method to ensure the resulting value is non-nullable.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getSqlTypeName()">getSqlTypeName</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span>&nbsp;<span class="memberName">getSqlIdentifier</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getSqlIdentifier()">RelDataType</a></code></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="RelDataType.html#getSqlTypeName()"><code>RelDataType.getSqlTypeName()</code></a>. For a user-defined type, this is a compound
identifier which uniquely names the type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getSqlIdentifier()">getSqlIdentifier</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="getFamily()">getFamily</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a></span>&nbsp;<span class="memberName">getFamily</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getFamily()">getFamily</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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="generateTypeString(java.lang.StringBuilder,boolean)">generateTypeString</a></h3>
<div class="memberSignature"><span class="modifiers">protected abstract</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">generateTypeString</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink">StringBuilder</a>&nbsp;sb,
boolean&nbsp;withDetail)</span></div>
<div class="block">Generates a string representation of this type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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 class="blockList">
<section class="detail">
<h3><a id="computeDigest()">computeDigest</a></h3>
<div class="memberSignature"><span class="modifiers">protected</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">computeDigest</span>()</div>
<div class="block">Computes the digest field. This should be called in every non-abstract
subclass constructor once the type is fully defined.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="toString()">toString</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="memberName">toString</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#toString()">RelDataType</a></code></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">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#toString()">toString</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
<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>&nbsp;in class&nbsp;<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="getPrecedenceList()">getPrecedenceList</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a></span>&nbsp;<span class="memberName">getPrecedenceList</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getPrecedenceList()">RelDataType</a></code></span></div>
<div class="block">Returns the precedence list for this type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getPrecedenceList()">getPrecedenceList</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getComparability()">getComparability</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a></span>&nbsp;<span class="memberName">getComparability</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#getComparability()">RelDataType</a></code></span></div>
<div class="block">Returns the category of comparison operators that make sense when applied
to values of this type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#getComparability()">getComparability</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="proto(org.apache.calcite.rel.type.RelDataType)">proto</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></span>&nbsp;<span class="memberName">proto</span>&#8203;(<span class="arguments"><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;protoType)</span></div>
<div class="block">Returns an implementation of
<a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that copies a given type using the given type factory.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="proto(org.apache.calcite.sql.type.SqlTypeName,boolean)">proto</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></span>&nbsp;<span class="memberName">proto</span>&#8203;(<span class="arguments"><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;typeName,
boolean&nbsp;nullable)</span></div>
<div class="block">Returns a <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that will create a type <code>typeName</code>.
<p>For example, <code>proto(SqlTypeName.DATE), false</code>
will create <code>DATE NOT NULL</code>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeName</code> - Type name</dd>
<dd><code>nullable</code> - Whether nullable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Proto data type</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="proto(org.apache.calcite.sql.type.SqlTypeName,int,boolean)">proto</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></span>&nbsp;<span class="memberName">proto</span>&#8203;(<span class="arguments"><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;typeName,
int&nbsp;precision,
boolean&nbsp;nullable)</span></div>
<div class="block">Returns a <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that will create a type <code>typeName(precision)</code>.
<p>For example, <code>proto(SqlTypeName.VARCHAR, 100, false)</code>
will create <code>VARCHAR(100) NOT NULL</code>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeName</code> - Type name</dd>
<dd><code>precision</code> - Precision</dd>
<dd><code>nullable</code> - Whether nullable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Proto data type</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="proto(org.apache.calcite.sql.type.SqlTypeName,int,int,boolean)">proto</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a></span>&nbsp;<span class="memberName">proto</span>&#8203;(<span class="arguments"><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;typeName,
int&nbsp;precision,
int&nbsp;scale,
boolean&nbsp;nullable)</span></div>
<div class="block">Returns a <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type"><code>RelProtoDataType</code></a>
that will create a type <code>typeName(precision, scale)</code>.
<p>For example, <code>proto(SqlTypeName.DECIMAL, 7, 2, false)</code>
will create <code>DECIMAL(7, 2) NOT NULL</code>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeName</code> - Type name</dd>
<dd><code>precision</code> - Precision</dd>
<dd><code>scale</code> - Scale</dd>
<dd><code>nullable</code> - Whether nullable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Proto data type</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="extra(org.apache.calcite.rel.type.RelDataType)">extra</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span>&nbsp;<span class="memberName">extra</span>&#8203;(<span class="arguments"><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;rowType)</span></div>
<div class="block">Returns the "extra" field in a row type whose presence signals that
fields will come into existence just by asking for them.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rowType</code> - Row type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The "extra" field, or null</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="isDynamicStruct()">isDynamicStruct</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">isDynamicStruct</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="RelDataType.html#isDynamicStruct()">RelDataType</a></code></span></div>
<div class="block">Returns whether this type has dynamic structure (for "schema-on-read"
table).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataType.html#isDynamicStruct()">isDynamicStruct</a></code>&nbsp;in interface&nbsp;<code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd>
</dl>
</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>