blob: 8673fd45c1236894520aabfefac57b80c8eefdd2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelDataTypeFactoryImpl.JavaType (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: RelDataTypeFactoryImpl, class: JavaType">
<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":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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>Field&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 RelDataTypeFactoryImpl.JavaType" class="title">Class RelDataTypeFactoryImpl.JavaType</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"><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">org.apache.calcite.rel.type.RelDataTypeImpl</a>
<div class="inheritance">org.apache.calcite.rel.type.RelDataTypeFactoryImpl.JavaType</div>
</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>Enclosing class:</dt>
<dd><a href="RelDataTypeFactoryImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeFactoryImpl</a></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RelDataTypeFactoryImpl.JavaType</span>
extends <a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></pre>
<div class="block">Type which is based upon a Java class.</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="inheritedList">
<h3>Fields inherited from class&nbsp;org.apache.calcite.rel.type.<a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></h3>
<a id="fields.inherited.from.class.org.apache.calcite.rel.type.RelDataTypeImpl">
<!-- -->
</a><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="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">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class)">JavaType</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;clazz)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,boolean)">JavaType</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;clazz,
boolean&nbsp;nullable)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Class,boolean,java.nio.charset.Charset,org.apache.calcite.sql.SqlCollation)">JavaType</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;clazz,
boolean&nbsp;nullable,
@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset" class="externalLink">Charset</a>&nbsp;charset,
@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="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="#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="rowColor" id="i1">
<td class="colFirst"><code>@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset" class="externalLink">Charset</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharset()">getCharset</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets this type's character set, or null if this type cannot carry a
character set or has no character set defined.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollation()">getCollation</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets this type's collation, or null if this type cannot carry a collation
or has no collation defined.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentType()">getComponentType</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the component type if this type is a collection, otherwise null.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<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="i5">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJavaClass()">getJavaClass</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyType()">getKeyType</a></span>()</code></th>
<td class="colLast">
<div class="block">For <a href="RelDataTypeFactoryImpl.JavaType.html" title="class in org.apache.calcite.rel.type"><code>RelDataTypeFactoryImpl.JavaType</code></a> created with <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> class,
we cannot get the key type.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code><a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSqlTypeName()">getSqlTypeName</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the <a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type"><code>SqlTypeName</code></a> of this type.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>@Nullable <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueType()">getValueType</a></span>()</code></th>
<td class="colLast">
<div class="block">For <a href="RelDataTypeFactoryImpl.JavaType.html" title="class in org.apache.calcite.rel.type"><code>RelDataTypeFactoryImpl.JavaType</code></a> created with <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> class,
we cannot get the value type.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<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>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;org.apache.calcite.rel.type.<a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></h3>
<a id="methods.inherited.from.class.org.apache.calcite.rel.type.RelDataTypeImpl">
<!-- -->
</a><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#getComparability()">getComparability</a>, <a href="RelDataTypeImpl.html#getField(java.lang.String,boolean,boolean)">getField</a>, <a href="RelDataTypeImpl.html#getFieldCount()">getFieldCount</a>, <a href="RelDataTypeImpl.html#getFieldList()">getFieldList</a>, <a href="RelDataTypeImpl.html#getFieldNames()">getFieldNames</a>, <a href="RelDataTypeImpl.html#getFullTypeString()">getFullTypeString</a>, <a href="RelDataTypeImpl.html#getIntervalQualifier()">getIntervalQualifier</a>, <a href="RelDataTypeImpl.html#getPrecedenceList()">getPrecedenceList</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#hashCode()">hashCode</a>, <a href="RelDataTypeImpl.html#isDynamicStruct()">isDynamicStruct</a>, <a href="RelDataTypeImpl.html#isStruct()">isStruct</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="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">
<!-- ========= 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.lang.Class)">JavaType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">JavaType</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;clazz)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;(java.lang.Class,boolean)">JavaType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">JavaType</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;clazz,
boolean&nbsp;nullable)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;(java.lang.Class,boolean,java.nio.charset.Charset,org.apache.calcite.sql.SqlCollation)">JavaType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">JavaType</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&nbsp;clazz,
boolean&nbsp;nullable,
@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset" class="externalLink">Charset</a>&nbsp;charset,
@Nullable <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</span></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="getJavaClass()">getJavaClass</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/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a></span>&nbsp;<span class="memberName">getJavaClass</span>()</div>
</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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#isNullable()">isNullable</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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="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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getFamily()">getFamily</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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</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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#generateTypeString(java.lang.StringBuilder,boolean)">generateTypeString</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd>
<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="getComponentType()">getComponentType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">@Nullable <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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getComponentType()">getComponentType</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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">@Nullable <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">For <a href="RelDataTypeFactoryImpl.JavaType.html" title="class in org.apache.calcite.rel.type"><code>RelDataTypeFactoryImpl.JavaType</code></a> created with <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> class,
we cannot get the key type. Use ANY as key type.</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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getKeyType()">getKeyType</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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">@Nullable <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">For <a href="RelDataTypeFactoryImpl.JavaType.html" title="class in org.apache.calcite.rel.type"><code>RelDataTypeFactoryImpl.JavaType</code></a> created with <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> class,
we cannot get the value type. Use ANY as value type.</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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getValueType()">getValueType</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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="getCharset()">getCharset</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset" class="externalLink">Charset</a></span>&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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getCharset()">getCharset</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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">@Nullable <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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getCollation()">getCollation</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</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="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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<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="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="RelDataTypeImpl.html#getSqlTypeName()">getSqlTypeName</a></code>&nbsp;in class&nbsp;<code><a href="RelDataTypeImpl.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>SqlTypeName, never null</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>Field&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-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>