Google Git
Sign in
apache / calcite-site / refs/heads/1.24 / . / javadocAggregate / org / apache / calcite / sql / SqlCollation.html
blob: a0ac8d8019ec78d14638fbb634af843d2b84a302 [file] [log] [blame]
<!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>SqlCollation (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="SqlCollation (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":9,"i6":9,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
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/SqlCharStringLiteral.html" title="class in org.apache.calcite.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/sql/SqlCollation.html" target="_top">Frames</a></li>
<li><a href="SqlCollation.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&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="subNavList">
<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>
<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</div>
<h2 title="Class SqlCollation" class="title">Class SqlCollation</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.SqlCollation</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/calcite/jdbc/JavaCollation.html" title="class in org.apache.calcite.jdbc">JavaCollation</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SqlCollation</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="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">A <code>SqlCollation</code> is an object representing a <code>Collate</code>
statement. It is immutable.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.calcite.sql.SqlCollation">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a></span></code>
<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>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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">&nbsp;</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="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#COERCIBLE">COERCIBLE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#collationName">collationName</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#IMPLICIT">IMPLICIT</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#locale">locale</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#strength">strength</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/calcite/util/SerializableCharset.html" title="class in org.apache.calcite.util">SerializableCharset</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#wrappedCharset">wrappedCharset</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#SqlCollation-org.apache.calcite.sql.SqlCollation.Coercibility-">SqlCollation</a></span>(<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</code>
<div class="block">Creates a SqlCollation with the default collation name and the given
coercibility.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#SqlCollation-org.apache.calcite.sql.SqlCollation.Coercibility-java.util.Locale-java.nio.charset.Charset-java.lang.String-">SqlCollation</a></span>(<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;strength)</code>
<div class="block">Creates a Collation by its coercibility, locale, charset and strength.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#SqlCollation-java.lang.String-org.apache.calcite.sql.SqlCollation.Coercibility-">SqlCollation</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;collation,
<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</code>
<div class="block">Creates a Collation by its name and its coercibility.</div>
</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#equals-java.lang.Object-">equals</a></span>(<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>&nbsp;o)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#generateCollationName-java.nio.charset.Charset-">generateCollationName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCharset--">getCharset</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCoercibility--">getCoercibility</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected static <a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCoercibilityDyadic-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">getCoercibilityDyadic</a></span>(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code>
<div class="block">Returns the result for <a href="../../../../org/apache/calcite/sql/SqlCollation.html#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="../../../../org/apache/calcite/sql/SqlCollation.html#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>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCoercibilityDyadicComparison-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">getCoercibilityDyadicComparison</a></span>(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code>
<div class="block">Returns the collating sequence (the collation name) to use for the
resulting value of a comparison.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCoercibilityDyadicOperator-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">getCoercibilityDyadicOperator</a></span>(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code>
<div class="block">Returns the collating sequence (the collation name) and the coercibility
for the resulting value of a dyadic operator.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCoercibilityDyadicOperatorThrows-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">getCoercibilityDyadicOperatorThrows</a></span>(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</code>
<div class="block">Returns the collating sequence (the collation name) and the coercibility
for the resulting value of a dyadic operator.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCollationName--">getCollationName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text">Collator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getCollator--">getCollator</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#getLocale--">getLocale</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlCollation.html#unparse-org.apache.calcite.sql.SqlWriter-">unparse</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>&nbsp;writer)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#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#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#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>
</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="COERCIBLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COERCIBLE</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a> COERCIBLE</pre>
</li>
</ul>
<a name="IMPLICIT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IMPLICIT</h4>
<pre>public static final&nbsp;<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a> IMPLICIT</pre>
</li>
</ul>
<a name="collationName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collationName</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> collationName</pre>
</li>
</ul>
<a name="wrappedCharset">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrappedCharset</h4>
<pre>protected final&nbsp;<a href="../../../../org/apache/calcite/util/SerializableCharset.html" title="class in org.apache.calcite.util">SerializableCharset</a> wrappedCharset</pre>
</li>
</ul>
<a name="locale">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locale</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale</pre>
</li>
</ul>
<a name="strength">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>strength</h4>
<pre>protected final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> strength</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SqlCollation-org.apache.calcite.sql.SqlCollation.Coercibility-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SqlCollation</h4>
<pre>public&nbsp;SqlCollation(<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</pre>
<div class="block">Creates a SqlCollation with the default collation name and the given
coercibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>coercibility</code> - Coercibility</dd>
</dl>
</li>
</ul>
<a name="SqlCollation-java.lang.String-org.apache.calcite.sql.SqlCollation.Coercibility-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SqlCollation</h4>
<pre>public&nbsp;SqlCollation(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;collation,
<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility)</pre>
<div class="block">Creates a Collation by its name and its coercibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collation</code> - Collation specification</dd>
<dd><code>coercibility</code> - Coercibility</dd>
</dl>
</li>
</ul>
<a name="SqlCollation-org.apache.calcite.sql.SqlCollation.Coercibility-java.util.Locale-java.nio.charset.Charset-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SqlCollation</h4>
<pre>public&nbsp;SqlCollation(<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;coercibility,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;strength)</pre>
<div class="block">Creates a Collation by its coercibility, locale, charset and strength.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<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>&nbsp;o)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="generateCollationName-java.nio.charset.Charset-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateCollationName</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;generateCollationName(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;charset)</pre>
</li>
</ul>
<a name="getCoercibilityDyadicOperator-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoercibilityDyadicOperator</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;getCoercibilityDyadicOperator(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</pre>
<div class="block">Returns the collating sequence (the collation name) and the coercibility
for the resulting value of a dyadic operator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>col1</code> - first operand for the dyadic operation</dd>
<dd><code>col2</code> - second operand for the dyadic operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resulting collation sequence. The "no collating sequence"
result is returned as null.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/calcite/util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 4.2.3 Table 2</code></a></dd>
</dl>
</li>
</ul>
<a name="getCoercibilityDyadicOperatorThrows-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoercibilityDyadicOperatorThrows</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;getCoercibilityDyadicOperatorThrows(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</pre>
<div class="block">Returns the collating sequence (the collation name) and the coercibility
for the resulting value of a dyadic operator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>col1</code> - first operand for the dyadic operation</dd>
<dd><code>col2</code> - second operand for the dyadic operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resulting collation sequence</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/calcite/runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></code> - from
<a href="../../../../org/apache/calcite/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="../../../../org/apache/calcite/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><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/calcite/util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 4.2.3 Table 2</code></a></dd>
</dl>
</li>
</ul>
<a name="getCoercibilityDyadicComparison-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoercibilityDyadicComparison</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCoercibilityDyadicComparison(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</pre>
<div class="block">Returns the collating sequence (the collation name) to use for the
resulting value of a comparison.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>col1</code> - first operand for the dyadic operation</dd>
<dd><code>col2</code> - second operand for the dyadic operation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resulting collation sequence. If no collating
sequence could be deduced throws a
<a href="../../../../org/apache/calcite/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><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/calcite/util/Glossary.html#SQL99"><code>SQL:1999 Part 2 Section 4.2.3 Table 3</code></a></dd>
</dl>
</li>
</ul>
<a name="getCoercibilityDyadic-org.apache.calcite.sql.SqlCollation-org.apache.calcite.sql.SqlCollation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoercibilityDyadic</h4>
<pre>protected static&nbsp;<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;getCoercibilityDyadic(<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col1,
<a href="../../../../org/apache/calcite/sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;col2)</pre>
<div class="block">Returns the result for <a href="../../../../org/apache/calcite/sql/SqlCollation.html#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="../../../../org/apache/calcite/sql/SqlCollation.html#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>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="unparse-org.apache.calcite.sql.SqlWriter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unparse</h4>
<pre>public&nbsp;void&nbsp;unparse(<a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>&nbsp;writer)</pre>
</li>
</ul>
<a name="getCharset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharset</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;getCharset()</pre>
</li>
</ul>
<a name="getCollationName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollationName</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCollationName()</pre>
</li>
</ul>
<a name="getCoercibility--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCoercibility</h4>
<pre>public final&nbsp;<a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql">SqlCollation.Coercibility</a>&nbsp;getCoercibility()</pre>
</li>
</ul>
<a name="getLocale--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocale</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;getLocale()</pre>
</li>
</ul>
<a name="getCollator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCollator</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text">Collator</a>&nbsp;getCollator()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text"><code>Collator</code></a> to compare values having the current collation,
or <code>null</code> if no specific <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Collator.html?is-external=true" title="class or interface in java.text"><code>Collator</code></a> is needed, in which case
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#compareTo-java.lang.String-" title="class or interface in java.lang"><code>String.compareTo(java.lang.String)</code></a> will be used.</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/SqlCharStringLiteral.html" title="class in org.apache.calcite.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/calcite/sql/SqlCollation.Coercibility.html" title="enum in org.apache.calcite.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/sql/SqlCollation.html" target="_top">Frames</a></li>
<li><a href="SqlCollation.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&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="subNavList">
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>