| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RelDataTypeImpl (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RelDataTypeImpl (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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":9,"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":10,"i28":9,"i29":9,"i30":9,"i31":9,"i32":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 = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= 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="class-use/RelDataTypeImpl.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.rel.type</a></div> |
| <h2 title="Class RelDataTypeImpl" class="title">Class RelDataTypeImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.rel.type.RelDataTypeImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <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 java.lang.Object |
| 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> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelDataTypeImpl.Slot.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl.Slot</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Work space for <a href="#getFieldRecurse(java.util.List,org.apache.calcite.rel.type.RelDataType,int,java.lang.String,boolean)"><code>getFieldRecurse(java.util.List<org.apache.calcite.rel.type.RelDataTypeImpl.Slot>, org.apache.calcite.rel.type.RelDataType, int, java.lang.String, boolean)</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <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> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#digest">digest</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected java.util.List<<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="#fieldList">fieldList</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.rel.type.RelDataType"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.calcite.rel.type.<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></h3> |
| <code><a href="RelDataType.html#PRECISION_NOT_SPECIFIED">PRECISION_NOT_SPECIFIED</a>, <a href="RelDataType.html#SCALE_NOT_SPECIFIED">SCALE_NOT_SPECIFIED</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <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 <code>Serializable</code>.</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>​(java.util.List<? extends <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>> fieldList)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a RelDataTypeImpl.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <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> |
| <tr id="i0" class="altColor"> |
| <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 id="i1" class="rowColor"> |
| <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>​(java.lang.Object obj)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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>​(<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> 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 id="i3" class="rowColor"> |
| <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>​(java.lang.StringBuilder sb, |
| boolean withDetail)</code></th> |
| <td class="colLast"> |
| <div class="block">Generates a string representation of this type.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.nio.charset.Charset</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 id="i5" class="rowColor"> |
| <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 id="i6" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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 id="i8" class="altColor"> |
| <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 id="i9" class="rowColor"> |
| <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>​(java.lang.String fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</code></th> |
| <td class="colLast"> |
| <div class="block">Looks up a field by name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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 id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<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="#getFieldList()">getFieldList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the fields in a struct type.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></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 id="i13" class="rowColor"> |
| <td class="colFirst"><code>private static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFieldRecurse(java.util.List,org.apache.calcite.rel.type.RelDataType,int,java.lang.String,boolean)">getFieldRecurse</a></span>​(java.util.List<<a href="RelDataTypeImpl.Slot.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl.Slot</a>> slots, |
| <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| int depth, |
| java.lang.String fieldName, |
| boolean caseSensitive)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</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 id="i15" class="rowColor"> |
| <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 id="i16" class="altColor"> |
| <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 id="i17" class="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <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 id="i19" class="rowColor"> |
| <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 id="i20" class="altColor"> |
| <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 id="i21" class="rowColor"> |
| <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 id="i22" class="altColor"> |
| <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 id="i23" class="rowColor"> |
| <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 id="i24" class="altColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <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"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <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 id="i27" class="rowColor"> |
| <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 id="i28" class="altColor"> |
| <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>​(<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> 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 id="i29" class="rowColor"> |
| <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>​(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> typeName, |
| boolean 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 id="i30" class="altColor"> |
| <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>​(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> typeName, |
| int precision, |
| boolean 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 id="i31" class="rowColor"> |
| <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>​(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> typeName, |
| int precision, |
| int scale, |
| boolean 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 id="i32" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</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> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="fieldList"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldList</h4> |
| <pre>protected final java.util.List<<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>> fieldList</pre> |
| </li> |
| </ul> |
| <a id="digest"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>digest</h4> |
| <pre>protected java.lang.String digest</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RelDataTypeImpl</h4> |
| <pre>protected RelDataTypeImpl​(java.util.List<? extends <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>> fieldList)</pre> |
| <div class="block">Creates a RelDataTypeImpl.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldList</code> - List of fields</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RelDataTypeImpl</h4> |
| <pre>protected RelDataTypeImpl()</pre> |
| <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 <code>Serializable</code>. |
| |
| <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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getField(java.lang.String,boolean,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getField</h4> |
| <pre class="methodSignature">public <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a> getField​(java.lang.String fieldName, |
| boolean caseSensitive, |
| boolean elideRecord)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#getField(java.lang.String,boolean,boolean)">RelDataType</a></code></span></div> |
| <div class="block">Looks up a field by name. |
| |
| <p>NOTE: Be careful choosing the value of <code>caseSensitive</code>:</p> |
| <ul> |
| <li>If the field name was supplied by an end-user (e.g. as a column alias |
| in SQL), use your session's case-sensitivity setting.</li> |
| <li>Only hard-code <code>true</code> if you are sure that the field name is |
| internally generated.</li> |
| <li>Hard-coding <code>false</code> is almost certainly wrong.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getField(java.lang.String,boolean,boolean)">getField</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><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> |
| </li> |
| </ul> |
| <a id="getFieldRecurse(java.util.List,org.apache.calcite.rel.type.RelDataType,int,java.lang.String,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldRecurse</h4> |
| <pre class="methodSignature">private static void getFieldRecurse​(java.util.List<<a href="RelDataTypeImpl.Slot.html" title="class in org.apache.calcite.rel.type">RelDataTypeImpl.Slot</a>> slots, |
| <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| int depth, |
| java.lang.String fieldName, |
| boolean caseSensitive)</pre> |
| </li> |
| </ul> |
| <a id="getFieldList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldList</h4> |
| <pre class="methodSignature">public java.util.List<<a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a>> getFieldList()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#getFieldList()">RelDataType</a></code></span></div> |
| <div class="block">Gets the fields in a struct type. The field count is equal to the size of |
| the returned list.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getFieldList()">getFieldList</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>read-only list of fields</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFieldNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldNames</h4> |
| <pre class="methodSignature">public java.util.List<java.lang.String> getFieldNames()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#getFieldNames()">RelDataType</a></code></span></div> |
| <div class="block">Returns the names of the fields in a struct type. The field count is |
| equal to the size of the returned list.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getFieldNames()">getFieldNames</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>read-only list of field names</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFieldCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFieldCount</h4> |
| <pre class="methodSignature">public int getFieldCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#getFieldCount()">RelDataType</a></code></span></div> |
| <div class="block">Returns the number of fields in a struct type. |
| |
| <p>This method is equivalent to |
| <code><a href="RelDataType.html#getFieldList()"><code>RelDataType.getFieldList()</code></a>.size()</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getFieldCount()">getFieldCount</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStructKind()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStructKind</h4> |
| <pre class="methodSignature">public <a href="StructKind.html" title="enum in org.apache.calcite.rel.type">StructKind</a> getStructKind()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getComponentType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentType</h4> |
| <pre class="methodSignature">public <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getComponentType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getKeyType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyType</h4> |
| <pre class="methodSignature">public <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getKeyType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getValueType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueType</h4> |
| <pre class="methodSignature">public <a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getValueType()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="isStruct()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isStruct</h4> |
| <pre class="methodSignature">public boolean isStruct()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#isStruct()">RelDataType</a></code></span></div> |
| <div class="block">Queries whether this is a structured type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#isStruct()">isStruct</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><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> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(java.lang.Object obj)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>equals</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getFullTypeString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFullTypeString</h4> |
| <pre class="methodSignature">public java.lang.String getFullTypeString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="isNullable()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNullable</h4> |
| <pre class="methodSignature">public boolean isNullable()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getCharset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCharset</h4> |
| <pre class="methodSignature">public java.nio.charset.Charset getCharset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getCollation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCollation</h4> |
| <pre class="methodSignature">public <a href="../../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a> getCollation()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getIntervalQualifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntervalQualifier</h4> |
| <pre class="methodSignature">public <a href="../../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a> getIntervalQualifier()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getPrecision()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrecision</h4> |
| <pre class="methodSignature">public int getPrecision()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getScale()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScale</h4> |
| <pre class="methodSignature">public int getScale()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getSqlTypeName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlTypeName</h4> |
| <pre class="methodSignature">public <a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> getSqlTypeName()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#getSqlTypeName()">RelDataType</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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getSqlTypeName()">getSqlTypeName</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SqlTypeName, or null if this is not an SQL predefined type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSqlIdentifier()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSqlIdentifier</h4> |
| <pre class="methodSignature">public <a href="../../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> getSqlIdentifier()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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> |
| </li> |
| </ul> |
| <a id="getFamily()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamily</h4> |
| <pre class="methodSignature">public <a href="RelDataTypeFamily.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFamily</a> getFamily()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="RelDataType.html#getFamily()">RelDataType</a></code></span></div> |
| <div class="block">Gets a canonical object representing the family of this type. Two values |
| can be compared if and only if their types are in the same family.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getFamily()">getFamily</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>canonical object representing type family</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="generateTypeString(java.lang.StringBuilder,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>generateTypeString</h4> |
| <pre class="methodSignature">protected abstract void generateTypeString​(java.lang.StringBuilder sb, |
| boolean withDetail)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="computeDigest()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>computeDigest</h4> |
| <pre class="methodSignature">protected void computeDigest()</pre> |
| <div class="block">Computes the digest field. This should be called in every non-abstract |
| subclass constructor once the type is fully defined.</div> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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> in interface <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>toString</code> in class <code>java.lang.Object</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>abbreviated type string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPrecedenceList()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrecedenceList</h4> |
| <pre class="methodSignature">public <a href="RelDataTypePrecedenceList.html" title="interface in org.apache.calcite.rel.type">RelDataTypePrecedenceList</a> getPrecedenceList()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getPrecedenceList()">getPrecedenceList</a></code> in interface <code><a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>precedence list for this type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComparability()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComparability</h4> |
| <pre class="methodSignature">public <a href="RelDataTypeComparability.html" title="enum in org.apache.calcite.rel.type">RelDataTypeComparability</a> getComparability()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#getComparability()">getComparability</a></code> in interface <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 category of comparison operators which make sense when |
| applied to values of this type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="proto(org.apache.calcite.rel.type.RelDataType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proto</h4> |
| <pre class="methodSignature">public static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a> proto​(<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> protoType)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="proto(org.apache.calcite.sql.type.SqlTypeName,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proto</h4> |
| <pre class="methodSignature">public static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a> proto​(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> typeName, |
| boolean nullable)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="proto(org.apache.calcite.sql.type.SqlTypeName,int,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proto</h4> |
| <pre class="methodSignature">public static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a> proto​(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> typeName, |
| int precision, |
| boolean nullable)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="proto(org.apache.calcite.sql.type.SqlTypeName,int,int,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>proto</h4> |
| <pre class="methodSignature">public static <a href="RelProtoDataType.html" title="interface in org.apache.calcite.rel.type">RelProtoDataType</a> proto​(<a href="../../sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a> typeName, |
| int precision, |
| int scale, |
| boolean nullable)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="extra(org.apache.calcite.rel.type.RelDataType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extra</h4> |
| <pre class="methodSignature">public static <a href="RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a> extra​(<a href="RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType)</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="isDynamicStruct()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isDynamicStruct</h4> |
| <pre class="methodSignature">public boolean isDynamicStruct()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="RelDataType.html#isDynamicStruct()">isDynamicStruct</a></code> in interface <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 it has dynamic structure (for "schema-on-read" table)</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <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="class-use/RelDataTypeImpl.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
