<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ICU 58.2: icu::Collator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1Collator.html">Collator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">icu::Collator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code> class performs locale-sensitive string comparison.
<a href="classicu_1_1Collator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="coll_8h_source.html">coll.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::Collator:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1Collator.png" usemap="#icu::Collator_map" alt=""/>
<map id="icu::Collator_map" name="icu::Collator_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,139,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,139,24"/>
<area href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables..." alt="icu::RuleBasedCollator" shape="rect" coords="0,168,139,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a82bc20541fe4503fb78644a1968e15a2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> { <br />
  <b>PRIMARY</b> = UCOL_PRIMARY,
<b>SECONDARY</b> = UCOL_SECONDARY,
<b>TERTIARY</b> = UCOL_TERTIARY,
<b>QUATERNARY</b> = UCOL_QUATERNARY,
<br />
  <b>IDENTICAL</b> = UCOL_IDENTICAL
<br />
}<tr class="memdesc:a82bc20541fe4503fb78644a1968e15a2"><td class="mdescLeft"> </td><td class="mdescRight">Base letter represents a primary difference. <a href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a82bc20541fe4503fb78644a1968e15a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9827be018f594eae0573473034233b7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> { <b>LESS</b> = UCOL_LESS,
<b>EQUAL</b> = UCOL_EQUAL,
<b>GREATER</b> = UCOL_GREATER
}<tr class="memdesc:ac9827be018f594eae0573473034233b7"><td class="mdescLeft"> </td><td class="mdescRight">LESS is returned if source string is compared to be less than target string in the <a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">compare()</a> method. <a href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ac9827be018f594eae0573473034233b7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9c517ed7ea3633ec4e3e1fb879260cf6"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a9c517ed7ea3633ec4e3e1fb879260cf6">~Collator</a> ()</td></tr>
<tr class="memdesc:a9c517ed7ea3633ec4e3e1fb879260cf6"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a9c517ed7ea3633ec4e3e1fb879260cf6">More...</a><br /></td></tr>
<tr class="separator:a9c517ed7ea3633ec4e3e1fb879260cf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a042bb938d6eff7f670fca78e8d025500"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a042bb938d6eff7f670fca78e8d025500">operator==</a> (const <a class="el" href="classicu_1_1Collator.html">Collator</a> &other) const </td></tr>
<tr class="memdesc:a042bb938d6eff7f670fca78e8d025500"><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE if "other" is the same as "this". <a href="#a042bb938d6eff7f670fca78e8d025500">More...</a><br /></td></tr>
<tr class="separator:a042bb938d6eff7f670fca78e8d025500"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a709fc13d06f6ee45d40d21edd420434d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a709fc13d06f6ee45d40d21edd420434d">operator!=</a> (const <a class="el" href="classicu_1_1Collator.html">Collator</a> &other) const </td></tr>
<tr class="memdesc:a709fc13d06f6ee45d40d21edd420434d"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if "other" is not the same as "this". <a href="#a709fc13d06f6ee45d40d21edd420434d">More...</a><br /></td></tr>
<tr class="separator:a709fc13d06f6ee45d40d21edd420434d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a505289afa039447c0cf500558ac249e0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0">clone</a> (void) const =0</td></tr>
<tr class="memdesc:a505289afa039447c0cf500558ac249e0"><td class="mdescLeft"> </td><td class="mdescRight">Makes a copy of this object. <a href="#a505289afa039447c0cf500558ac249e0">More...</a><br /></td></tr>
<tr class="separator:a505289afa039447c0cf500558ac249e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a844bcb05f66aeaf17b2c52d8d7294d1d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d">compare</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr class="memdesc:a844bcb05f66aeaf17b2c52d8d7294d1d"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different strings. <a href="#a844bcb05f66aeaf17b2c52d8d7294d1d">More...</a><br /></td></tr>
<tr class="separator:a844bcb05f66aeaf17b2c52d8d7294d1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a832794e7b9b813d5a8f638d550cc9b2e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a832794e7b9b813d5a8f638d550cc9b2e">compare</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:a832794e7b9b813d5a8f638d550cc9b2e"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different strings. <a href="#a832794e7b9b813d5a8f638d550cc9b2e">More...</a><br /></td></tr>
<tr class="separator:a832794e7b9b813d5a8f638d550cc9b2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a186b8b940ebf5dd72bffa41bc436305c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a186b8b940ebf5dd72bffa41bc436305c">compare</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target, int32_t length) const </td></tr>
<tr class="memdesc:a186b8b940ebf5dd72bffa41bc436305c"><td class="mdescLeft"> </td><td class="mdescRight">Does the same thing as compare but limits the comparison to a specified length. <a href="#a186b8b940ebf5dd72bffa41bc436305c">More...</a><br /></td></tr>
<tr class="separator:a186b8b940ebf5dd72bffa41bc436305c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae965267bf6a4c2b7b8aeadeb30059391"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ae965267bf6a4c2b7b8aeadeb30059391">compare</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target, int32_t length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:ae965267bf6a4c2b7b8aeadeb30059391"><td class="mdescLeft"> </td><td class="mdescRight">Does the same thing as compare but limits the comparison to a specified length. <a href="#ae965267bf6a4c2b7b8aeadeb30059391">More...</a><br /></td></tr>
<tr class="separator:ae965267bf6a4c2b7b8aeadeb30059391"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdbe04d59924d1441f8476526e45d15f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#afdbe04d59924d1441f8476526e45d15f">compare</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target, int32_t targetLength) const </td></tr>
<tr class="memdesc:afdbe04d59924d1441f8476526e45d15f"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different string arrays. <a href="#afdbe04d59924d1441f8476526e45d15f">More...</a><br /></td></tr>
<tr class="separator:afdbe04d59924d1441f8476526e45d15f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f803916ef97452722dfa967e440cc20"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a1f803916ef97452722dfa967e440cc20">compare</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target, int32_t targetLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:a1f803916ef97452722dfa967e440cc20"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different string arrays. <a href="#a1f803916ef97452722dfa967e440cc20">More...</a><br /></td></tr>
<tr class="separator:a1f803916ef97452722dfa967e440cc20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e09f1d8ffc750e06c2495a5c6674669"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a9e09f1d8ffc750e06c2495a5c6674669">compare</a> (<a class="el" href="structUCharIterator.html">UCharIterator</a> &sIter, <a class="el" href="structUCharIterator.html">UCharIterator</a> &tIter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a9e09f1d8ffc750e06c2495a5c6674669"><td class="mdescLeft"> </td><td class="mdescRight">Compares two strings using the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. <a href="#a9e09f1d8ffc750e06c2495a5c6674669">More...</a><br /></td></tr>
<tr class="separator:a9e09f1d8ffc750e06c2495a5c6674669"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf276ca90c9865f59501615d3728c36f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#acf276ca90c9865f59501615d3728c36f">compareUTF8</a> (const <a class="el" href="classicu_1_1StringPiece.html">StringPiece</a> &source, const <a class="el" href="classicu_1_1StringPiece.html">StringPiece</a> &target, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:acf276ca90c9865f59501615d3728c36f"><td class="mdescLeft"> </td><td class="mdescRight">Compares two UTF-8 strings using the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. <a href="#acf276ca90c9865f59501615d3728c36f">More...</a><br /></td></tr>
<tr class="separator:acf276ca90c9865f59501615d3728c36f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1">getCollationKey</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &key, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1"><td class="mdescLeft"> </td><td class="mdescRight">Transforms the string into a series of characters that can be compared with <a class="el" href="classicu_1_1CollationKey.html#a7a171f495a64dc8bc0cebdfcf5c93980" title="Convenience method which does a string(bit-wise) comparison of the two collation keys. ">CollationKey::compareTo</a>. <a href="#ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1">More...</a><br /></td></tr>
<tr class="separator:ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0bc68d37c4a88d1cb731adaa5a85e95"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ae0bc68d37c4a88d1cb731adaa5a85e95">getCollationKey</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> &key, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:ae0bc68d37c4a88d1cb731adaa5a85e95"><td class="mdescLeft"> </td><td class="mdescRight">Transforms the string into a series of characters that can be compared with <a class="el" href="classicu_1_1CollationKey.html#a7a171f495a64dc8bc0cebdfcf5c93980" title="Convenience method which does a string(bit-wise) comparison of the two collation keys. ">CollationKey::compareTo</a>. <a href="#ae0bc68d37c4a88d1cb731adaa5a85e95">More...</a><br /></td></tr>
<tr class="separator:ae0bc68d37c4a88d1cb731adaa5a85e95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadde1f7d0f8156b9d33993aad707e7fa"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#aadde1f7d0f8156b9d33993aad707e7fa">hashCode</a> (void) const =0</td></tr>
<tr class="memdesc:aadde1f7d0f8156b9d33993aad707e7fa"><td class="mdescLeft"> </td><td class="mdescRight">Generates the hash code for the collation object. <a href="#aadde1f7d0f8156b9d33993aad707e7fa">More...</a><br /></td></tr>
<tr class="separator:aadde1f7d0f8156b9d33993aad707e7fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ce5b59d720566877b2201747782ed19"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Locale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a9ce5b59d720566877b2201747782ed19">getLocale</a> (<a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:a9ce5b59d720566877b2201747782ed19"><td class="mdescLeft"> </td><td class="mdescRight">Gets the locale of the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. <a href="#a9ce5b59d720566877b2201747782ed19">More...</a><br /></td></tr>
<tr class="separator:a9ce5b59d720566877b2201747782ed19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afce3c5befa3a044670252853a4c74fb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#afce3c5befa3a044670252853a4c74fb7">greater</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr class="memdesc:afce3c5befa3a044670252853a4c74fb7"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#afce3c5befa3a044670252853a4c74fb7">More...</a><br /></td></tr>
<tr class="separator:afce3c5befa3a044670252853a4c74fb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe57c202d01671dcad4c1bd18d2e26d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#abe57c202d01671dcad4c1bd18d2e26d7">greaterOrEqual</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr class="memdesc:abe57c202d01671dcad4c1bd18d2e26d7"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#abe57c202d01671dcad4c1bd18d2e26d7">More...</a><br /></td></tr>
<tr class="separator:abe57c202d01671dcad4c1bd18d2e26d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aceef4906764344644ea1493eb58a71b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#aceef4906764344644ea1493eb58a71b0">equals</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr class="memdesc:aceef4906764344644ea1493eb58a71b0"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#aceef4906764344644ea1493eb58a71b0">More...</a><br /></td></tr>
<tr class="separator:aceef4906764344644ea1493eb58a71b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade30058ee5084298c35554c3c496c67b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ade30058ee5084298c35554c3c496c67b">getStrength</a> (void) const </td></tr>
<tr class="memdesc:ade30058ee5084298c35554c3c496c67b"><td class="mdescLeft"> </td><td class="mdescRight">Determines the minimum strength that will be used in comparison or transformation. <a href="#ade30058ee5084298c35554c3c496c67b">More...</a><br /></td></tr>
<tr class="separator:ade30058ee5084298c35554c3c496c67b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bfd9426f93b39666975c6259fb71281"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a5bfd9426f93b39666975c6259fb71281">setStrength</a> (<a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> newStrength)</td></tr>
<tr class="memdesc:a5bfd9426f93b39666975c6259fb71281"><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum strength to be used in comparison or transformation. <a href="#a5bfd9426f93b39666975c6259fb71281">More...</a><br /></td></tr>
<tr class="separator:a5bfd9426f93b39666975c6259fb71281"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18035cc173f7253b9b778eb52e32eae3"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a18035cc173f7253b9b778eb52e32eae3">getReorderCodes</a> (int32_t *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a18035cc173f7253b9b778eb52e32eae3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reordering codes for this collator. <a href="#a18035cc173f7253b9b778eb52e32eae3">More...</a><br /></td></tr>
<tr class="separator:a18035cc173f7253b9b778eb52e32eae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0d7f72096a46f480e1cf6653a679240"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ad0d7f72096a46f480e1cf6653a679240">setReorderCodes</a> (const int32_t *reorderCodes, int32_t reorderCodesLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:ad0d7f72096a46f480e1cf6653a679240"><td class="mdescLeft"> </td><td class="mdescRight">Sets the ordering of scripts for this collator. <a href="#ad0d7f72096a46f480e1cf6653a679240">More...</a><br /></td></tr>
<tr class="separator:ad0d7f72096a46f480e1cf6653a679240"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26375fdb52b064d914b7f9861ec51236"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a26375fdb52b064d914b7f9861ec51236">getVersion</a> (<a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> info) const =0</td></tr>
<tr class="memdesc:a26375fdb52b064d914b7f9861ec51236"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version information for a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. <a href="#a26375fdb52b064d914b7f9861ec51236">More...</a><br /></td></tr>
<tr class="separator:a26375fdb52b064d914b7f9861ec51236"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bc8a1b8e65aa2444aa568e9692aed0a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a5bc8a1b8e65aa2444aa568e9692aed0a">getDynamicClassID</a> (void) const =0</td></tr>
<tr class="memdesc:a5bc8a1b8e65aa2444aa568e9692aed0a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID POLYMORPHICALLY. <a href="#a5bc8a1b8e65aa2444aa568e9692aed0a">More...</a><br /></td></tr>
<tr class="separator:a5bc8a1b8e65aa2444aa568e9692aed0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4339fbf9104428a06923a25df7ffd7f4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a4339fbf9104428a06923a25df7ffd7f4">setAttribute</a> (<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> attr, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> value, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:a4339fbf9104428a06923a25df7ffd7f4"><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute setter. <a href="#a4339fbf9104428a06923a25df7ffd7f4">More...</a><br /></td></tr>
<tr class="separator:a4339fbf9104428a06923a25df7ffd7f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3b934fb5a3a08fd8664824159c0ac91"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#aa3b934fb5a3a08fd8664824159c0ac91">getAttribute</a> (<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> attr, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:aa3b934fb5a3a08fd8664824159c0ac91"><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute getter. <a href="#aa3b934fb5a3a08fd8664824159c0ac91">More...</a><br /></td></tr>
<tr class="separator:aa3b934fb5a3a08fd8664824159c0ac91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abcd24fd37bd91f8a5fd592ad142da6f3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3">setMaxVariable</a> (<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> group, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:abcd24fd37bd91f8a5fd592ad142da6f3"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the top of the specified reordering group. <a href="#abcd24fd37bd91f8a5fd592ad142da6f3">More...</a><br /></td></tr>
<tr class="separator:abcd24fd37bd91f8a5fd592ad142da6f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04029c393f7fc6d24bf39a5a4bbd9e17"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a04029c393f7fc6d24bf39a5a4bbd9e17">getMaxVariable</a> () const </td></tr>
<tr class="memdesc:a04029c393f7fc6d24bf39a5a4bbd9e17"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. <a href="#a04029c393f7fc6d24bf39a5a4bbd9e17">More...</a><br /></td></tr>
<tr class="separator:a04029c393f7fc6d24bf39a5a4bbd9e17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af160cfa99c42483eb423ec8ea2d6abba"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#af160cfa99c42483eb423ec8ea2d6abba">setVariableTop</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *varTop, int32_t len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:af160cfa99c42483eb423ec8ea2d6abba"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the primary weight of the specified string. <a href="#af160cfa99c42483eb423ec8ea2d6abba">More...</a><br /></td></tr>
<tr class="separator:af160cfa99c42483eb423ec8ea2d6abba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d37b263e04e014ff6b13ac0d3fbbce7"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a6d37b263e04e014ff6b13ac0d3fbbce7">setVariableTop</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &varTop, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:a6d37b263e04e014ff6b13ac0d3fbbce7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the primary weight of the specified string. <a href="#a6d37b263e04e014ff6b13ac0d3fbbce7">More...</a><br /></td></tr>
<tr class="separator:a6d37b263e04e014ff6b13ac0d3fbbce7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9859bf87721ce8627d9f29d8920cd99"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ad9859bf87721ce8627d9f29d8920cd99">setVariableTop</a> (uint32_t varTop, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:ad9859bf87721ce8627d9f29d8920cd99"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the specified primary weight. <a href="#ad9859bf87721ce8627d9f29d8920cd99">More...</a><br /></td></tr>
<tr class="separator:ad9859bf87721ce8627d9f29d8920cd99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5aa9ae3225889380d10c53179e615790"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a5aa9ae3225889380d10c53179e615790">getVariableTop</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:a5aa9ae3225889380d10c53179e615790"><td class="mdescLeft"> </td><td class="mdescRight">Gets the variable top value of a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. <a href="#a5aa9ae3225889380d10c53179e615790">More...</a><br /></td></tr>
<tr class="separator:a5aa9ae3225889380d10c53179e615790"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4b6cdc4af0b4011d6867cb74f3287ce"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1UnicodeSet.html">UnicodeSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ab4b6cdc4af0b4011d6867cb74f3287ce">getTailoredSet</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:ab4b6cdc4af0b4011d6867cb74f3287ce"><td class="mdescLeft"> </td><td class="mdescRight">Get a <a class="el" href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings. ">UnicodeSet</a> that contains all the characters and sequences tailored in this collator. <a href="#ab4b6cdc4af0b4011d6867cb74f3287ce">More...</a><br /></td></tr>
<tr class="separator:ab4b6cdc4af0b4011d6867cb74f3287ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5672d9a7d5044b67a5bc9e71a051d749"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a5672d9a7d5044b67a5bc9e71a051d749">safeClone</a> (void) const </td></tr>
<tr class="memdesc:a5672d9a7d5044b67a5bc9e71a051d749"><td class="mdescLeft"> </td><td class="mdescRight">Same as <a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0" title="Makes a copy of this object. ">clone()</a>. <a href="#a5672d9a7d5044b67a5bc9e71a051d749">More...</a><br /></td></tr>
<tr class="separator:a5672d9a7d5044b67a5bc9e71a051d749"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52ca2d2de5cd75fabd4b50fe61dd0165"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a52ca2d2de5cd75fabd4b50fe61dd0165">getSortKey</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, uint8_t *result, int32_t resultLength) const =0</td></tr>
<tr class="memdesc:a52ca2d2de5cd75fabd4b50fe61dd0165"><td class="mdescLeft"> </td><td class="mdescRight">Get the sort key as an array of bytes from a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>. <a href="#a52ca2d2de5cd75fabd4b50fe61dd0165">More...</a><br /></td></tr>
<tr class="separator:a52ca2d2de5cd75fabd4b50fe61dd0165"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a180abe61e22e0b12aa352b8c15d98ade"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a180abe61e22e0b12aa352b8c15d98ade">getSortKey</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, uint8_t *result, int32_t resultLength) const =0</td></tr>
<tr class="memdesc:a180abe61e22e0b12aa352b8c15d98ade"><td class="mdescLeft"> </td><td class="mdescRight">Get the sort key as an array of bytes from a UChar buffer. <a href="#a180abe61e22e0b12aa352b8c15d98ade">More...</a><br /></td></tr>
<tr class="separator:a180abe61e22e0b12aa352b8c15d98ade"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4136c816774f41452426abd922f7ab71"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a4136c816774f41452426abd922f7ab71">setLocales</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &requestedLocale, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &validLocale, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &actualLocale)</td></tr>
<tr class="memdesc:a4136c816774f41452426abd922f7ab71"><td class="mdescLeft"> </td><td class="mdescRight">Used internally by registration to define the requested and valid locales. <a href="#a4136c816774f41452426abd922f7ab71">More...</a><br /></td></tr>
<tr class="separator:a4136c816774f41452426abd922f7ab71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a088aaea714a628362839baa4cfaa516c"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a088aaea714a628362839baa4cfaa516c">internalGetShortDefinitionString</a> (const char *locale, char *buffer, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a088aaea714a628362839baa4cfaa516c"><td class="mdescLeft"> </td><td class="mdescRight">Get the short definition string for a collator. <a href="#a088aaea714a628362839baa4cfaa516c">More...</a><br /></td></tr>
<tr class="separator:a088aaea714a628362839baa4cfaa516c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf67bb56de610c7454dbb443b5438a35"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#aaf67bb56de610c7454dbb443b5438a35">internalCompareUTF8</a> (const char *left, int32_t leftLength, const char *right, int32_t rightLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr>
<tr class="memdesc:aaf67bb56de610c7454dbb443b5438a35"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="ucol_8h.html#a3abc6779e6452106415918199308fab4" title="Compare two strings in UTF-8. ">ucol_strcollUTF8()</a>. <a href="#aaf67bb56de610c7454dbb443b5438a35">More...</a><br /></td></tr>
<tr class="separator:aaf67bb56de610c7454dbb443b5438a35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab758e7dbc5eb6ea423f9439fd89f14e7"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ab758e7dbc5eb6ea423f9439fd89f14e7">internalNextSortKeyPart</a> (<a class="el" href="structUCharIterator.html">UCharIterator</a> *iter, uint32_t state[2], uint8_t *dest, int32_t count, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr>
<tr class="memdesc:ab758e7dbc5eb6ea423f9439fd89f14e7"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="ucol_8h.html#a8c8ed92bb13577d6cd9a129b38a05d69" title="Gets the next count bytes of a sort key. ">ucol_nextSortKeyPart()</a>. <a href="#ab758e7dbc5eb6ea423f9439fd89f14e7">More...</a><br /></td></tr>
<tr class="separator:ab758e7dbc5eb6ea423f9439fd89f14e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a689c266ee05d6400ad28fe53a0454c5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a689c266ee05d6400ad28fe53a0454c5e">toUCollator</a> ()</td></tr>
<tr class="separator:a689c266ee05d6400ad28fe53a0454c5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c39895efbddc97781ed2c4c4167e4d8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a2c39895efbddc97781ed2c4c4167e4d8">toUCollator</a> () const </td></tr>
<tr class="separator:a2c39895efbddc97781ed2c4c4167e4d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr>
<tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4e6fdf681aa52573ef5ad0a0bd22eb97"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97">createInstance</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &err)</td></tr>
<tr class="memdesc:a4e6fdf681aa52573ef5ad0a0bd22eb97"><td class="mdescLeft"> </td><td class="mdescRight">Creates the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object for the current default locale. <a href="#a4e6fdf681aa52573ef5ad0a0bd22eb97">More...</a><br /></td></tr>
<tr class="separator:a4e6fdf681aa52573ef5ad0a0bd22eb97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7aa04c72be7c47935cc5c6308c0677c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#af7aa04c72be7c47935cc5c6308c0677c">createInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &loc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &err)</td></tr>
<tr class="memdesc:af7aa04c72be7c47935cc5c6308c0677c"><td class="mdescLeft"> </td><td class="mdescRight">Gets the collation object for the desired locale. <a href="#af7aa04c72be7c47935cc5c6308c0677c">More...</a><br /></td></tr>
<tr class="separator:af7aa04c72be7c47935cc5c6308c0677c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7c8befb8e7086be8fca27d23072b4d5"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#af7c8befb8e7086be8fca27d23072b4d5">getEquivalentReorderCodes</a> (int32_t reorderCode, int32_t *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:af7c8befb8e7086be8fca27d23072b4d5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reorder codes that are grouped with the given reorder code. <a href="#af7c8befb8e7086be8fca27d23072b4d5">More...</a><br /></td></tr>
<tr class="separator:af7c8befb8e7086be8fca27d23072b4d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbdfbd00fc3442fdd01b2c3519e54b3d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#afbdfbd00fc3442fdd01b2c3519e54b3d">getDisplayName</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &objectLocale, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &displayLocale, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr class="memdesc:afbdfbd00fc3442fdd01b2c3519e54b3d"><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the desired langauge. <a href="#afbdfbd00fc3442fdd01b2c3519e54b3d">More...</a><br /></td></tr>
<tr class="separator:afbdfbd00fc3442fdd01b2c3519e54b3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bbcba6a2a4437f1ef8e498ca7036681"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a0bbcba6a2a4437f1ef8e498ca7036681">getDisplayName</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &objectLocale, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr class="memdesc:a0bbcba6a2a4437f1ef8e498ca7036681"><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the langauge of the default locale. <a href="#a0bbcba6a2a4437f1ef8e498ca7036681">More...</a><br /></td></tr>
<tr class="separator:a0bbcba6a2a4437f1ef8e498ca7036681"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8860a64cf24005a2b7daefa2b3d7e84"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classicu_1_1Locale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#af8860a64cf24005a2b7daefa2b3d7e84">getAvailableLocales</a> (int32_t &count)</td></tr>
<tr class="memdesc:af8860a64cf24005a2b7daefa2b3d7e84"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Locales for which Collations are installed. <a href="#af8860a64cf24005a2b7daefa2b3d7e84">More...</a><br /></td></tr>
<tr class="separator:af8860a64cf24005a2b7daefa2b3d7e84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83bbaa40da657a056dc410a54d3b4d2f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a83bbaa40da657a056dc410a54d3b4d2f">getAvailableLocales</a> (void)</td></tr>
<tr class="memdesc:a83bbaa40da657a056dc410a54d3b4d2f"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> over the locales available at the time of the call, including registered locales. <a href="#a83bbaa40da657a056dc410a54d3b4d2f">More...</a><br /></td></tr>
<tr class="separator:a83bbaa40da657a056dc410a54d3b4d2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a223dc10a01a290aba9077ed10278eabd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a223dc10a01a290aba9077ed10278eabd">getKeywords</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a223dc10a01a290aba9077ed10278eabd"><td class="mdescLeft"> </td><td class="mdescRight">Create a string enumerator of all possible keywords that are relevant to collation. <a href="#a223dc10a01a290aba9077ed10278eabd">More...</a><br /></td></tr>
<tr class="separator:a223dc10a01a290aba9077ed10278eabd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a425557850270d5fbb2dd77bf8f2a4f19"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a425557850270d5fbb2dd77bf8f2a4f19">getKeywordValues</a> (const char *keyword, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a425557850270d5fbb2dd77bf8f2a4f19"><td class="mdescLeft"> </td><td class="mdescRight">Given a keyword, create a string enumeration of all values for that keyword that are currently in use. <a href="#a425557850270d5fbb2dd77bf8f2a4f19">More...</a><br /></td></tr>
<tr class="separator:a425557850270d5fbb2dd77bf8f2a4f19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a869f42454f0e55cf27737b14c542498f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a869f42454f0e55cf27737b14c542498f">getKeywordValuesForLocale</a> (const char *keyword, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &locale, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> commonlyUsed, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a869f42454f0e55cf27737b14c542498f"><td class="mdescLeft"> </td><td class="mdescRight">Given a key and a locale, returns an array of string values in a preferred order that would make a difference. <a href="#a869f42454f0e55cf27737b14c542498f">More...</a><br /></td></tr>
<tr class="separator:a869f42454f0e55cf27737b14c542498f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a394651828ed9f32b0ca62a0cb3069c1a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1Locale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a394651828ed9f32b0ca62a0cb3069c1a">getFunctionalEquivalent</a> (const char *keyword, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &locale, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> &isAvailable, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a394651828ed9f32b0ca62a0cb3069c1a"><td class="mdescLeft"> </td><td class="mdescRight">Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service. <a href="#a394651828ed9f32b0ca62a0cb3069c1a">More...</a><br /></td></tr>
<tr class="separator:a394651828ed9f32b0ca62a0cb3069c1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07848f613016be2dcbead263a88b7bc8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a07848f613016be2dcbead263a88b7bc8">registerInstance</a> (<a class="el" href="classicu_1_1Collator.html">Collator</a> *toAdopt, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a07848f613016be2dcbead263a88b7bc8"><td class="mdescLeft"> </td><td class="mdescRight">Register a new <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. <a href="#a07848f613016be2dcbead263a88b7bc8">More...</a><br /></td></tr>
<tr class="separator:a07848f613016be2dcbead263a88b7bc8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95e7393eab7ac7d4e8896b2a3137fb93"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a95e7393eab7ac7d4e8896b2a3137fb93">registerFactory</a> (<a class="el" href="classicu_1_1CollatorFactory.html">CollatorFactory</a> *toAdopt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a95e7393eab7ac7d4e8896b2a3137fb93"><td class="mdescLeft"> </td><td class="mdescRight">Register a new <a class="el" href="classicu_1_1CollatorFactory.html" title="A factory, used with registerFactory, the creates multiple collators and provides display names for t...">CollatorFactory</a>. <a href="#a95e7393eab7ac7d4e8896b2a3137fb93">More...</a><br /></td></tr>
<tr class="separator:a95e7393eab7ac7d4e8896b2a3137fb93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeac8f5fccf2d34f806f9cb4655f10d24"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#aeac8f5fccf2d34f806f9cb4655f10d24">unregister</a> (<a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> key, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:aeac8f5fccf2d34f806f9cb4655f10d24"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously-registered <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> or <a class="el" href="classicu_1_1CollatorFactory.html" title="A factory, used with registerFactory, the creates multiple collators and provides display names for t...">CollatorFactory</a> using the key returned from the register call. <a href="#aeac8f5fccf2d34f806f9cb4655f10d24">More...</a><br /></td></tr>
<tr class="separator:aeac8f5fccf2d34f806f9cb4655f10d24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c6cd94597a5581a40e0eb9c8ba4b3af"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a5c6cd94597a5581a40e0eb9c8ba4b3af">getBound</a> (const uint8_t *source, int32_t sourceLength, <a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">UColBoundMode</a> boundType, uint32_t noOfLevels, uint8_t *result, int32_t resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a5c6cd94597a5581a40e0eb9c8ba4b3af"><td class="mdescLeft"> </td><td class="mdescRight">Produce a bound for a given sortkey and a number of levels. <a href="#a5c6cd94597a5581a40e0eb9c8ba4b3af">More...</a><br /></td></tr>
<tr class="separator:a5c6cd94597a5581a40e0eb9c8ba4b3af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64e8727c677889abc1a2b38b0174955e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a64e8727c677889abc1a2b38b0174955e">fromUCollator</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *uc)</td></tr>
<tr class="separator:a64e8727c677889abc1a2b38b0174955e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a4a815ee9a2da4e9b9f87b905e1385e"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classicu_1_1Collator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a9a4a815ee9a2da4e9b9f87b905e1385e">fromUCollator</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *uc)</td></tr>
<tr class="separator:a9a4a815ee9a2da4e9b9f87b905e1385e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3fa9751f0fc15a504bdaa4aa22e26747"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a3fa9751f0fc15a504bdaa4aa22e26747">Collator</a> ()</td></tr>
<tr class="memdesc:a3fa9751f0fc15a504bdaa4aa22e26747"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a3fa9751f0fc15a504bdaa4aa22e26747">More...</a><br /></td></tr>
<tr class="separator:a3fa9751f0fc15a504bdaa4aa22e26747"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98c42c147eae65ccd5334f2e5ae8082e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#a98c42c147eae65ccd5334f2e5ae8082e">Collator</a> (<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> collationStrength, <a class="el" href="unorm_8h.html#af317e3ace13f0ce7c86dd1ca48490ef7">UNormalizationMode</a> decompositionMode)</td></tr>
<tr class="memdesc:a98c42c147eae65ccd5334f2e5ae8082e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a98c42c147eae65ccd5334f2e5ae8082e">More...</a><br /></td></tr>
<tr class="separator:a98c42c147eae65ccd5334f2e5ae8082e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5c82b8f9f914bdf1586e5fdf9cba3f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#af5c82b8f9f914bdf1586e5fdf9cba3f8">Collator</a> (const <a class="el" href="classicu_1_1Collator.html">Collator</a> &other)</td></tr>
<tr class="memdesc:af5c82b8f9f914bdf1586e5fdf9cba3f8"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#af5c82b8f9f914bdf1586e5fdf9cba3f8">More...</a><br /></td></tr>
<tr class="separator:af5c82b8f9f914bdf1586e5fdf9cba3f8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ab6a9dabbbc5633905fce8c282b031ffc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6a9dabbbc5633905fce8c282b031ffc"></a>
class </td><td class="memItemRight" valign="bottom"><b>CFactory</b></td></tr>
<tr class="separator:ab6a9dabbbc5633905fce8c282b031ffc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80bbb65f28838eba42b00d611909e8d3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80bbb65f28838eba42b00d611909e8d3"></a>
class </td><td class="memItemRight" valign="bottom"><b>SimpleCFactory</b></td></tr>
<tr class="separator:a80bbb65f28838eba42b00d611909e8d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbce2a122c7c040633075706b9867183"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbce2a122c7c040633075706b9867183"></a>
class </td><td class="memItemRight" valign="bottom"><b>ICUCollatorFactory</b></td></tr>
<tr class="separator:adbce2a122c7c040633075706b9867183"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49f66cb9f432dd77eefae3d1ecaeb9f5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a49f66cb9f432dd77eefae3d1ecaeb9f5"></a>
class </td><td class="memItemRight" valign="bottom"><b>ICUCollatorService</b></td></tr>
<tr class="separator:a49f66cb9f432dd77eefae3d1ecaeb9f5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code> class performs locale-sensitive string comparison. </p>
<p><br />
You use this class to build searching and sorting routines for natural language text. </p>
<p><code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code> is an abstract base class. Subclasses implement specific collation strategies. One subclass, <code><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables...">RuleBasedCollator</a></code>, is currently provided and is applicable to a wide set of languages. Other subclasses may be created to handle more specialized needs. </p>
<p>Like other locale-sensitive classes, you can use the static factory method, <code>createInstance</code>, to obtain the appropriate <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code> object for a given locale. You will only need to look at the subclasses of <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code> if you need to understand the details of a particular collation strategy or if you need to modify that strategy. </p>
<p>The following example shows how to compare two strings using the <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code> for the default locale. <blockquote> </p><pre>
<div class="fragment"><div class="line"><span class="comment">// Compare two strings in the default locale</span></div><div class="line"><a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> success = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;</div><div class="line"><a class="code" href="classicu_1_1Collator.html#a3fa9751f0fc15a504bdaa4aa22e26747">Collator</a>* myCollator = <a class="code" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97">Collator::createInstance</a>(success);</div><div class="line"><span class="keywordflow">if</span> (myCollator->compare(<span class="stringliteral">"abc"</span>, <span class="stringliteral">"ABC"</span>) < 0)</div><div class="line"> cout << <span class="stringliteral">"abc is less than ABC"</span> << endl;</div><div class="line"><span class="keywordflow">else</span></div><div class="line"> cout << <span class="stringliteral">"abc is greater than or equal to ABC"</span> << endl;</div></div><!-- fragment -->
</pre><p> </blockquote> </p>
<p>You can set a <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code>'s <em>strength</em> attribute to determine the level of difference considered significant in comparisons. Five strengths are provided: <code>PRIMARY</code>, <code>SECONDARY</code>, <code>TERTIARY</code>, <code>QUATERNARY</code> and <code>IDENTICAL</code>. The exact assignment of strengths to language features is locale dependent. For example, in Czech, "e" and "f" are considered primary differences, while "e" and "\u00EA" are secondary differences, "e" and "E" are tertiary differences and "e" and "e" are identical. The following shows how both case and accents could be ignored for US English. <blockquote> </p><pre>
<div class="fragment"><div class="line"><span class="comment">//Get the Collator for US English and set its strength to PRIMARY</span></div><div class="line"><a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> success = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;</div><div class="line"><a class="code" href="classicu_1_1Collator.html#a3fa9751f0fc15a504bdaa4aa22e26747">Collator</a>* usCollator = <a class="code" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97">Collator::createInstance</a>(<a class="code" href="classicu_1_1Locale.html#a7804339f41684082ea10671ab70db23c">Locale::getUS</a>(), success);</div><div class="line">usCollator->setStrength(Collator::PRIMARY);</div><div class="line"><span class="keywordflow">if</span> (usCollator->compare(<span class="stringliteral">"abc"</span>, <span class="stringliteral">"ABC"</span>) == 0)</div><div class="line"> cout << <span class="stringliteral">"'abc' and 'ABC' strings are equivalent with strength PRIMARY"</span> << endl;</div></div><!-- fragment -->
</pre><p> </blockquote></p>
<p>The <code>getSortKey</code> methods convert a string to a series of bytes that can be compared bitwise against other sort keys using <code>strcmp()</code>. Sort keys are written as zero-terminated byte strings.</p>
<p>Another set of APIs returns a <code><a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class. ">CollationKey</a></code> object that wraps the sort key bytes instead of returning the bytes themselves. </p>
<p><b>Note:</b> <code><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a></code>s with different <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, and CollationStrength settings will return different sort orders for the same set of strings. Locales have specific collation rules, and the way in which secondary and tertiary differences are taken into account, for example, will result in a different sorting order for same strings. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the implementation of Collator, using data-driven tables...">RuleBasedCollator</a> </dd>
<dd>
<a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class. ">CollationKey</a> </dd>
<dd>
<a class="el" href="classicu_1_1CollationElementIterator.html" title="The CollationElementIterator class is used as an iterator to walk through each character of an intern...">CollationElementIterator</a> </dd>
<dd>
<a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a> </dd>
<dd>
<a class="el" href="classicu_1_1Normalizer.html" title="Old Unicode normalization API. ">Normalizer</a> </dd></dl>
<dl class="section version"><dt>Version</dt><dd>2.0 11/15/01 </dd></dl>
<p>Definition at line <a class="el" href="coll_8h_source.html#l00165">165</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a82bc20541fe4503fb78644a1968e15a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">icu::Collator::ECollationStrength</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Base letter represents a primary difference. </p>
<p>Set comparison level to PRIMARY to ignore secondary and tertiary differences.<br />
Use this to set the strength of a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object.<br />
Example of primary difference, "abc" < "abd"</p>
<p>Diacritical differences on the same base letter represent a secondary difference. Set comparison level to SECONDARY to ignore tertiary differences. Use this to set the strength of a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object.<br />
Example of secondary difference, "&auml;" >> "a".</p>
<p>Uppercase and lowercase versions of the same character represents a tertiary difference. Set comparison level to TERTIARY to include all comparison differences. Use this to set the strength of a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object.<br />
Example of tertiary difference, "abc" <<< "ABC".</p>
<p>Two characters are considered "identical" when they have the same unicode spellings.<br />
For example, "&auml;" == "&auml;".</p>
<p>UCollationStrength is also used to determine the strength of sort keys generated from <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> objects. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable003180">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="coll_8h_source.html#l00195">195</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac9827be018f594eae0573473034233b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">icu::Collator::EComparisonResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>LESS is returned if source string is compared to be less than target string in the <a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">compare()</a> method. </p>
<p>EQUAL is returned if source string is compared to be equal to target string in the <a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">compare()</a> method. GREATER is returned if source string is compared to be greater than target string in the <a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">compare()</a> method. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">Collator::compare</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000333">Deprecated:</a></b></dt><dd>ICU 2.6. Use C enum UCollationResult defined in <a class="el" href="ucol_8h.html" title="C API: Collator. ">ucol.h</a> </dd></dl>
<p>Definition at line <a class="el" href="coll_8h_source.html#l00217">217</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9c517ed7ea3633ec4e3e1fb879260cf6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::Collator::~Collator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003181">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a3fa9751f0fc15a504bdaa4aa22e26747"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">icu::Collator::Collator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Constructor is different from the old default <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> constructor. The task for determing the default collation strength and normalization mode is left to the child class. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable003223">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a98c42c147eae65ccd5334f2e5ae8082e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">icu::Collator::Collator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> </td>
<td class="paramname"><em>collationStrength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unorm_8h.html#af317e3ace13f0ce7c86dd1ca48490ef7">UNormalizationMode</a> </td>
<td class="paramname"><em>decompositionMode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Empty constructor, does not handle the arguments. This constructor is done for backward compatibility with 1.7 and 1.8. The task for handling the argument collation strength and normalization mode is left to the child class. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">collationStrength</td><td>collation strength </td></tr>
<tr><td class="paramname">decompositionMode</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000344">Deprecated:</a></b></dt><dd>ICU 2.4. Subclasses should use the default constructor instead and handle the strength and normalization mode themselves. </dd></dl>
</div>
</div>
<a class="anchor" id="af5c82b8f9f914bdf1586e5fdf9cba3f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">icu::Collator::Collator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Collator.html">Collator</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object to be copied from </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003224">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a505289afa039447c0cf500558ac249e0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::Collator::clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a copy of this object. </p>
<dl class="section return"><dt>Returns</dt><dd>a copy of this object, owned by the caller </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003184">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a34a873f2ec25d787bf6f123d27221e73">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a844bcb05f66aeaf17b2c52d8d7294d1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The comparison function compares the character data stored in two different strings. </p>
<p>Returns information about whether a string is less than, greater than or equal to another string. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the string that is to be compared with the source string. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a byte value. GREATER if source is greater than target; EQUAL if source is equal to target; LESS if source is less than target </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000334">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with UErrorCode & </dd></dl>
</div>
</div>
<a class="anchor" id="a832794e7b9b813d5a8f638d550cc9b2e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The comparison function compares the character data stored in two different strings. </p>
<p>Returns information about whether a string is less than, greater than or equal to another string. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the string that is to be compared with the source string. </td></tr>
<tr><td class="paramname">status</td><td>possible error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an enum value. UCOL_GREATER if source is greater than target; UCOL_EQUAL if source is equal to target; UCOL_LESS if source is less than target </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003187">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a6eeec5e18d8f24b737bf814dcd3b8613">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a186b8b940ebf5dd72bffa41bc436305c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Does the same thing as compare but limits the comparison to a specified length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the string that is to be compared with the source string. </td></tr>
<tr><td class="paramname">length</td><td>the length the comparison is limited to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a byte value. GREATER if source (up to the specified length) is greater than target; EQUAL if source (up to specified length) is equal to target; LESS if source (up to the specified length) is less than target. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000335">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with UErrorCode & </dd></dl>
</div>
</div>
<a class="anchor" id="ae965267bf6a4c2b7b8aeadeb30059391"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Does the same thing as compare but limits the comparison to a specified length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the string that is to be compared with the source string. </td></tr>
<tr><td class="paramname">length</td><td>the length the comparison is limited to </td></tr>
<tr><td class="paramname">status</td><td>possible error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an enum value. UCOL_GREATER if source (up to the specified length) is greater than target; UCOL_EQUAL if source (up to specified length) is equal to target; UCOL_LESS if source (up to the specified length) is less than target. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003188">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#adb572c11065328b5bf608bc541fcb5f8">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="afdbe04d59924d1441f8476526e45d15f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7">EComparisonResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The comparison function compares the character data stored in two different string arrays. </p>
<p>Returns information about whether a string array is less than, greater than or equal to another string array. </p>
<p>Example of use: </p><pre>
. UChar ABC[] = {0x41, 0x42, 0x43, 0}; // = "ABC"
. UChar abc[] = {0x61, 0x62, 0x63, 0}; // = "abc"
. UErrorCode status = U_ZERO_ERROR;
. <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> *myCollation =
. Collator::createInstance(Locale::getUS(), status);
. if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure? ">U_FAILURE(status)</a>) return;
. myCollation->setStrength(Collator::PRIMARY);
. // result would be Collator::EQUAL ("abc" == "ABC")
. // (no primary difference between "abc" and "ABC")
. <a class="el" href="classicu_1_1Collator.html#ac9827be018f594eae0573473034233b7" title="LESS is returned if source string is compared to be less than target string in the compare() method...">Collator::EComparisonResult</a> result =
. myCollation->compare(abc, 3, ABC, 3);
. myCollation->setStrength(Collator::TERTIARY);
. // result would be Collator::LESS ("abc" <<< "ABC")
. // (with tertiary difference between "abc" and "ABC")
. result = myCollation->compare(abc, 3, ABC, 3);
</pre> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string array to be compared with. </td></tr>
<tr><td class="paramname">sourceLength</td><td>the length of the source string array. If this value is equal to -1, the string array is null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>the string that is to be compared with the source string. </td></tr>
<tr><td class="paramname">targetLength</td><td>the length of the target string array. If this value is equal to -1, the string array is null-terminated. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a byte value. GREATER if source is greater than target; EQUAL if source is equal to target; LESS if source is less than target </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000336">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with UErrorCode & </dd></dl>
</div>
</div>
<a class="anchor" id="a1f803916ef97452722dfa967e440cc20"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The comparison function compares the character data stored in two different string arrays. </p>
<p>Returns information about whether a string array is less than, greater than or equal to another string array. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string array to be compared with. </td></tr>
<tr><td class="paramname">sourceLength</td><td>the length of the source string array. If this value is equal to -1, the string array is null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>the string that is to be compared with the source string. </td></tr>
<tr><td class="paramname">targetLength</td><td>the length of the target string array. If this value is equal to -1, the string array is null-terminated. </td></tr>
<tr><td class="paramname">status</td><td>possible error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an enum value. UCOL_GREATER if source is greater than target; UCOL_EQUAL if source is equal to target; UCOL_LESS if source is less than target </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003189">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a56f2e30d640188a6183f371318c18771">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a9e09f1d8ffc750e06c2495a5c6674669"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::Collator::compare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUCharIterator.html">UCharIterator</a> & </td>
<td class="paramname"><em>sIter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUCharIterator.html">UCharIterator</a> & </td>
<td class="paramname"><em>tIter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two strings using the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. </p>
<p>Returns whether the first one compares less than/equal to/greater than the second one. This version takes <a class="el" href="structUCharIterator.html" title="C API for code unit iteration. ">UCharIterator</a> input. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sIter</td><td>the first ("source") string iterator </td></tr>
<tr><td class="paramname">tIter</td><td>the second ("target") string iterator </td></tr>
<tr><td class="paramname">status</td><td>ICU status </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>UCOL_LESS, UCOL_EQUAL or UCOL_GREATER </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003190">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#ad95b78164d063cacee6938f18cca179b">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="acf276ca90c9865f59501615d3728c36f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::Collator::compareUTF8 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1StringPiece.html">StringPiece</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1StringPiece.html">StringPiece</a> & </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two UTF-8 strings using the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. </p>
<p>Returns whether the first one compares less than/equal to/greater than the second one. This version takes UTF-8 input. Note that a <a class="el" href="classicu_1_1StringPiece.html" title="A string-like object that points to a sized piece of memory. ">StringPiece</a> can be implicitly constructed from a std::string or a NUL-terminated const char * string. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the first UTF-8 string </td></tr>
<tr><td class="paramname">target</td><td>the second UTF-8 string </td></tr>
<tr><td class="paramname">status</td><td>ICU status </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>UCOL_LESS, UCOL_EQUAL or UCOL_GREATER </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003191">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a2a05d340b15ffe6763ef0b9d9f87e777">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a4e6fdf681aa52573ef5ad0a0bd22eb97"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::Collator::createInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object for the current default locale. </p>
<p>The default locale is determined by <a class="el" href="classicu_1_1Locale.html#a020c6966493a8f00572616b64b5527c3" title="Common methods of getting the current default Locale. ">Locale::getDefault</a>. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>the error code status. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the collation object of the default locale.(for example, en_US) </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Locale.html#a020c6966493a8f00572616b64b5527c3" title="Common methods of getting the current default Locale. ">Locale::getDefault</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003185">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af7aa04c72be7c47935cc5c6308c0677c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::Collator::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>err</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the collation object for the desired locale. </p>
<p>The resource of the desired locale will be loaded.</p>
<p><a class="el" href="classicu_1_1Locale.html#a1c046c2b7ca76f96e869cef9576880a7" title="Useful constant for the Root locale. ">Locale::getRoot()</a> is the base collation table and all other languages are built on top of it with additional language-specific modifications.</p>
<p>For some languages, multiple collation types are available; for example, "de@collation=phonebook". Starting with ICU 54, collation attributes can be specified via locale keywords as well, in the old locale extension syntax ("el@colCaseFirst=upper") or in language tag syntax ("el-u-kf-upper"). See <a href="http://userguide.icu-project.org/collation/api">User Guide: Collation API</a>.</p>
<p>The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found.</p>
<p>The caller owns the returned object and is responsible for deleting it. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>The locale ID for which to open a collator. </td></tr>
<tr><td class="paramname">err</td><td>the error code status. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the created table-based collation object based on the desired locale. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a> </dd>
<dd>
ResourceLoader </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003186">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aceef4906764344644ea1493eb58a71b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Collator::equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method for comparing two strings based on the collation rules. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the target string to be compared with. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the strings are equal according to the collation rules. false, otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">Collator::compare</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003197">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a64e8727c677889abc1a2b38b0174955e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::Collator::fromUCollator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>uc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000292">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
<p>Definition at line <a class="el" href="coll_8h_source.html#l01166">1166</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
<p>Referenced by <a class="el" href="tblcoll_8h_source.html#l00780">icu::RuleBasedCollator::rbcFromUCollator()</a>.</p>
</div>
</div>
<a class="anchor" id="a9a4a815ee9a2da4e9b9f87b905e1385e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::Collator::fromUCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>uc</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000293">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
<p>Definition at line <a class="el" href="coll_8h_source.html#l01170">1170</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa3b934fb5a3a08fd8664824159c0ac91"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> icu::Collator::getAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Universal attribute getter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>attribute type </td></tr>
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>attribute value </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003215">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a5035222b203536bb351ac2af4bf06a3b">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="af8860a64cf24005a2b7daefa2b3d7e84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classicu_1_1Locale.html">Locale</a>* icu::Collator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype">int32_t & </td>
<td class="paramname"><em>count</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set of Locales for which Collations are installed. </p>
<p>Note this does not include locales supported by registered collators. If collators might have been registered, use the overload of getAvailableLocales that returns a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>the output parameter of number of elements in the locale list </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the list of available locales for which collations are installed </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003203">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a83bbaa40da657a056dc410a54d3b4d2f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Collator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> over the locales available at the time of the call, including registered locales. </p>
<p>If a severe error occurs (such as out of memory condition) this will return null. If there is no locale data, an empty enumeration will be returned. </p><dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> over the locales available at the time of the call </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003204">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a5c6cd94597a5581a40e0eb9c8ba4b3af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int32_t icu::Collator::getBound </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">UColBoundMode</a> </td>
<td class="paramname"><em>boundType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>noOfLevels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produce a bound for a given sortkey and a number of levels. </p>
<p>Return value is always the number of bytes needed, regardless of whether the result buffer was big enough or even valid.<br />
Resulting bounds can be used to produce a range of strings that are between upper and lower bounds. For example, if bounds are produced for a sortkey of string "smith", strings between upper and lower bounds with one level would include "Smith", "SMITH", "sMiTh".<br />
There are two upper bounds that can be produced. If UCOL_BOUND_UPPER is produced, strings matched would be as above. However, if bound produced using UCOL_BOUND_UPPER_LONG is used, the above example will also match "Smithsonian" and similar.<br />
For more on usage, see example in cintltst/capitst.c in procedure TestBounds. Sort keys may be compared using <code>strcmp</code>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The source sortkey. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. (If an unmodified sortkey is passed, it is always null terminated). </td></tr>
<tr><td class="paramname">boundType</td><td>Type of bound required. It can be UCOL_BOUND_LOWER, which produces a lower inclusive bound, UCOL_BOUND_UPPER, that produces upper bound that matches strings of the same length or UCOL_BOUND_UPPER_LONG that matches strings that have the same starting substring as the source string. </td></tr>
<tr><td class="paramname">noOfLevels</td><td>Number of levels required in the resulting bound (for most uses, the recommended value is 1). See users guide for explanation on number of levels a sortkey can have. </td></tr>
<tr><td class="paramname">result</td><td>A pointer to a buffer to receive the resulting sortkey. </td></tr>
<tr><td class="paramname">resultLength</td><td>The maximum size of result. </td></tr>
<tr><td class="paramname">status</td><td>Used for returning error code if something went wrong. If the number of levels requested is higher than the number of levels in the source key, a warning (U_SORT_KEY_TOO_SHORT_WARNING) is issued. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The size needed to fully store the bound. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucoleitr_8h.html#a705331b3ca250e3f5f74accfee861fa4" title="get a hash code for a key... ">ucol_keyHashCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003222">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a>& icu::Collator::getCollationKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transforms the string into a series of characters that can be compared with <a class="el" href="classicu_1_1CollationKey.html#a7a171f495a64dc8bc0cebdfcf5c93980" title="Convenience method which does a string(bit-wise) comparison of the two collation keys. ">CollationKey::compareTo</a>. </p>
<p>It is not possible to restore the original string from the chars in the sort key. </p>
<p>Use CollationKey::equals or CollationKey::compare to compare the generated sort keys. If the source string is null, a null collation key will be returned.</p>
<p>Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be transformed into a sort key. </td></tr>
<tr><td class="paramname">key</td><td>the collation key to be filled in </td></tr>
<tr><td class="paramname">status</td><td>the error code status. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the collation key of the string based on the collation rules. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>CollationKey::compare </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003192">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a065e4823a0517d59c8558993c57e6915">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="ae0bc68d37c4a88d1cb731adaa5a85e95"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1CollationKey.html">CollationKey</a>& icu::Collator::getCollationKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1CollationKey.html">CollationKey</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transforms the string into a series of characters that can be compared with <a class="el" href="classicu_1_1CollationKey.html#a7a171f495a64dc8bc0cebdfcf5c93980" title="Convenience method which does a string(bit-wise) comparison of the two collation keys. ">CollationKey::compareTo</a>. </p>
<p>It is not possible to restore the original string from the chars in the sort key. </p>
<p>Use CollationKey::equals or CollationKey::compare to compare the generated sort keys. </p>
<p>If the source string is null, a null collation key will be returned.</p>
<p>Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be transformed into a sort key. </td></tr>
<tr><td class="paramname">sourceLength</td><td>length of the collation key </td></tr>
<tr><td class="paramname">key</td><td>the collation key to be filled in </td></tr>
<tr><td class="paramname">status</td><td>the error code status. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the collation key of the string based on the collation rules. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>CollationKey::compare </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003193">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a715637af0c17ba697e3263c34a0b4f08">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="afbdfbd00fc3442fdd01b2c3519e54b3d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::Collator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the desired langauge. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">objectLocale</td><td>must be from getAvailableLocales </td></tr>
<tr><td class="paramname">displayLocale</td><td>specifies the desired locale for output </td></tr>
<tr><td class="paramname">name</td><td>the fill-in parameter of the return value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>display-able name of the object for the object locale in the desired language </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003201">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0bbcba6a2a4437f1ef8e498ca7036681"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::Collator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the langauge of the default locale. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">objectLocale</td><td>must be from getAvailableLocales </td></tr>
<tr><td class="paramname">name</td><td>the fill-in parameter of the return value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>name of the object for the desired locale in the default language </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003202">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5bc8a1b8e65aa2444aa568e9692aed0a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::Collator::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a unique class ID POLYMORPHICALLY. </p>
<p>Pure virtual method. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic <a class="el" href="classicu_1_1Collator.html#a042bb938d6eff7f670fca78e8d025500" title="Returns TRUE if "other" is the same as "this". ">operator==()</a> and <a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0" title="Makes a copy of this object. ">clone()</a> methods call this method. </p><dl class="section return"><dt>Returns</dt><dd>The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003213">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">icu::UObject</a>.</p>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#aff44758642ebb0b39afa8cc2fc832a49">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="af7c8befb8e7086be8fca27d23072b4d5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int32_t icu::Collator::getEquivalentReorderCodes </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>reorderCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the reorder codes that are grouped with the given reorder code. </p>
<p>Some reorder codes will be grouped and must reorder together. Beginning with ICU 55, scripts only reorder together if they are primary-equal, for example Hiragana and Katakana.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reorderCode</td><td>The reorder code to determine equivalence for. </td></tr>
<tr><td class="paramname">dest</td><td>The array to fill with the script equivalence reordering codes. </td></tr>
<tr><td class="paramname">destCapacity</td><td>The length of dest. If it is 0, then dest may be NULL and the function will only return the length of the result without writing any codes (pre-flighting). </td></tr>
<tr><td class="paramname">status</td><td>A reference to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the of the reordering code equivalence array. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3" title="Sets the reordering codes for this collator. ">ucol_setReorderCodes</a> </dd>
<dd>
<a class="el" href="classicu_1_1Collator.html#a18035cc173f7253b9b778eb52e32eae3" title="Retrieves the reordering codes for this collator. ">Collator::getReorderCodes</a> </dd>
<dd>
<a class="el" href="classicu_1_1Collator.html#ad0d7f72096a46f480e1cf6653a679240" title="Sets the ordering of scripts for this collator. ">Collator::setReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887" title="Enum containing the codes for reordering segments of the collation table that are not script codes...">UColReorderCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003200">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a394651828ed9f32b0ca62a0cb3069c1a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1Locale.html">Locale</a> icu::Collator::getFunctionalEquivalent </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>keyword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> & </td>
<td class="paramname"><em>isAvailable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service. </p>
<p>If two locales return the same result, then collators instantiated for these locales will behave equivalently. The converse is not always true; two collators may in fact be equivalent, but return different results, due to internal details. The return result has no other meaning than that stated above, and implies nothing as to the relationship between the two locales. This is intended for use by applications who wish to cache collators, or otherwise reuse collators when possible. The functional equivalent may change over time. For more information, please see the <a href="http://userguide.icu-project.org/locale#TOC-Locales-and-Services">Locales and Services</a> section of the ICU User Guide. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyword</td><td>a particular keyword as enumerated by ucol_getKeywords. </td></tr>
<tr><td class="paramname">locale</td><td>the requested locale </td></tr>
<tr><td class="paramname">isAvailable</td><td>reference to a fillin parameter that indicates whether the requested locale was 'available' to the collation service. A locale is defined as 'available' if it physically exists within the collation locale data. </td></tr>
<tr><td class="paramname">status</td><td>reference to input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the functionally equivalent collation locale, or the root locale upon error. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003208">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a223dc10a01a290aba9077ed10278eabd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Collator::getKeywords </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string enumerator of all possible keywords that are relevant to collation. </p>
<p>At this point, the only recognized keyword for this service is "collation". </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over locale strings. The caller is responsible for closing the result. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003205">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a425557850270d5fbb2dd77bf8f2a4f19"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Collator::getKeywordValues </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>keyword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given a keyword, create a string enumeration of all values for that keyword that are currently in use. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyword</td><td>a particular keyword as enumerated by ucol_getKeywords. If any other keyword is passed in, status is set to U_ILLEGAL_ARGUMENT_ERROR. </td></tr>
<tr><td class="paramname">status</td><td>input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over collation keyword values, or NULL upon error. The caller is responsible for deleting the result. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003206">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a869f42454f0e55cf27737b14c542498f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Collator::getKeywordValuesForLocale </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>keyword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>commonlyUsed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given a key and a locale, returns an array of string values in a preferred order that would make a difference. </p>
<p>These are all and only those values where the open (creation) of the service with the locale formed from the input locale plus input keyword and that value has different behavior than creation with the input locale alone. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyword</td><td>one of the keys supported by this service. For now, only "collation" is supported. </td></tr>
<tr><td class="paramname">locale</td><td>the locale </td></tr>
<tr><td class="paramname">commonlyUsed</td><td>if set to true it will return only commonly used values with the given locale in preferred order. Otherwise, it will return all the available values for the locale. </td></tr>
<tr><td class="paramname">status</td><td>ICU status </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over keyword values for the given key and the locale. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003207">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a9ce5b59d720566877b2201747782ed19"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Locale.html">Locale</a> icu::Collator::getLocale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the locale of the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>can be either requested, valid or actual locale. For more information see the definition of ULocDataLocaleType in <a class="el" href="uloc_8h.html" title="C API: Locale. ">uloc.h</a> </td></tr>
<tr><td class="paramname">status</td><td>the error code status. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>locale where the collation data lives. If the collator was instantiated from rules, locale is empty. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000337">Deprecated:</a></b></dt><dd>ICU 2.8 This API is under consideration for revision in ICU 3.0. </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a94aa71dbacf10077ed13a84bfe87ef95">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a04029c393f7fc6d24bf39a5a4bbd9e17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> icu::Collator::getMaxVariable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. </p>
<p>The base class implementation returns UCOL_REORDER_CODE_PUNCTUATION. </p><dl class="section return"><dt>Returns</dt><dd>the maximum variable reordering group. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003217">Stable:</a></b></dt><dd>ICU 53 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a2cf313cfa977ed08dd8566234dfbf81c">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a18035cc173f7253b9b778eb52e32eae3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::Collator::getReorderCodes </td>
<td>(</td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the reordering codes for this collator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dest</td><td>The array to fill with the script ordering. </td></tr>
<tr><td class="paramname">destCapacity</td><td>The length of dest. If it is 0, then dest may be NULL and the function will only return the length of the result without writing any codes (pre-flighting). </td></tr>
<tr><td class="paramname">status</td><td>A reference to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the script ordering array. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3" title="Sets the reordering codes for this collator. ">ucol_setReorderCodes</a> </dd>
<dd>
<a class="el" href="classicu_1_1Collator.html#af7c8befb8e7086be8fca27d23072b4d5" title="Retrieves the reorder codes that are grouped with the given reorder code. ">Collator::getEquivalentReorderCodes</a> </dd>
<dd>
<a class="el" href="classicu_1_1Collator.html#ad0d7f72096a46f480e1cf6653a679240" title="Sets the ordering of scripts for this collator. ">Collator::setReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887" title="Enum containing the codes for reordering segments of the collation table that are not script codes...">UColReorderCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003198">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#af5e6d4c602e2699dae1ed9cba31df959">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a52ca2d2de5cd75fabd4b50fe61dd0165"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::Collator::getSortKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the sort key as an array of bytes from a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a>. </p>
<p>Sort key byte arrays are zero-terminated and can be compared using strcmp().</p>
<p>Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>string to be processed. </td></tr>
<tr><td class="paramname">result</td><td>buffer to store result in. If NULL, number of bytes needed will be returned. </td></tr>
<tr><td class="paramname">resultLength</td><td>length of the result buffer. If if not enough the buffer will be filled to capacity. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes needed for storing the sort key </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003220">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a0b1365bfa196f979480d96250ed4b5e7">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a180abe61e22e0b12aa352b8c15d98ade"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::Collator::getSortKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the sort key as an array of bytes from a UChar buffer. </p>
<p>Sort key byte arrays are zero-terminated and can be compared using strcmp().</p>
<p>Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>string to be processed. </td></tr>
<tr><td class="paramname">sourceLength</td><td>length of string to be processed. If -1, the string is 0 terminated and length will be decided by the function. </td></tr>
<tr><td class="paramname">result</td><td>buffer to store result in. If NULL, number of bytes needed will be returned. </td></tr>
<tr><td class="paramname">resultLength</td><td>length of the result buffer. If if not enough the buffer will be filled to capacity. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes needed for storing the sort key </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003221">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a1acd4527bc89dbed7a7e270a68baa44c">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="ade30058ee5084298c35554c3c496c67b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> icu::Collator::getStrength </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the minimum strength that will be used in comparison or transformation. </p>
<p>E.g. with strength == SECONDARY, the tertiary difference is ignored </p>
<p>E.g. with strength == PRIMARY, the secondary and tertiary difference are ignored. </p><dl class="section return"><dt>Returns</dt><dd>the current comparison level. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a5bfd9426f93b39666975c6259fb71281" title="Sets the minimum strength to be used in comparison or transformation. ">Collator::setStrength</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000338">Deprecated:</a></b></dt><dd>ICU 2.6 Use getAttribute(UCOL_STRENGTH...) instead </dd></dl>
</div>
</div>
<a class="anchor" id="ab4b6cdc4af0b4011d6867cb74f3287ce"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1UnicodeSet.html">UnicodeSet</a>* icu::Collator::getTailoredSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a <a class="el" href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings. ">UnicodeSet</a> that contains all the characters and sequences tailored in this collator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>error code of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to a <a class="el" href="classicu_1_1UnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings. ">UnicodeSet</a> object containing all the code points and sequences that may sort differently than in the root collator. The object must be disposed of by using delete </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003219">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a5eca3366d198d8de015bdf3a94b942c7">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a5aa9ae3225889380d10c53179e615790"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t icu::Collator::getVariableTop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the variable top value of a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>error code (not changed by function). If error code is set, the return value is undefined. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the variable top primary weight </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a04029c393f7fc6d24bf39a5a4bbd9e17" title="Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. ">getMaxVariable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003218">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a3eb6f150fd7ad705f218c66b9f95969e">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a26375fdb52b064d914b7f9861ec51236"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::Collator::getVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the version information for a <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>the version # information, the result will be filled in </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003212">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a3ced1d9d5a8cbb570f777082f8866da6">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="afce3c5befa3a044670252853a4c74fb7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Collator::greater </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method for comparing two strings based on the collation rules. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the target string to be compared with. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the first string is greater than the second one, according to the collation rules. false, otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">Collator::compare</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003195">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="abe57c202d01671dcad4c1bd18d2e26d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Collator::greaterOrEqual </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>target</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience method for comparing two strings based on the collation rules. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string to be compared with. </td></tr>
<tr><td class="paramname">target</td><td>the target string to be compared with. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the first string is greater than or equal to the second one, according to the collation rules. false, otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a844bcb05f66aeaf17b2c52d8d7294d1d" title="The comparison function compares the character data stored in two different strings. ">Collator::compare</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003196">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aadde1f7d0f8156b9d33993aad707e7fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::Collator::hashCode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates the hash code for the collation object. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003194">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a50ce8abfb26982673ec73c5135186193">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="aaf67bb56de610c7454dbb443b5438a35"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> icu::Collator::internalCompareUTF8 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>leftLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>right</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>rightLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="ucol_8h.html#a3abc6779e6452106415918199308fab4" title="Compare two strings in UTF-8. ">ucol_strcollUTF8()</a>. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000290">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a7d5eef2975f299e17cec9123ca5aeb06">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a088aaea714a628362839baa4cfaa516c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::Collator::internalGetShortDefinitionString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the short definition string for a collator. </p>
<p>This internal API harvests the collator's locale and the attribute set and produces a string that can be used for opening a collator with the same attributes using the ucol_openFromShortString API. This string will be normalized. The structure and the syntax of the string is defined in the "Naming collators" section of the users guide: <a href="http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme">http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme</a> This function supports preflighting.</p>
<p>This is internal, and intended to be used with delegate converters.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">locale</td><td>a locale that will appear as a collators locale in the resulting short string definition. If NULL, the locale will be harvested from the collator. </td></tr>
<tr><td class="paramname">buffer</td><td>space to hold the resulting string </td></tr>
<tr><td class="paramname">capacity</td><td>capacity of the buffer </td></tr>
<tr><td class="paramname">status</td><td>for returning errors. All the preflighting errors are featured </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>length of the resulting string </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucol_8h.html#a39ccd61fb814dc0d2e759bc0cfe4c80d" title="Open a collator defined by a short form string. ">ucol_openFromShortString</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a4527a9eefdd7e071fff9d87b2e418cfa" title="Verifies and normalizes short definition string. ">ucol_normalizeShortDefinitionString</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a762daeafd0df7cc65fd120a1e802cbbe" title="Get the short definition string for a collator. ">ucol_getShortDefinitionString</a> </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000289">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a3711f954bab897ce6eaa9ff681bc41ec">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="ab758e7dbc5eb6ea423f9439fd89f14e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::Collator::internalNextSortKeyPart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUCharIterator.html">UCharIterator</a> * </td>
<td class="paramname"><em>iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>state</em>[2], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="ucol_8h.html#a8c8ed92bb13577d6cd9a129b38a05d69" title="Gets the next count bytes of a sort key. ">ucol_nextSortKeyPart()</a>. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000291">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a46612988b52b4b7a2e2e67c4ec1a2f79">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a709fc13d06f6ee45d40d21edd420434d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Collator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Collator.html">Collator</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if "other" is not the same as "this". </p>
<p>Calls ! <a class="el" href="classicu_1_1Collator.html#a042bb938d6eff7f670fca78e8d025500" title="Returns TRUE if "other" is the same as "this". ">operator==(const Collator&) const </a>which works for all subclasses. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object to be compared </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if other is not the same as this. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003183">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a042bb938d6eff7f670fca78e8d025500"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Collator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Collator.html">Collator</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns TRUE if "other" is the same as "this". </p>
<p>The base class implementation returns TRUE if "other" has the same type/class as "this": <code>typeid(*this) == typeid(other)</code>.</p>
<p>Subclass implementations should do something like the following: </p><pre>
if (this == &other) { return TRUE; }
if (!Collator::operator==(other)) { return FALSE; } // not the same class</pre><pre> const MyCollator &o = (const MyCollator&)other;
(compare this vs. o's subclass fields)
</pre> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> object to be compared </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if other is the same as this. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003182">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a0fd2ca09264d26f3067522ce03ec4c92">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a95e7393eab7ac7d4e8896b2a3137fb93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> icu::Collator::registerFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1CollatorFactory.html">CollatorFactory</a> * </td>
<td class="paramname"><em>toAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a new <a class="el" href="classicu_1_1CollatorFactory.html" title="A factory, used with registerFactory, the creates multiple collators and provides display names for t...">CollatorFactory</a>. </p>
<p>The factory will be adopted. Because ICU may choose to cache collators internally, this must be called at application startup, prior to any calls to <a class="el" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97" title="Creates the Collator object for the current default locale. ">Collator::createInstance</a> to avoid undefined behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toAdopt</td><td>the <a class="el" href="classicu_1_1CollatorFactory.html" title="A factory, used with registerFactory, the creates multiple collators and provides display names for t...">CollatorFactory</a> instance to be adopted </td></tr>
<tr><td class="paramname">status</td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a registry key that can be used to unregister this collator </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003210">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a07848f613016be2dcbead263a88b7bc8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> icu::Collator::registerInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1Collator.html">Collator</a> * </td>
<td class="paramname"><em>toAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a new <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a>. </p>
<p>The collator will be adopted. Because ICU may choose to cache collators internally, this must be called at application startup, prior to any calls to <a class="el" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97" title="Creates the Collator object for the current default locale. ">Collator::createInstance</a> to avoid undefined behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toAdopt</td><td>the <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> instance to be adopted </td></tr>
<tr><td class="paramname">locale</td><td>the locale with which the collator will be associated </td></tr>
<tr><td class="paramname">status</td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a registry key that can be used to unregister this collator </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003209">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a5672d9a7d5044b67a5bc9e71a051d749"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a>* icu::Collator::safeClone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Same as <a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0" title="Makes a copy of this object. ">clone()</a>. </p>
<p>The base class implementation simply calls <a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0" title="Makes a copy of this object. ">clone()</a>. </p><dl class="section return"><dt>Returns</dt><dd>a copy of this object, owned by the caller </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0" title="Makes a copy of this object. ">clone()</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000343">Deprecated:</a></b></dt><dd>ICU 50 no need to have two methods for cloning </dd></dl>
</div>
</div>
<a class="anchor" id="a4339fbf9104428a06923a25df7ffd7f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::Collator::setAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Universal attribute setter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">attr</td><td>attribute type </td></tr>
<tr><td class="paramname">value</td><td>attribute value </td></tr>
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003214">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a53cc1952b0c7a8689e0f3fb86aee02d4">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a4136c816774f41452426abd922f7ab71"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::Collator::setLocales </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>requestedLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>validLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>actualLocale</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used internally by registration to define the requested and valid locales. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">requestedLocale</td><td>the requested locale </td></tr>
<tr><td class="paramname">validLocale</td><td>the valid locale </td></tr>
<tr><td class="paramname">actualLocale</td><td>the actual locale </td></tr>
</table>
</dd>
</dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000288">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a4b5d90263cb69f616175d275c6757748">icu::RuleBasedCollator</a>.</p>
<p>Referenced by <a class="el" href="tblcoll_8h_source.html#l00784">icu::RuleBasedCollator::rbcFromUCollator()</a>.</p>
</div>
</div>
<a class="anchor" id="abcd24fd37bd91f8a5fd592ad142da6f3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classicu_1_1Collator.html">Collator</a>& icu::Collator::setMaxVariable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to the top of the specified reordering group. </p>
<p>The variable top determines the highest-sorting character which is affected by UCOL_ALTERNATE_HANDLING. If that attribute is set to UCOL_NON_IGNORABLE, then the variable top has no effect.</p>
<p>The base class implementation sets U_UNSUPPORTED_ERROR. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">group</td><td>one of UCOL_REORDER_CODE_SPACE, UCOL_REORDER_CODE_PUNCTUATION, UCOL_REORDER_CODE_SYMBOL, UCOL_REORDER_CODE_CURRENCY; or UCOL_REORDER_CODE_DEFAULT to restore the default max variable group </td></tr>
<tr><td class="paramname">errorCode</td><td>Standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure? ">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>*this </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#a04029c393f7fc6d24bf39a5a4bbd9e17" title="Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. ">getMaxVariable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003216">Stable:</a></b></dt><dd>ICU 53 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a6ca034ec0bfada94f52f9b17a0bebef1">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="ad0d7f72096a46f480e1cf6653a679240"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::Collator::setReorderCodes </td>
<td>(</td>
<td class="paramtype">const int32_t * </td>
<td class="paramname"><em>reorderCodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>reorderCodesLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the ordering of scripts for this collator. </p>
<p>The reordering codes are a combination of script codes and reorder codes. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reorderCodes</td><td>An array of script codes in the new order. This can be NULL if the length is also set to 0. An empty array will clear any reordering codes on the collator. </td></tr>
<tr><td class="paramname">reorderCodesLength</td><td>The length of reorderCodes. </td></tr>
<tr><td class="paramname">status</td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3" title="Sets the reordering codes for this collator. ">ucol_setReorderCodes</a> </dd>
<dd>
<a class="el" href="classicu_1_1Collator.html#a18035cc173f7253b9b778eb52e32eae3" title="Retrieves the reordering codes for this collator. ">Collator::getReorderCodes</a> </dd>
<dd>
<a class="el" href="classicu_1_1Collator.html#af7c8befb8e7086be8fca27d23072b4d5" title="Retrieves the reorder codes that are grouped with the given reorder code. ">Collator::getEquivalentReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887" title="Enum containing the codes for reordering segments of the collation table that are not script codes...">UColReorderCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003199">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a1f76d6e957f2c441129e0170c9c6f89a">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a5bfd9426f93b39666975c6259fb71281"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::Collator::setStrength </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> </td>
<td class="paramname"><em>newStrength</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the minimum strength to be used in comparison or transformation. </p>
<p>Example of use: </p><pre>
<div class="fragment"><div class="line"><a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> status = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;</div><div class="line"><a class="code" href="classicu_1_1Collator.html#a3fa9751f0fc15a504bdaa4aa22e26747">Collator</a>*myCollation = <a class="code" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97">Collator::createInstance</a>(<a class="code" href="classicu_1_1Locale.html#a7804339f41684082ea10671ab70db23c">Locale::getUS</a>(), status);</div><div class="line"><span class="keywordflow">if</span> (<a class="code" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f">U_FAILURE</a>(status)) <span class="keywordflow">return</span>;</div><div class="line">myCollation->setStrength(Collator::PRIMARY);</div><div class="line"><span class="comment">// result will be "abc" == "ABC"</span></div><div class="line"><span class="comment">// tertiary differences will be ignored</span></div><div class="line">Collator::ComparisonResult result = myCollation->compare(<span class="stringliteral">"abc"</span>, <span class="stringliteral">"ABC"</span>);</div></div><!-- fragment -->
</pre> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Collator.html#ade30058ee5084298c35554c3c496c67b" title="Determines the minimum strength that will be used in comparison or transformation. ">Collator::getStrength</a> </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newStrength</td><td>the new comparison level. </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000339">Deprecated:</a></b></dt><dd>ICU 2.6 Use setAttribute(UCOL_STRENGTH...) instead </dd></dl>
</div>
</div>
<a class="anchor" id="af160cfa99c42483eb423ec8ea2d6abba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t icu::Collator::setVariableTop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>varTop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to the primary weight of the specified string. </p>
<p>Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. See <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">varTop</td><td>one or more (if contraction) UChars to which the variable top should be set </td></tr>
<tr><td class="paramname">len</td><td>length of variable top string. If -1 it is considered to be zero terminated. </td></tr>
<tr><td class="paramname">status</td><td>error code. If error code is set, the return value is undefined. Errors set by this function are: <br />
U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such contraction<br />
U_ILLEGAL_ARGUMENT_ERROR if the variable top is beyond the last reordering group supported by <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>variable top primary weight </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000340">Deprecated:</a></b></dt><dd>ICU 53 Call <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a> instead. </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#af703942fc0754b7cc7f9da288f34ac30">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a6d37b263e04e014ff6b13ac0d3fbbce7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t icu::Collator::setVariableTop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>varTop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to the primary weight of the specified string. </p>
<p>Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. See <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">varTop</td><td>a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> size 1 or more (if contraction) of UChars to which the variable top should be set </td></tr>
<tr><td class="paramname">status</td><td>error code. If error code is set, the return value is undefined. Errors set by this function are: <br />
U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such contraction<br />
U_ILLEGAL_ARGUMENT_ERROR if the variable top is beyond the last reordering group supported by <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>variable top primary weight </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000341">Deprecated:</a></b></dt><dd>ICU 53 Call <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a> instead. </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a5b5d17deba77715b3c153e0bc8d2d593">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="ad9859bf87721ce8627d9f29d8920cd99"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::Collator::setVariableTop </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>varTop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to the specified primary weight. </p>
<p>Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. See <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a>. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">varTop</td><td>primary weight, as returned by setVariableTop or ucol_getVariableTop </td></tr>
<tr><td class="paramname">status</td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000342">Deprecated:</a></b></dt><dd>ICU 53 Call <a class="el" href="classicu_1_1Collator.html#abcd24fd37bd91f8a5fd592ad142da6f3" title="Sets the variable top to the top of the specified reordering group. ">setMaxVariable()</a> instead. </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a1c068986eae08c7274ff1c6fd5d0d61f">icu::RuleBasedCollator</a>.</p>
</div>
</div>
<a class="anchor" id="a689c266ee05d6400ad28fe53a0454c5e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* icu::Collator::toUCollator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000294">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
<p>Definition at line <a class="el" href="coll_8h_source.html#l01174">1174</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2c39895efbddc97781ed2c4c4167e4d8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* icu::Collator::toUCollator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000295">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
<p>Definition at line <a class="el" href="coll_8h_source.html#l01178">1178</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeac8f5fccf2d34f806f9cb4655f10d24"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Collator::unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister a previously-registered <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison. ">Collator</a> or <a class="el" href="classicu_1_1CollatorFactory.html" title="A factory, used with registerFactory, the creates multiple collators and provides display names for t...">CollatorFactory</a> using the key returned from the register call. </p>
<p>Key becomes invalid after a successful call and should not be used again. The object corresponding to the key will be deleted. Because ICU may choose to cache collators internally, this should be called during application shutdown, after all calls to <a class="el" href="classicu_1_1Collator.html#a4e6fdf681aa52573ef5ad0a0bd22eb97" title="Creates the Collator object for the current default locale. ">Collator::createInstance</a> to avoid undefined behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the registry key returned by a previous call to registerInstance </td></tr>
<tr><td class="paramname">status</td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the collator for the key was successfully unregistered </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003211">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="coll_8h_source.html">coll.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
71
