javadocAggregate/org/apache/calcite/sql/SqlCollation.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>SqlCollation (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, class: SqlCollation">
 <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:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.sql</a></div>
 <h1 title="Class SqlCollation" class="title">Class SqlCollation</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.SqlCollation</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="../jdbc/JavaCollation.html" title="class in org.apache.calcite.jdbc">JavaCollation</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SqlCollation</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="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div>
 <div class="block">A <code>SqlCollation</code> is an object representing a <code>Collate</code>
  statement. It is immutable.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../../../../serialized-form.html#org.apache.calcite.sql.SqlCollation">Serialized Form</a></li>
 </ul>
 </dd>
 </dl>
 </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="caption"><span>Nested Classes</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">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="SqlCollation.Coercibility.html" class="type-name-link" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A &lt;character value expression&gt; consisting of a column
  reference has the coercibility characteristic Implicit, with collating
  sequence as defined when the column was created.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- =========== 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="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></div>
 <div class="col-second even-row-color"><code><a href="#COERCIBLE" class="member-name-link">COERCIBLE</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#collationName" class="member-name-link">collationName</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>static final <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></div>
 <div class="col-second even-row-color"><code><a href="#IMPLICIT" class="member-name-link">IMPLICIT</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#locale" class="member-name-link">locale</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color"><code><a href="#strength" class="member-name-link">strength</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>protected final <a href="../util/SerializableCharset.html" title="class in org.apache.calcite.util">SerializableCharset</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#wrappedCharset" class="member-name-link">wrappedCharset</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.sql.SqlCollation.Coercibility)" class="member-name-link">SqlCollation</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;collation,
  <a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a Collation by its name and its coercibility.</div>
 </div>
 <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlCollation.Coercibility)" class="member-name-link">SqlCollation</a><wbr>(<a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</code></div>
 <div class="col-last odd-row-color">
 <div class="block">Creates a SqlCollation with the default collation name and the given
  coercibility.</div>
 </div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlCollation.Coercibility,java.util.Locale,java.nio.charset.Charset,java.lang.String)" class="member-name-link">SqlCollation</a><wbr>(<a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;strength)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a Collation by its coercibility, locale, charset and strength.</div>
 </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>boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(@Nullable <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>&nbsp;o)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateCollationName(java.nio.charset.Charset)" class="member-name-link">generateCollationName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCharset()" class="member-name-link">getCharset</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoercibility()" class="member-name-link">getCoercibility</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static @Nullable <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCoercibilityDyadic(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)" class="member-name-link">getCoercibilityDyadic</a><wbr>(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the result for <a href="#getCoercibilityDyadicComparison(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)"><code>getCoercibilityDyadicComparison(org.apache.calcite.sql.SqlCollation, org.apache.calcite.sql.SqlCollation)</code></a> and
  <a href="#getCoercibilityDyadicOperator(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)"><code>getCoercibilityDyadicOperator(org.apache.calcite.sql.SqlCollation, org.apache.calcite.sql.SqlCollation)</code></a>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCoercibilityDyadicComparison(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)" class="member-name-link">getCoercibilityDyadicComparison</a><wbr>(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the collating sequence (the collation name) to use for the
  resulting value of a comparison.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCoercibilityDyadicOperator(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)" class="member-name-link">getCoercibilityDyadicOperator</a><wbr>(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the collating sequence (the collation name) and the coercibility
  for the resulting value of a dyadic operator.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCoercibilityDyadicOperatorThrows(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)" class="member-name-link">getCoercibilityDyadicOperatorThrows</a><wbr>(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the collating sequence (the collation name) and the coercibility
  for the resulting value of a dyadic operator.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCollationName()" class="member-name-link">getCollationName</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link">Collator</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCollator()" class="member-name-link">getCollator</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link"><code>Collator</code></a> to compare values having the current
  collation, or <code>null</code> if no specific <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link"><code>Collator</code></a> is needed, in
  which case <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html#compareTo(java.lang.String)" title="class or interface in java.lang" class="external-link"><code>String.compareTo(java.lang.String)</code></a> will be used.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocale()" class="member-name-link">getLocale</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unparse(org.apache.calcite.sql.SqlWriter)" class="member-name-link">unparse</a><wbr>(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>&nbsp;writer)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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#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#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#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>
 </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="COERCIBLE">
 <h3>COERCIBLE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span>&nbsp;<span class="element-name">COERCIBLE</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="IMPLICIT">
 <h3>IMPLICIT</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span>&nbsp;<span class="element-name">IMPLICIT</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="collationName">
 <h3>collationName</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">collationName</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="wrappedCharset">
 <h3>wrappedCharset</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="../util/SerializableCharset.html" title="class in org.apache.calcite.util">SerializableCharset</a></span>&nbsp;<span class="element-name">wrappedCharset</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="locale">
 <h3>locale</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span>&nbsp;<span class="element-name">locale</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="strength">
 <h3>strength</h3>
 <div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">strength</span></div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.calcite.sql.SqlCollation.Coercibility)">
 <h3>SqlCollation</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SqlCollation</span><wbr><span class="parameters">(<a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</span></div>
 <div class="block">Creates a SqlCollation with the default collation name and the given
  coercibility.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>coercibility</code> - Coercibility</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.calcite.sql.SqlCollation.Coercibility)">
 <h3>SqlCollation</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SqlCollation</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;collation,
  <a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</span></div>
 <div class="block">Creates a Collation by its name and its coercibility.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>collation</code> - Collation specification</dd>
 <dd><code>coercibility</code> - Coercibility</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="&lt;init&gt;(org.apache.calcite.sql.SqlCollation.Coercibility,java.util.Locale,java.nio.charset.Charset,java.lang.String)">
 <h3>SqlCollation</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SqlCollation</span><wbr><span class="parameters">(<a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;strength)</span></div>
 <div class="block">Creates a Collation by its coercibility, locale, charset and strength.</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="equals(java.lang.Object)">
 <h3>equals</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(@Nullable <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>&nbsp;o)</span></div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="hashCode()">
 <h3>hashCode</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="generateCollationName(java.nio.charset.Charset)">
 <h3>generateCollationName</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">generateCollationName</span><wbr><span class="parameters">(@UnderInitialization SqlCollation&nbsp;this,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="getCoercibilityDyadicOperator(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)">
 <h3>getCoercibilityDyadicOperator</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">@Nullable <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span>&nbsp;<span class="element-name">getCoercibilityDyadicOperator</span><wbr><span class="parameters">(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</span></div>
 <div class="block">Returns the collating sequence (the collation name) and the coercibility
  for the resulting value of a dyadic operator.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>col1</code> - first operand for the dyadic operation</dd>
 <dd><code>col2</code> - second operand for the dyadic operation</dd>
 <dt>Returns:</dt>
 <dd>the resulting collation sequence. The "no collating sequence"
  result is returned as null.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 4.2.3 Table 2</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getCoercibilityDyadicOperatorThrows(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)">
 <h3>getCoercibilityDyadicOperatorThrows</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span>&nbsp;<span class="element-name">getCoercibilityDyadicOperatorThrows</span><wbr><span class="parameters">(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</span></div>
 <div class="block">Returns the collating sequence (the collation name) and the coercibility
  for the resulting value of a dyadic operator.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>col1</code> - first operand for the dyadic operation</dd>
 <dd><code>col2</code> - second operand for the dyadic operation</dd>
 <dt>Returns:</dt>
 <dd>the resulting collation sequence</dd>
 <dt>Throws:</dt>
 <dd><code><a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></code> - from
    <a href="../runtime/CalciteResource.html#invalidCompare(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"><code>CalciteResource.invalidCompare(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</code></a> or
    <a href="../runtime/CalciteResource.html#differentCollations(java.lang.String,java.lang.String)"><code>CalciteResource.differentCollations(java.lang.String, java.lang.String)</code></a>
    if no collating sequence can be deduced</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 4.2.3 Table 2</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getCoercibilityDyadicComparison(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)">
 <h3>getCoercibilityDyadicComparison</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCoercibilityDyadicComparison</span><wbr><span class="parameters">(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</span></div>
 <div class="block">Returns the collating sequence (the collation name) to use for the
  resulting value of a comparison.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>col1</code> - first operand for the dyadic operation</dd>
 <dd><code>col2</code> - second operand for the dyadic operation</dd>
 <dt>Returns:</dt>
 <dd>the resulting collation sequence. If no collating
  sequence could be deduced throws a
  <a href="../runtime/CalciteResource.html#invalidCompare(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"><code>CalciteResource.invalidCompare(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</code></a></dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list-long">
 <li><a href="../util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 4.2.3 Table 3</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getCoercibilityDyadic(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)">
 <h3>getCoercibilityDyadic</h3>
 <div class="member-signature"><span class="modifiers">protected static</span>&nbsp;<span class="return-type">@Nullable <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></span>&nbsp;<span class="element-name">getCoercibilityDyadic</span><wbr><span class="parameters">(<a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
  <a href="SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</span></div>
 <div class="block">Returns the result for <a href="#getCoercibilityDyadicComparison(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)"><code>getCoercibilityDyadicComparison(org.apache.calcite.sql.SqlCollation, org.apache.calcite.sql.SqlCollation)</code></a> and
  <a href="#getCoercibilityDyadicOperator(org.apache.calcite.sql.SqlCollation,org.apache.calcite.sql.SqlCollation)"><code>getCoercibilityDyadicOperator(org.apache.calcite.sql.SqlCollation, org.apache.calcite.sql.SqlCollation)</code></a>.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="toString()">
 <h3>toString</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="unparse(org.apache.calcite.sql.SqlWriter)">
 <h3>unparse</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">unparse</span><wbr><span class="parameters">(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>&nbsp;writer)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="getCharset()">
 <h3>getCharset</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a></span>&nbsp;<span class="element-name">getCharset</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getCollationName()">
 <h3>getCollationName</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getCollationName</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getCoercibility()">
 <h3>getCoercibility</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a></span>&nbsp;<span class="element-name">getCoercibility</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getLocale()">
 <h3>getLocale</h3>
 <div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span>&nbsp;<span class="element-name">getLocale</span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getCollator()">
 <h3>getCollator</h3>
 <div class="member-signature"><span class="annotations">@Pure
 </span><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link">Collator</a></span>&nbsp;<span class="element-name">getCollator</span>()</div>
 <div class="block">Returns the <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link"><code>Collator</code></a> to compare values having the current
  collation, or <code>null</code> if no specific <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link"><code>Collator</code></a> is needed, in
  which case <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html#compareTo(java.lang.String)" title="class or interface in java.lang" class="external-link"><code>String.compareTo(java.lang.String)</code></a> will be used.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>