blob: 7fb77bc13565eafe322732a8af5f747baf1cd108 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SqlCollectionTypeNameSpec (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SqlCollectionTypeNameSpec (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/sql/SqlCreate.html" title="class in org.apache.calcite.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/sql/SqlCollectionTypeNameSpec.html" target="_top">Frames</a></li>
<li><a href="SqlCollectionTypeNameSpec.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.calcite.sql</div>
<h2 title="Class SqlCollectionTypeNameSpec" class="title">Class SqlCollectionTypeNameSpec</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlTypeNameSpec</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.sql.SqlCollectionTypeNameSpec</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">SqlCollectionTypeNameSpec</span>
extends <a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a></pre>
<div class="block">A sql type name specification of collection type.
<p>The grammar definition in SQL-2011 IWD 9075-2:201?(E)
6.1 &lt;collection type&gt; is as following:
<blockquote><pre>
&lt;collection type&gt; ::=
&lt;array type&gt;
| &lt;multiset type&gt;
&lt;array type&gt; ::=
&lt;data type&gt; ARRAY
[ &lt;left bracket or trigraph&gt;
&lt;maximum cardinality&gt;
&lt;right bracket or trigraph&gt; ]
&lt;maximum cardinality&gt; ::=
&lt;unsigned integer&gt;
&lt;multiset type&gt; ::=
&lt;data type&gt; MULTISET
</pre></blockquote>
<p>This class is intended to describe SQL collection type. It can describe
either simple collection type like "int array" or nested collection type like
"int array array" or "int array multiset". For nested collection type, the element type
name of this <code>SqlCollectionTypeNameSpec</code> is also a <code>SqlCollectionTypeNameSpec</code>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollectionTypeNameSpec.html#SqlCollectionTypeNameSpec-org.apache.calcite.sql.SqlTypeNameSpec-org.apache.calcite.sql.type.SqlTypeName-org.apache.calcite.sql.parser.SqlParserPos-">SqlCollectionTypeNameSpec</a></span>(<a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a>&nbsp;elementTypeName,
<a href="../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;collectionTypeName,
<a href="../../../../org/apache/calcite/sql/parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a>&nbsp;pos)</code>
<div class="block">Creates a <code>SqlCollectionTypeNameSpec</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollectionTypeNameSpec.html#deriveType-org.apache.calcite.sql.validate.SqlValidator-">deriveType</a></span>(<a href="../../../../org/apache/calcite/sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a>&nbsp;validator)</code>
<div class="block">Derive type from this SqlTypeNameSpec.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollectionTypeNameSpec.html#equalsDeep-org.apache.calcite.sql.SqlTypeNameSpec-org.apache.calcite.util.Litmus-">equalsDeep</a></span>(<a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a>&nbsp;spec,
<a href="../../../../org/apache/calcite/util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus)</code>
<div class="block">Returns whether this spec is structurally equivalent to another spec.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollectionTypeNameSpec.html#getElementTypeName--">getElementTypeName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollectionTypeNameSpec.html#unparse-org.apache.calcite.sql.SqlWriter-int-int-">unparse</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>&nbsp;writer,
int&nbsp;leftPrec,
int&nbsp;rightPrec)</code>
<div class="block">Writes a SQL representation of this spec to a writer.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.sql.SqlTypeNameSpec">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.sql.<a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a></h3>
<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#getParserPos--">getParserPos</a>, <a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#getTypeName--">getTypeName</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SqlCollectionTypeNameSpec-org.apache.calcite.sql.SqlTypeNameSpec-org.apache.calcite.sql.type.SqlTypeName-org.apache.calcite.sql.parser.SqlParserPos-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SqlCollectionTypeNameSpec</h4>
<pre>public&nbsp;SqlCollectionTypeNameSpec(<a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a>&nbsp;elementTypeName,
<a href="../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>&nbsp;collectionTypeName,
<a href="../../../../org/apache/calcite/sql/parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a>&nbsp;pos)</pre>
<div class="block">Creates a <code>SqlCollectionTypeNameSpec</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>elementTypeName</code> - Type of the collection element</dd>
<dd><code>collectionTypeName</code> - Collection type name</dd>
<dd><code>pos</code> - Parser position, must not be null</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getElementTypeName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getElementTypeName</h4>
<pre>public&nbsp;<a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a>&nbsp;getElementTypeName()</pre>
</li>
</ul>
<a name="deriveType-org.apache.calcite.sql.validate.SqlValidator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deriveType</h4>
<pre>public&nbsp;<a href="../../../../org/apache/calcite/rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;deriveType(<a href="../../../../org/apache/calcite/sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a>&nbsp;validator)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#deriveType-org.apache.calcite.sql.validate.SqlValidator-">SqlTypeNameSpec</a></code></span></div>
<div class="block">Derive type from this SqlTypeNameSpec.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#deriveType-org.apache.calcite.sql.validate.SqlValidator-">deriveType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>validator</code> - The sql validator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>RelDataType</code> instance, throws exception if we could not
deduce the type</dd>
</dl>
</li>
</ul>
<a name="unparse-org.apache.calcite.sql.SqlWriter-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unparse</h4>
<pre>public&nbsp;void&nbsp;unparse(<a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>&nbsp;writer,
int&nbsp;leftPrec,
int&nbsp;rightPrec)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#unparse-org.apache.calcite.sql.SqlWriter-int-int-">SqlTypeNameSpec</a></code></span></div>
<div class="block">Writes a SQL representation of this spec to a writer.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#unparse-org.apache.calcite.sql.SqlWriter-int-int-">unparse</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a></code></dd>
</dl>
</li>
</ul>
<a name="equalsDeep-org.apache.calcite.sql.SqlTypeNameSpec-org.apache.calcite.util.Litmus-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>equalsDeep</h4>
<pre>public&nbsp;boolean&nbsp;equalsDeep(<a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a>&nbsp;spec,
<a href="../../../../org/apache/calcite/util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#equalsDeep-org.apache.calcite.sql.SqlTypeNameSpec-org.apache.calcite.util.Litmus-">SqlTypeNameSpec</a></code></span></div>
<div class="block">Returns whether this spec is structurally equivalent to another spec.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html#equalsDeep-org.apache.calcite.sql.SqlTypeNameSpec-org.apache.calcite.util.Litmus-">equalsDeep</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/calcite/sql/SqlTypeNameSpec.html" title="class in org.apache.calcite.sql">SqlTypeNameSpec</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.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">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/sql/SqlCreate.html" title="class in org.apache.calcite.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/sql/SqlCollectionTypeNameSpec.html" target="_top">Frames</a></li>
<li><a href="SqlCollectionTypeNameSpec.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>