| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>JavaTypeFactory (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.adapter.java, interface: JavaTypeFactory"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.adapter.java</a></div> |
| <h1 title="Interface JavaTypeFactory" class="title">Interface JavaTypeFactory</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../geode/util/JavaTypeFactoryExtImpl.html" title="class in org.apache.calcite.adapter.geode.util">JavaTypeFactoryExtImpl</a></code>, <code><a href="../../jdbc/JavaTypeFactoryImpl.html" title="class in org.apache.calcite.jdbc">JavaTypeFactoryImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">JavaTypeFactory</span><span class="extends-implements"> |
| extends <a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></span></div> |
| <div class="block">Type factory that can register Java classes as record types.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.rel.type.RelDataTypeFactory">Nested classes/interfaces inherited from interface org.apache.calcite.rel.type.<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></h2> |
| <code><a href="../../rel/type/RelDataTypeFactory.Builder.html" title="class in org.apache.calcite.rel.type">RelDataTypeFactory.Builder</a>, <a href="../../rel/type/RelDataTypeFactory.FieldInfo.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory.FieldInfo</a>, <a href="../../rel/type/RelDataTypeFactory.FieldInfoBuilder.html" title="class in org.apache.calcite.rel.type">RelDataTypeFactory.FieldInfoBuilder</a></code></div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createStructType(java.lang.Class)" class="member-name-link">createStructType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> clazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a record type based upon the public fields of a Java class.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createSyntheticType(java.util.List)" class="member-name-link">createSyntheticType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a>> types)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a synthetic Java class whose fields have the given Java |
| types.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createType(java.lang.reflect.Type)" class="member-name-link">createType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a type, deducing whether a record, scalar or primitive type |
| is needed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getJavaClass(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">getJavaClass</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toSql(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">toSql</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Converts a type in Java format to a SQL-oriented type.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.rel.type.RelDataTypeFactory">Methods inherited from interface org.apache.calcite.rel.type.<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></h3> |
| <code><a href="../../rel/type/RelDataTypeFactory.html#builder()">builder</a>, <a href="../../rel/type/RelDataTypeFactory.html#copyType(org.apache.calcite.rel.type.RelDataType)">copyType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createArrayType(org.apache.calcite.rel.type.RelDataType,long)">createArrayType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createDecimalProduct(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.type.RelDataType)">createDecimalProduct</a>, <a href="../../rel/type/RelDataTypeFactory.html#createDecimalQuotient(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.type.RelDataType)">createDecimalQuotient</a>, <a href="../../rel/type/RelDataTypeFactory.html#createJavaType(java.lang.Class)">createJavaType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createJoinType(org.apache.calcite.rel.type.RelDataType...)">createJoinType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createMapType(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.type.RelDataType)">createMapType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createMeasureType(org.apache.calcite.rel.type.RelDataType)">createMeasureType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createMultisetType(org.apache.calcite.rel.type.RelDataType,long)">createMultisetType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createSqlIntervalType(org.apache.calcite.sql.SqlIntervalQualifier)">createSqlIntervalType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createSqlType(org.apache.calcite.sql.type.SqlTypeName)">createSqlType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createSqlType(org.apache.calcite.sql.type.SqlTypeName,int)">createSqlType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createSqlType(org.apache.calcite.sql.type.SqlTypeName,int,int)">createSqlType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createStructType(java.util.List)">createStructType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createStructType(java.util.List,java.util.List)">createStructType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createStructType(org.apache.calcite.rel.type.RelDataTypeFactory.FieldInfo)">createStructType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createStructType(org.apache.calcite.rel.type.StructKind,java.util.List,java.util.List)">createStructType</a>, <a href="../../rel/type/RelDataTypeFactory.html#createTypeWithCharsetAndCollation(org.apache.calcite.rel.type.RelDataType,java.nio.charset.Charset,org.apache.calcite.sql.SqlCollation)">createTypeWithCharsetAndCollation</a>, <a href="../../rel/type/RelDataTypeFactory.html#createTypeWithNullability(org.apache.calcite.rel.type.RelDataType,boolean)">createTypeWithNullability</a>, <a href="../../rel/type/RelDataTypeFactory.html#createUnknownType()">createUnknownType</a>, <a href="../../rel/type/RelDataTypeFactory.html#decimalOf(org.apache.calcite.rel.type.RelDataType)">decimalOf</a>, <a href="../../rel/type/RelDataTypeFactory.html#getDefaultCharset()">getDefaultCharset</a>, <a href="../../rel/type/RelDataTypeFactory.html#getTypeSystem()">getTypeSystem</a>, <a href="../../rel/type/RelDataTypeFactory.html#leastRestrictive(java.util.List)">leastRestrictive</a>, <a href="../../rel/type/RelDataTypeFactory.html#useDoubleMultiplication(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.type.RelDataType)">useDoubleMultiplication</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createStructType(java.lang.Class)"> |
| <h3>createStructType</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">createStructType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> clazz)</span></div> |
| <div class="block">Creates a record type based upon the public fields of a Java class.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - Java class</dd> |
| <dt>Returns:</dt> |
| <dd>Record type that remembers its Java class</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createType(java.lang.reflect.Type)"> |
| <h3>createType</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">createType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a> type)</span></div> |
| <div class="block">Creates a type, deducing whether a record, scalar or primitive type |
| is needed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - Java type, such as a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link"><code>Class</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>Record or scalar type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJavaClass(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>getJavaClass</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a></span> <span class="element-name">getJavaClass</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSyntheticType(java.util.List)"> |
| <h3>createSyntheticType</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a></span> <span class="element-name">createSyntheticType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a>> types)</span></div> |
| <div class="block">Creates a synthetic Java class whose fields have the given Java |
| types.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSql(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>toSql</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">toSql</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</span></div> |
| <div class="block">Converts a type in Java format to a SQL-oriented type.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |