| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SqlTypeCoercionRule (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SqlTypeCoercionRule (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/sql/type/SqlTypeAssignmentRule.html" title="class in org.apache.calcite.sql.type"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/sql/type/SqlTypeExplicitPrecedenceList.html" title="class in org.apache.calcite.sql.type"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/sql/type/SqlTypeCoercionRule.html" target="_top">Frames</a></li> |
| <li><a href="SqlTypeCoercionRule.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.sql.type</div> |
| <h2 title="Class SqlTypeCoercionRule" class="title">Class SqlTypeCoercionRule</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.sql.type.SqlTypeCoercionRule</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SqlTypeCoercionRule</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></pre> |
| <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="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRules.Builder.html" title="class in org.apache.calcite.sql.type"><code>SqlTypeMappingRules.Builder</code></a> instance |
| with default mappings of <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html#INSTANCE"><code>INSTANCE</code></a>.</li> |
| <li>Modify the mappings with the Builder.</li> |
| <li>Construct a new <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type"><code>SqlTypeCoercionRule</code></a> instance with method |
| <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html#instance-java.util.Map-"><code>instance(Map)</code></a>.</li> |
| <li>Set the <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type"><code>SqlTypeCoercionRule</code></a> instance into the |
| <a href="../../../../../org/apache/calcite/sql/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> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ThreadLocal.html?is-external=true" title="class or interface in java.lang">ThreadLocal</a><<a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html#THREAD_PROVIDERS">THREAD_PROVIDERS</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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="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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,com.google.common.collect.ImmutableSet<<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html#getTypeMapping--">getTypeMapping</a></span>()</code> |
| <div class="block">Returns the type mappings of this rule instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html#instance--">instance</a></span>()</code> |
| <div class="block">Returns an instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html#instance-java.util.Map-">instance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,com.google.common.collect.ImmutableSet<<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>> map)</code> |
| <div class="block">Returns an instance with specified type mappings.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.calcite.sql.type.SqlTypeMappingRule"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.calcite.sql.type.<a href="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></h3> |
| <code><a href="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRule.html#canApplyFrom-org.apache.calcite.sql.type.SqlTypeName-org.apache.calcite.sql.type.SqlTypeName-">canApplyFrom</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="THREAD_PROVIDERS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>THREAD_PROVIDERS</h4> |
| <pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ThreadLocal.html?is-external=true" title="class or interface in java.lang">ThreadLocal</a><<a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a>> THREAD_PROVIDERS</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="instance--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>instance</h4> |
| <pre>public static <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a> instance()</pre> |
| <div class="block">Returns an instance.</div> |
| </li> |
| </ul> |
| <a name="instance-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>instance</h4> |
| <pre>public static <a href="../../../../../org/apache/calcite/sql/type/SqlTypeCoercionRule.html" title="class in org.apache.calcite.sql.type">SqlTypeCoercionRule</a> instance(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,com.google.common.collect.ImmutableSet<<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>> map)</pre> |
| <div class="block">Returns an instance with specified type mappings.</div> |
| </li> |
| </ul> |
| <a name="getTypeMapping--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTypeMapping</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>,com.google.common.collect.ImmutableSet<<a href="../../../../../org/apache/calcite/sql/type/SqlTypeName.html" title="enum in org.apache.calcite.sql.type">SqlTypeName</a>>> getTypeMapping()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRule.html#getTypeMapping--">getTypeMapping</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlTypeMappingRule.html" title="interface in org.apache.calcite.sql.type">SqlTypeMappingRule</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/sql/type/SqlTypeAssignmentRule.html" title="class in org.apache.calcite.sql.type"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/sql/type/SqlTypeExplicitPrecedenceList.html" title="class in org.apache.calcite.sql.type"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/sql/type/SqlTypeCoercionRule.html" target="_top">Frames</a></li> |
| <li><a href="SqlTypeCoercionRule.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
