| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlTypeCoercionRule (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.sql.type, class: SqlTypeCoercionRule"> |
| <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>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </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.sql.type</a></div> |
| <h1 title="Class SqlTypeCoercionRule" class="title">Class SqlTypeCoercionRule</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.type.SqlTypeCoercionRule</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SqlTypeCoercionRule</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></span></div> |
| <div class="block">Rules that determine whether a type is castable from another type. |
| |
| <p>These rules specify the conversion matrix with explicit CAST. |
| |
| <p>The implicit type coercion matrix should be a sub-set of this explicit one. |
| We do not define an implicit type coercion matrix, instead we have specific |
| coercion rules for all kinds of SQL contexts which actually define the "matrix". |
| |
| <p>To add a new implementation to this class, follow |
| these steps: |
| |
| <ol> |
| <li>Initialize a <a href="SqlTypeMappingRules.Builder.html" title="class in org.apache.calcite.sql.type"><code>SqlTypeMappingRules.Builder</code></a> instance |
| with default mappings of <code>INSTANCE</code>.</li> |
| <li>Modify the mappings with the Builder.</li> |
| <li>Construct a new <a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type"><code>SqlTypeCoercionRule</code></a> instance with method |
| <a href="#instance(java.util.Map)"><code>instance(Map)</code></a>.</li> |
| <li>Set the <a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type"><code>SqlTypeCoercionRule</code></a> instance into the |
| <a href="../validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidator</code></a>.</li> |
| </ol> |
| |
| <p>The code snippet below illustrates how to implement a customized instance. |
| |
| <pre> |
| // Initialize a Builder instance with the default mappings. |
| Builder builder = SqlTypeMappingRules.builder(); |
| builder.addAll(SqlTypeCoercionRules.instance().getTypeMapping()); |
| |
| // Do the tweak, for example, if we want to add a rule to allow |
| // coerce BOOLEAN to TIMESTAMP. |
| builder.add(SqlTypeName.TIMESTAMP, |
| builder.copyValues(SqlTypeName.TIMESTAMP) |
| .add(SqlTypeName.BOOLEAN).build()); |
| |
| // Initialize a SqlTypeCoercionRules with the new builder mappings. |
| SqlTypeCoercionRules typeCoercionRules = SqlTypeCoercionRules.instance(builder.map); |
| |
| // Set the SqlTypeCoercionRules instance into the SqlValidator. |
| SqlValidator.Config validatorConf ...; |
| validatorConf.withTypeCoercionRules(typeCoercionRules); |
| // Use this conf to initialize the SqlValidator. |
| </pre></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html" title="class or interface in java.lang" class="external-link">ThreadLocal</a><@Nullable <a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#THREAD_PROVIDERS" class="member-name-link">THREAD_PROVIDERS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,<wbr>com.google.common.collect.ImmutableSet<<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTypeMapping()" class="member-name-link">getTypeMapping</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the type mappings of this rule instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#instance()" class="member-name-link">instance</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#instance(java.util.Map)" class="member-name-link">instance</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,<wbr>com.google.common.collect.ImmutableSet<<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>> map)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an instance with specified type mappings.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.type.SqlTypeMappingRule">Methods inherited from interface org.apache.calcite.sql.type.<a href="SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></h3> |
| <code><a href="SqlTypeMappingRule.html#canApplyFrom(org.apache.calcite.sql.type.SqlTypeName,org.apache.calcite.sql.type.SqlTypeName)">canApplyFrom</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="THREAD_PROVIDERS"> |
| <h3>THREAD_PROVIDERS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html" title="class or interface in java.lang" class="external-link">ThreadLocal</a><@Nullable <a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a>></span> <span class="element-name">THREAD_PROVIDERS</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="instance()"> |
| <h3>instance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a></span> <span class="element-name">instance</span>()</div> |
| <div class="block">Returns an instance.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="instance(java.util.Map)"> |
| <h3>instance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a></span> <span class="element-name">instance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,<wbr>com.google.common.collect.ImmutableSet<<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>> map)</span></div> |
| <div class="block">Returns an instance with specified type mappings.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeMapping()"> |
| <h3>getTypeMapping</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,<wbr>com.google.common.collect.ImmutableSet<<a href="SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>></span> <span class="element-name">getTypeMapping</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlTypeMappingRule.html#getTypeMapping()">SqlTypeMappingRule</a></code></span></div> |
| <div class="block">Returns the type mappings of this rule instance. |
| |
| <p>The mappings should be immutable.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlTypeMappingRule.html#getTypeMapping()">getTypeMapping</a></code> in interface <code><a href="SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></code></dd> |
| </dl> |
| </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> |
