<!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"/>
<title>ICU 52.1: icu::RuleBasedCollator 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 style="padding-left: 0.5em;">
<div id="projectname">ICU 52.1
 <span id="projectnumber">52.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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_1RuleBasedCollator.html">RuleBasedCollator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<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::RuleBasedCollator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> class provides the simple implementation of <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a>, using data-driven tables.
<a href="classicu_1_1RuleBasedCollator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="tblcoll_8h_source.html">tblcoll.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::RuleBasedCollator:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1RuleBasedCollator.png" usemap="#icu::RuleBasedCollator_map" alt=""/>
<map id="icu::RuleBasedCollator_map" name="icu::RuleBasedCollator_map">
<area href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison." alt="icu::Collator" shape="rect" coords="0,112,139,136"/>
<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"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab26b8846a053c2def598ec7c957cfcc4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#ab26b8846a053c2def598ec7c957cfcc4">RuleBasedCollator</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &rules, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:ab26b8846a053c2def598ec7c957cfcc4"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. <a href="#ab26b8846a053c2def598ec7c957cfcc4"></a><br/></td></tr>
<tr class="memitem:aaf9a00014372009c71cd36430da4f610"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#aaf9a00014372009c71cd36430da4f610">RuleBasedCollator</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &rules, <a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> collationStrength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:aaf9a00014372009c71cd36430da4f610"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. <a href="#aaf9a00014372009c71cd36430da4f610"></a><br/></td></tr>
<tr class="memitem:a07b23add8f39b6d2dd6d608ac9485b97"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a07b23add8f39b6d2dd6d608ac9485b97">RuleBasedCollator</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &rules, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> decompositionMode, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a07b23add8f39b6d2dd6d608ac9485b97"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. <a href="#a07b23add8f39b6d2dd6d608ac9485b97"></a><br/></td></tr>
<tr class="memitem:a29e95021c2a9acf1fced334f57c074ba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a29e95021c2a9acf1fced334f57c074ba">RuleBasedCollator</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &rules, <a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> collationStrength, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> decompositionMode, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a29e95021c2a9acf1fced334f57c074ba"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. <a href="#a29e95021c2a9acf1fced334f57c074ba"></a><br/></td></tr>
<tr class="memitem:ad60f53ba1323a3516edf93154006d91c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#ad60f53ba1323a3516edf93154006d91c">RuleBasedCollator</a> (const <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> &other)</td></tr>
<tr class="memdesc:ad60f53ba1323a3516edf93154006d91c"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ad60f53ba1323a3516edf93154006d91c"></a><br/></td></tr>
<tr class="memitem:a2f4c7eeaf020ad68e3bd9722dd272357"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a2f4c7eeaf020ad68e3bd9722dd272357">RuleBasedCollator</a> (const uint8_t *bin, int32_t length, const <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> *base, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a2f4c7eeaf020ad68e3bd9722dd272357"><td class="mdescLeft"> </td><td class="mdescRight">Opens a collator from a collator binary image created using cloneBinary. <a href="#a2f4c7eeaf020ad68e3bd9722dd272357"></a><br/></td></tr>
<tr class="memitem:a7f0ee2464acb12f597680df69a69d97d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a7f0ee2464acb12f597680df69a69d97d">~RuleBasedCollator</a> ()</td></tr>
<tr class="memdesc:a7f0ee2464acb12f597680df69a69d97d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a7f0ee2464acb12f597680df69a69d97d"></a><br/></td></tr>
<tr class="memitem:a1a977c57fe95e8d7121fd899cefd1af8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a1a977c57fe95e8d7121fd899cefd1af8">operator=</a> (const <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> &other)</td></tr>
<tr class="memdesc:a1a977c57fe95e8d7121fd899cefd1af8"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a1a977c57fe95e8d7121fd899cefd1af8"></a><br/></td></tr>
<tr class="memitem:a0fd2ca09264d26f3067522ce03ec4c92"><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_1RuleBasedCollator.html#a0fd2ca09264d26f3067522ce03ec4c92">operator==</a> (const <a class="el" href="classicu_1_1Collator.html">Collator</a> &other) const </td></tr>
<tr class="memdesc:a0fd2ca09264d26f3067522ce03ec4c92"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if argument is the same as this object. <a href="#a0fd2ca09264d26f3067522ce03ec4c92"></a><br/></td></tr>
<tr class="memitem:a34a873f2ec25d787bf6f123d27221e73"><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_1RuleBasedCollator.html#a34a873f2ec25d787bf6f123d27221e73">clone</a> (void) const </td></tr>
<tr class="memdesc:a34a873f2ec25d787bf6f123d27221e73"><td class="mdescLeft"> </td><td class="mdescRight">Makes a copy of this object. <a href="#a34a873f2ec25d787bf6f123d27221e73"></a><br/></td></tr>
<tr class="memitem:ad69ff21358c28b238f6a23ef8b6fd9c4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1CollationElementIterator.html">CollationElementIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#ad69ff21358c28b238f6a23ef8b6fd9c4">createCollationElementIterator</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source) const </td></tr>
<tr class="memdesc:ad69ff21358c28b238f6a23ef8b6fd9c4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a collation element iterator for the source string. <a href="#ad69ff21358c28b238f6a23ef8b6fd9c4"></a><br/></td></tr>
<tr class="memitem:afdbd1b7ba2a7efe051e3f411dd422db1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1CollationElementIterator.html">CollationElementIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#afdbd1b7ba2a7efe051e3f411dd422db1">createCollationElementIterator</a> (const <a class="el" href="classicu_1_1CharacterIterator.html">CharacterIterator</a> &source) const </td></tr>
<tr class="memdesc:afdbd1b7ba2a7efe051e3f411dd422db1"><td class="mdescLeft"> </td><td class="mdescRight">Creates a collation element iterator for the source. <a href="#afdbd1b7ba2a7efe051e3f411dd422db1"></a><br/></td></tr>
<tr class="memitem:a6eeec5e18d8f24b737bf814dcd3b8613"><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_1RuleBasedCollator.html#a6eeec5e18d8f24b737bf814dcd3b8613">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 </td></tr>
<tr class="memdesc:a6eeec5e18d8f24b737bf814dcd3b8613"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different strings. <a href="#a6eeec5e18d8f24b737bf814dcd3b8613"></a><br/></td></tr>
<tr class="memitem:adb572c11065328b5bf608bc541fcb5f8"><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_1RuleBasedCollator.html#adb572c11065328b5bf608bc541fcb5f8">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 </td></tr>
<tr class="memdesc:adb572c11065328b5bf608bc541fcb5f8"><td class="mdescLeft"> </td><td class="mdescRight">Does the same thing as compare but limits the comparison to a specified length. <a href="#adb572c11065328b5bf608bc541fcb5f8"></a><br/></td></tr>
<tr class="memitem:a56f2e30d640188a6183f371318c18771"><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_1RuleBasedCollator.html#a56f2e30d640188a6183f371318c18771">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 </td></tr>
<tr class="memdesc:a56f2e30d640188a6183f371318c18771"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different string arrays. <a href="#a56f2e30d640188a6183f371318c18771"></a><br/></td></tr>
<tr class="memitem:ad95b78164d063cacee6938f18cca179b"><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_1RuleBasedCollator.html#ad95b78164d063cacee6938f18cca179b">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:ad95b78164d063cacee6938f18cca179b"><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="#ad95b78164d063cacee6938f18cca179b"></a><br/></td></tr>
<tr class="memitem:a065e4823a0517d59c8558993c57e6915"><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_1RuleBasedCollator.html#a065e4823a0517d59c8558993c57e6915">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 </td></tr>
<tr class="memdesc:a065e4823a0517d59c8558993c57e6915"><td class="mdescLeft"> </td><td class="mdescRight">Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare. <a href="#a065e4823a0517d59c8558993c57e6915"></a><br/></td></tr>
<tr class="memitem:a715637af0c17ba697e3263c34a0b4f08"><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_1RuleBasedCollator.html#a715637af0c17ba697e3263c34a0b4f08">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 </td></tr>
<tr class="memdesc:a715637af0c17ba697e3263c34a0b4f08"><td class="mdescLeft"> </td><td class="mdescRight">Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare. <a href="#a715637af0c17ba697e3263c34a0b4f08"></a><br/></td></tr>
<tr class="memitem:a2e4151dacde7a6eac7fb99b49954ccfa"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a2e4151dacde7a6eac7fb99b49954ccfa">hashCode</a> (void) const </td></tr>
<tr class="memdesc:a2e4151dacde7a6eac7fb99b49954ccfa"><td class="mdescLeft"> </td><td class="mdescRight">Generates the hash code for the rule-based collation object. <a href="#a2e4151dacde7a6eac7fb99b49954ccfa"></a><br/></td></tr>
<tr class="memitem:a94aa71dbacf10077ed13a84bfe87ef95"><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_1RuleBasedCollator.html#a94aa71dbacf10077ed13a84bfe87ef95">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 </td></tr>
<tr class="memdesc:a94aa71dbacf10077ed13a84bfe87ef95"><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="#a94aa71dbacf10077ed13a84bfe87ef95"></a><br/></td></tr>
<tr class="memitem:a3b28742ad41e2a6989c69b5dd879d0a7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a3b28742ad41e2a6989c69b5dd879d0a7">getRules</a> (void) const </td></tr>
<tr class="memdesc:a3b28742ad41e2a6989c69b5dd879d0a7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the tailoring rules for this collator. <a href="#a3b28742ad41e2a6989c69b5dd879d0a7"></a><br/></td></tr>
<tr class="memitem:a3ced1d9d5a8cbb570f777082f8866da6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a3ced1d9d5a8cbb570f777082f8866da6">getVersion</a> (<a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> info) const </td></tr>
<tr class="memdesc:a3ced1d9d5a8cbb570f777082f8866da6"><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="#a3ced1d9d5a8cbb570f777082f8866da6"></a><br/></td></tr>
<tr class="memitem:afad4275ae7ea663001285e14eded0013"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#afad4275ae7ea663001285e14eded0013">getMaxExpansion</a> (int32_t order) const </td></tr>
<tr class="memdesc:afad4275ae7ea663001285e14eded0013"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum length of any expansion sequences that end with the specified comparison order. <a href="#afad4275ae7ea663001285e14eded0013"></a><br/></td></tr>
<tr class="memitem:aff44758642ebb0b39afa8cc2fc832a49"><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_1RuleBasedCollator.html#aff44758642ebb0b39afa8cc2fc832a49">getDynamicClassID</a> (void) const </td></tr>
<tr class="memdesc:aff44758642ebb0b39afa8cc2fc832a49"><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID POLYMORPHICALLY. <a href="#aff44758642ebb0b39afa8cc2fc832a49"></a><br/></td></tr>
<tr class="memitem:aaff727ee76b07b226c6ecafb197b5eca"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#aaff727ee76b07b226c6ecafb197b5eca">cloneRuleData</a> (int32_t &length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:aaff727ee76b07b226c6ecafb197b5eca"><td class="mdescLeft"> </td><td class="mdescRight">Do not use this method: The caller and the ICU library might use different heaps. <a href="#aaff727ee76b07b226c6ecafb197b5eca"></a><br/></td></tr>
<tr class="memitem:abd4be6ff3597a6c41144f3db26d7d72f"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#abd4be6ff3597a6c41144f3db26d7d72f">cloneBinary</a> (uint8_t *buffer, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:abd4be6ff3597a6c41144f3db26d7d72f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a binary image of a collator. <a href="#abd4be6ff3597a6c41144f3db26d7d72f"></a><br/></td></tr>
<tr class="memitem:a1f0cea310deded117f874ea0ea05000f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a1f0cea310deded117f874ea0ea05000f">getRules</a> (<a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">UColRuleOption</a> delta, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &buffer)</td></tr>
<tr class="memdesc:a1f0cea310deded117f874ea0ea05000f"><td class="mdescLeft"> </td><td class="mdescRight">Returns current rules. <a href="#a1f0cea310deded117f874ea0ea05000f"></a><br/></td></tr>
<tr class="memitem:a53cc1952b0c7a8689e0f3fb86aee02d4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a53cc1952b0c7a8689e0f3fb86aee02d4">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)</td></tr>
<tr class="memdesc:a53cc1952b0c7a8689e0f3fb86aee02d4"><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute setter. <a href="#a53cc1952b0c7a8689e0f3fb86aee02d4"></a><br/></td></tr>
<tr class="memitem:a5035222b203536bb351ac2af4bf06a3b"><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_1RuleBasedCollator.html#a5035222b203536bb351ac2af4bf06a3b">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 </td></tr>
<tr class="memdesc:a5035222b203536bb351ac2af4bf06a3b"><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute getter. <a href="#a5035222b203536bb351ac2af4bf06a3b"></a><br/></td></tr>
<tr class="memitem:af703942fc0754b7cc7f9da288f34ac30"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#af703942fc0754b7cc7f9da288f34ac30">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)</td></tr>
<tr class="memdesc:af703942fc0754b7cc7f9da288f34ac30"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to a collation element value of a string supplied. <a href="#af703942fc0754b7cc7f9da288f34ac30"></a><br/></td></tr>
<tr class="memitem:a5b5d17deba77715b3c153e0bc8d2d593"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a5b5d17deba77715b3c153e0bc8d2d593">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)</td></tr>
<tr class="memdesc:a5b5d17deba77715b3c153e0bc8d2d593"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to a collation element value of a string supplied. <a href="#a5b5d17deba77715b3c153e0bc8d2d593"></a><br/></td></tr>
<tr class="memitem:a1c068986eae08c7274ff1c6fd5d0d61f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a1c068986eae08c7274ff1c6fd5d0d61f">setVariableTop</a> (uint32_t varTop, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a1c068986eae08c7274ff1c6fd5d0d61f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to a collation element value supplied. <a href="#a1c068986eae08c7274ff1c6fd5d0d61f"></a><br/></td></tr>
<tr class="memitem:a3eb6f150fd7ad705f218c66b9f95969e"><td class="memItemLeft" align="right" valign="top">virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a3eb6f150fd7ad705f218c66b9f95969e">getVariableTop</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a3eb6f150fd7ad705f218c66b9f95969e"><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="#a3eb6f150fd7ad705f218c66b9f95969e"></a><br/></td></tr>
<tr class="memitem:a5eca3366d198d8de015bdf3a94b942c7"><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_1RuleBasedCollator.html#a5eca3366d198d8de015bdf3a94b942c7">getTailoredSet</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a5eca3366d198d8de015bdf3a94b942c7"><td class="mdescLeft"> </td><td class="mdescRight">Get an <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="#a5eca3366d198d8de015bdf3a94b942c7"></a><br/></td></tr>
<tr class="memitem:a0b1365bfa196f979480d96250ed4b5e7"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a0b1365bfa196f979480d96250ed4b5e7">getSortKey</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &source, uint8_t *result, int32_t resultLength) const </td></tr>
<tr class="memdesc:a0b1365bfa196f979480d96250ed4b5e7"><td class="mdescLeft"> </td><td class="mdescRight">Get the sort key as an array of bytes from an <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="#a0b1365bfa196f979480d96250ed4b5e7"></a><br/></td></tr>
<tr class="memitem:a1acd4527bc89dbed7a7e270a68baa44c"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a1acd4527bc89dbed7a7e270a68baa44c">getSortKey</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, uint8_t *result, int32_t resultLength) const </td></tr>
<tr class="memdesc:a1acd4527bc89dbed7a7e270a68baa44c"><td class="mdescLeft"> </td><td class="mdescRight">Get the sort key as an array of bytes from an UChar buffer. <a href="#a1acd4527bc89dbed7a7e270a68baa44c"></a><br/></td></tr>
<tr class="memitem:af5e6d4c602e2699dae1ed9cba31df959"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#af5e6d4c602e2699dae1ed9cba31df959">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:af5e6d4c602e2699dae1ed9cba31df959"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reordering codes for this collator. <a href="#af5e6d4c602e2699dae1ed9cba31df959"></a><br/></td></tr>
<tr class="memitem:a1f76d6e957f2c441129e0170c9c6f89a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a1f76d6e957f2c441129e0170c9c6f89a">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:a1f76d6e957f2c441129e0170c9c6f89a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the ordering of scripts for this collator. <a href="#a1f76d6e957f2c441129e0170c9c6f89a"></a><br/></td></tr>
<tr class="memitem:acb7eab7a8ce047e5bdf8e8a1ad04e15e"><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_1RuleBasedCollator.html#acb7eab7a8ce047e5bdf8e8a1ad04e15e">getUCollator</a> ()</td></tr>
<tr class="memdesc:acb7eab7a8ce047e5bdf8e8a1ad04e15e"><td class="mdescLeft"> </td><td class="mdescRight">Get UCollator data struct. <a href="#acb7eab7a8ce047e5bdf8e8a1ad04e15e"></a><br/></td></tr>
<tr class="memitem:a3711f954bab897ce6eaa9ff681bc41ec"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a3711f954bab897ce6eaa9ff681bc41ec">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:a3711f954bab897ce6eaa9ff681bc41ec"><td class="mdescLeft"> </td><td class="mdescRight">Get the short definition string for a collator. <a href="#a3711f954bab897ce6eaa9ff681bc41ec"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classicu_1_1Collator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1Collator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1Collator.html">icu::Collator</a></td></tr>
<tr class="memitem:a9c517ed7ea3633ec4e3e1fb879260cf6 inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a9c517ed7ea3633ec4e3e1fb879260cf6"></a><br/></td></tr>
<tr class="memitem:a709fc13d06f6ee45d40d21edd420434d inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if "other" is not the same as "this". <a href="#a709fc13d06f6ee45d40d21edd420434d"></a><br/></td></tr>
<tr class="memitem:a844bcb05f66aeaf17b2c52d8d7294d1d inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different strings. <a href="#a844bcb05f66aeaf17b2c52d8d7294d1d"></a><br/></td></tr>
<tr class="memitem:a186b8b940ebf5dd72bffa41bc436305c inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Does the same thing as compare but limits the comparison to a specified length. <a href="#a186b8b940ebf5dd72bffa41bc436305c"></a><br/></td></tr>
<tr class="memitem:afdbe04d59924d1441f8476526e45d15f inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different string arrays. <a href="#afdbe04d59924d1441f8476526e45d15f"></a><br/></td></tr>
<tr class="memitem:acf276ca90c9865f59501615d3728c36f inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:afce3c5befa3a044670252853a4c74fb7 inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#afce3c5befa3a044670252853a4c74fb7"></a><br/></td></tr>
<tr class="memitem:abe57c202d01671dcad4c1bd18d2e26d7 inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#abe57c202d01671dcad4c1bd18d2e26d7"></a><br/></td></tr>
<tr class="memitem:aceef4906764344644ea1493eb58a71b0 inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#aceef4906764344644ea1493eb58a71b0"></a><br/></td></tr>
<tr class="memitem:ade30058ee5084298c35554c3c496c67b inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Determines the minimum strength that will be used in comparison or transformation. <a href="#ade30058ee5084298c35554c3c496c67b"></a><br/></td></tr>
<tr class="memitem:a5bfd9426f93b39666975c6259fb71281 inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum strength to be used in comparison or transformation. <a href="#a5bfd9426f93b39666975c6259fb71281"></a><br/></td></tr>
<tr class="memitem:a5672d9a7d5044b67a5bc9e71a051d749 inherit pub_methods_classicu_1_1Collator"><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 inherit pub_methods_classicu_1_1Collator"><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"></a><br/></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"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6e27ca183d6a802a5701130f5df4500f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a6e27ca183d6a802a5701130f5df4500f">getStaticClassID</a> (void)</td></tr>
<tr class="memdesc:a6e27ca183d6a802a5701130f5df4500f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the class ID for this class. <a href="#a6e27ca183d6a802a5701130f5df4500f"></a><br/></td></tr>
<tr class="memitem:ae633641dc991d5f97f855aaa14147ce4"><td class="memItemLeft" align="right" valign="top">static int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#ae633641dc991d5f97f855aaa14147ce4">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:ae633641dc991d5f97f855aaa14147ce4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reorder codes that are grouped with the given reorder code. <a href="#ae633641dc991d5f97f855aaa14147ce4"></a><br/></td></tr>
<tr class="inherit_header pub_static_methods_classicu_1_1Collator"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classicu_1_1Collator')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classicu_1_1Collator.html">icu::Collator</a></td></tr>
<tr class="memitem:a4e6fdf681aa52573ef5ad0a0bd22eb97 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:af7aa04c72be7c47935cc5c6308c0677c inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Gets the table-based collation object for the desired locale. <a href="#af7aa04c72be7c47935cc5c6308c0677c"></a><br/></td></tr>
<tr class="memitem:afbdfbd00fc3442fdd01b2c3519e54b3d inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a0bbcba6a2a4437f1ef8e498ca7036681 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:af8860a64cf24005a2b7daefa2b3d7e84 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Locales for which Collations are installed. <a href="#af8860a64cf24005a2b7daefa2b3d7e84"></a><br/></td></tr>
<tr class="memitem:a83bbaa40da657a056dc410a54d3b4d2f inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a223dc10a01a290aba9077ed10278eabd inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Create a string enumerator of all possible keywords that are relevant to collation. <a href="#a223dc10a01a290aba9077ed10278eabd"></a><br/></td></tr>
<tr class="memitem:a425557850270d5fbb2dd77bf8f2a4f19 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a869f42454f0e55cf27737b14c542498f inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a394651828ed9f32b0ca62a0cb3069c1a inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a07848f613016be2dcbead263a88b7bc8 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a95e7393eab7ac7d4e8896b2a3137fb93 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:aeac8f5fccf2d34f806f9cb4655f10d24 inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><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"></a><br/></td></tr>
<tr class="memitem:a5c6cd94597a5581a40e0eb9c8ba4b3af inherit pub_static_methods_classicu_1_1Collator"><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 inherit pub_static_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Produce a bound for a given sortkey and a number of levels. <a href="#a5c6cd94597a5581a40e0eb9c8ba4b3af"></a><br/></td></tr>
<tr class="memitem:ae988c0e70033af71a992aa94fe22e000 inherit pub_static_methods_classicu_1_1Collator"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Collator.html#ae988c0e70033af71a992aa94fe22e000">createUCollator</a> (const char *loc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ae988c0e70033af71a992aa94fe22e000 inherit pub_static_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">used only by ucol_open, not for public use <a href="#ae988c0e70033af71a992aa94fe22e000"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4b5d90263cb69f616175d275c6757748"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a4b5d90263cb69f616175d275c6757748">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:a4b5d90263cb69f616175d275c6757748"><td class="mdescLeft"> </td><td class="mdescRight">Used internally by registraton to define the requested and valid locales. <a href="#a4b5d90263cb69f616175d275c6757748"></a><br/></td></tr>
<tr class="inherit_header pro_methods_classicu_1_1Collator"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classicu_1_1Collator')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classicu_1_1Collator.html">icu::Collator</a></td></tr>
<tr class="memitem:a3fa9751f0fc15a504bdaa4aa22e26747 inherit pro_methods_classicu_1_1Collator"><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 inherit pro_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a3fa9751f0fc15a504bdaa4aa22e26747"></a><br/></td></tr>
<tr class="memitem:a98c42c147eae65ccd5334f2e5ae8082e inherit pro_methods_classicu_1_1Collator"><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 inherit pro_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a98c42c147eae65ccd5334f2e5ae8082e"></a><br/></td></tr>
<tr class="memitem:af5c82b8f9f914bdf1586e5fdf9cba3f8 inherit pro_methods_classicu_1_1Collator"><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 inherit pro_methods_classicu_1_1Collator"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#af5c82b8f9f914bdf1586e5fdf9cba3f8"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a2493a8a45ec3ae69e1bec8355c948519"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2493a8a45ec3ae69e1bec8355c948519"></a>
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a2493a8a45ec3ae69e1bec8355c948519">CollationElementIterator</a></td></tr>
<tr class="memdesc:a2493a8a45ec3ae69e1bec8355c948519"><td class="mdescLeft"> </td><td class="mdescRight">Used to iterate over collation elements in a character source. <br/></td></tr>
<tr class="memitem:af22e5ffabbf5a2d4d729daa0b5d3cafd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af22e5ffabbf5a2d4d729daa0b5d3cafd"></a>
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#af22e5ffabbf5a2d4d729daa0b5d3cafd">Collator</a></td></tr>
<tr class="memdesc:af22e5ffabbf5a2d4d729daa0b5d3cafd"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> ONLY needs access to <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a>(const <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region.">Locale</a>&, UErrorCode&) <br/></td></tr>
<tr class="memitem:a421a131b6330b132d67ac9582acb9886"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a421a131b6330b132d67ac9582acb9886"></a>
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1RuleBasedCollator.html#a421a131b6330b132d67ac9582acb9886">StringSearch</a></td></tr>
<tr class="memdesc:a421a131b6330b132d67ac9582acb9886"><td class="mdescLeft"> </td><td class="mdescRight">Searching over collation elements in a character source. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classicu_1_1Collator"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classicu_1_1Collator')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classicu_1_1Collator.html">icu::Collator</a></td></tr>
<tr class="memitem:a82bc20541fe4503fb78644a1968e15a2 inherit pub_types_classicu_1_1Collator"><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/>
}</td></tr>
<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>
<tr class="memitem:ac9827be018f594eae0573473034233b7 inherit pub_types_classicu_1_1Collator"><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
}</td></tr>
<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>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> class provides the simple implementation of <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a>, using data-driven tables. </p>
<p>The user can create a customized table-based collation. </p>
<p><em>Important: </em>The ICU collation service has been reimplemented in order to achieve better performance and UCA compliance. For details, see the <a href="http://source.icu-project.org/repos/icu/icuhtml/trunk/design/collation/ICU_collation_design.htm">collation design document</a>. </p>
<p><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> is a thin C++ wrapper over the C implementation. </p>
<p>For more information about the collation service see <a href="http://icu-project.org/userguide/Collate_Intro.html">the users guide</a>. </p>
<p>Collation service provides correct sorting orders for most locales supported in ICU. If specific data for a locale is not available, the orders eventually falls back to the <a href="http://www.unicode.org/unicode/reports/tr10/">UCA sort order</a>. </p>
<p>Sort ordering may be customized by providing your own set of rules. For more on this subject see the <a href="http://icu-project.org/userguide/Collate_Customization.html">Collation customization</a> section of the users guide. </p>
<p>Note, <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> is not to be subclassed. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> </dd></dl>
<dl class="section version"><dt>Version</dt><dd>2.0 11/15/2001 </dd></dl>
<p>Definition at line <a class="el" href="tblcoll_8h_source.html#l00111">111</a> of file <a class="el" href="tblcoll_8h_source.html">tblcoll.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab26b8846a053c2def598ec7c957cfcc4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::RuleBasedCollator::RuleBasedCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>rules</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>
</div><div class="memdoc">
<p><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. </p>
<p>This takes the table rules and builds a collation table out of them. Please see <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> class description for more details on the collation rule syntax. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rules</td><td>the collation rules to build the collation table from. </td></tr>
<tr><td class="paramname">status</td><td>reporting a success or an error. </td></tr>
</table>
</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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003987">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aaf9a00014372009c71cd36430da4f610"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::RuleBasedCollator::RuleBasedCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> </td>
<td class="paramname"><em>collationStrength</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>
</div><div class="memdoc">
<p><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. </p>
<p>This takes the table rules and builds a collation table out of them. Please see <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> class description for more details on the collation rule syntax. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rules</td><td>the collation rules to build the collation table from. </td></tr>
<tr><td class="paramname">collationStrength</td><td>default strength for comparison </td></tr>
<tr><td class="paramname">status</td><td>reporting a success or an error. </td></tr>
</table>
</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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003988">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a07b23add8f39b6d2dd6d608ac9485b97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::RuleBasedCollator::RuleBasedCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>rules</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>decompositionMode</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>
</div><div class="memdoc">
<p><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. </p>
<p>This takes the table rules and builds a collation table out of them. Please see <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> class description for more details on the collation rule syntax. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rules</td><td>the collation rules to build the collation table from. </td></tr>
<tr><td class="paramname">decompositionMode</td><td>the normalisation mode </td></tr>
<tr><td class="paramname">status</td><td>reporting a success or an error. </td></tr>
</table>
</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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003989">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a29e95021c2a9acf1fced334f57c074ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::RuleBasedCollator::RuleBasedCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1Collator.html#a82bc20541fe4503fb78644a1968e15a2">ECollationStrength</a> </td>
<td class="paramname"><em>collationStrength</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>decompositionMode</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>
</div><div class="memdoc">
<p><a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> constructor. </p>
<p>This takes the table rules and builds a collation table out of them. Please see <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> class description for more details on the collation rule syntax. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rules</td><td>the collation rules to build the collation table from. </td></tr>
<tr><td class="paramname">collationStrength</td><td>default strength for comparison </td></tr>
<tr><td class="paramname">decompositionMode</td><td>the normalisation mode </td></tr>
<tr><td class="paramname">status</td><td>reporting a success or an error. </td></tr>
</table>
</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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003990">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad60f53ba1323a3516edf93154006d91c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::RuleBasedCollator::RuleBasedCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></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>the <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> object to be copied </td></tr>
</table>
</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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003991">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2f4c7eeaf020ad68e3bd9722dd272357"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::RuleBasedCollator::RuleBasedCollator </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>bin</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">const <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> * </td>
<td class="paramname"><em>base</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>
</div><div class="memdoc">
<p>Opens a collator from a collator binary image created using cloneBinary. </p>
<p>Binary image used in instantiation of the collator remains owned by the user and should stay around for the lifetime of the collator. The API also takes a base collator which usualy should be UCA. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bin</td><td>binary image owned by the user and required through the lifetime of the collator </td></tr>
<tr><td class="paramname">length</td><td>size of the image. If negative, the API will try to figure out the length of the image </td></tr>
<tr><td class="paramname">base</td><td>fallback collator, usually UCA. Base is required to be present through the lifetime of the collator. Currently it cannot be NULL. </td></tr>
<tr><td class="paramname">status</td><td>for catching errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly created collator </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classicu_1_1RuleBasedCollator.html#abd4be6ff3597a6c41144f3db26d7d72f" title="Creates a binary image of a collator.">cloneBinary</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003992">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a7f0ee2464acb12f597680df69a69d97d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::RuleBasedCollator::~RuleBasedCollator </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#_stable003993">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a34a873f2ec25d787bf6f123d27221e73"></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::RuleBasedCollator::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">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#_stable003996">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a505289afa039447c0cf500558ac249e0">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="abd4be6ff3597a6c41144f3db26d7d72f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t icu::RuleBasedCollator::cloneBinary </td>
<td>(</td>
<td class="paramtype">uint8_t * </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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a binary image of a collator. </p>
<p>This binary image can be stored and later used to instantiate a collator using ucol_openBinary. This API supports preflighting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>a fill-in buffer to receive the binary image </td></tr>
<tr><td class="paramname">capacity</td><td>capacity of the destination buffer </td></tr>
<tr><td class="paramname">status</td><td>for catching errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the image </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a467ea0dde69a6990f6ecbb7e30da6003" title="Opens a collator from a collator binary image created using ucol_cloneBinary.">ucol_openBinary</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004010">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aaff727ee76b07b226c6ecafb197b5eca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* icu::RuleBasedCollator::cloneRuleData </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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Do not use this method: The caller and the ICU library might use different heaps. </p>
<p>Use <a class="el" href="classicu_1_1RuleBasedCollator.html#abd4be6ff3597a6c41144f3db26d7d72f" title="Creates a binary image of a collator.">cloneBinary()</a> instead which writes to caller-provided memory.</p>
<p>Returns a binary format of this collator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>Returns the length of the data, in bytes </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>memory, owned by the caller, of size 'length' bytes. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000246">Deprecated:</a></b></dt><dd>ICU 52. Use <a class="el" href="classicu_1_1RuleBasedCollator.html#abd4be6ff3597a6c41144f3db26d7d72f" title="Creates a binary image of a collator.">cloneBinary()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a6eeec5e18d8f24b737bf814dcd3b8613"></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::RuleBasedCollator::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">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#_stable003999">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a832794e7b9b813d5a8f638d550cc9b2e">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="adb572c11065328b5bf608bc541fcb5f8"></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::RuleBasedCollator::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">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#_stable004000">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#ae965267bf6a4c2b7b8aeadeb30059391">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a56f2e30d640188a6183f371318c18771"></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::RuleBasedCollator::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">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#_stable004001">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a1f803916ef97452722dfa967e440cc20">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="ad95b78164d063cacee6938f18cca179b"></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::RuleBasedCollator::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#_stable004002">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#a9e09f1d8ffc750e06c2495a5c6674669">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="ad69ff21358c28b238f6a23ef8b6fd9c4"></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_1CollationElementIterator.html">CollationElementIterator</a>* icu::RuleBasedCollator::createCollationElementIterator </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><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>Creates a collation element iterator for the source string. </p>
<p>The caller of this method is responsible for the memory management of the return pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the string over which the <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> will iterate. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the collation element iterator of the source string using this as the based <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003997">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="afdbd1b7ba2a7efe051e3f411dd422db1"></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_1CollationElementIterator.html">CollationElementIterator</a>* icu::RuleBasedCollator::createCollationElementIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1CharacterIterator.html">CharacterIterator</a> & </td>
<td class="paramname"><em>source</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>Creates a collation element iterator for the source. </p>
<p>The caller of this method is responsible for the memory management of the returned pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the <a class="el" href="classicu_1_1CharacterIterator.html" title="Abstract class that defines an API for iteration on text objects.">CharacterIterator</a> which produces the characters over which the CollationElementItgerator will iterate. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the collation element iterator of the source using this as the based <a class="el" href="classicu_1_1Collator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003998">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a5035222b203536bb351ac2af4bf06a3b"></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::RuleBasedCollator::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">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#_stable004013">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#aa3b934fb5a3a08fd8664824159c0ac91">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a065e4823a0517d59c8558993c57e6915"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare. </p>
<p>Use a <a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> when you need to do repeated comparisions on the same string. For a single comparison the compare method will be faster. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string. </td></tr>
<tr><td class="paramname">key</td><td>the transformed key of the source string. </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 transformed key. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004003">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#ad1e3bebe6e3ae7bd79cce7f2cf9f4ab1">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a715637af0c17ba697e3263c34a0b4f08"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare. </p>
<p>Use a <a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> when you need to do repeated comparisions on the same string. For a single comparison the compare method will be faster. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>the source string. </td></tr>
<tr><td class="paramname">sourceLength</td><td>the length of the source string. </td></tr>
<tr><td class="paramname">key</td><td>the transformed key of the source string. </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 transformed key. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classicu_1_1CollationKey.html" title="Collation keys are generated by the Collator class.">CollationKey</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004004">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#ae0bc68d37c4a88d1cb731adaa5a85e95">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="aff44758642ebb0b39afa8cc2fc832a49"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a unique class ID POLYMORPHICALLY. </p>
<p>Pure virtual override. 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_1RuleBasedCollator.html#a0fd2ca09264d26f3067522ce03ec4c92" title="Returns true if argument is the same as this object.">operator==()</a> and <a class="el" href="classicu_1_1RuleBasedCollator.html#a34a873f2ec25d787bf6f123d27221e73" 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#_stable004008">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a5bc8a1b8e65aa2444aa568e9692aed0a">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="ae633641dc991d5f97f855aaa14147ce4"></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::RuleBasedCollator::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. </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 equivalene 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 of the result string (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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004023">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#af7c8befb8e7086be8fca27d23072b4d5">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a94aa71dbacf10077ed13a84bfe87ef95"></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::RuleBasedCollator::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">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#_deprecated000244">Deprecated:</a></b></dt><dd>ICU 2.8 likely to change in ICU 3.0, based on feedback </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a9ce5b59d720566877b2201747782ed19">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="afad4275ae7ea663001285e14eded0013"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t icu::RuleBasedCollator::getMaxExpansion </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the maximum length of any expansion sequences that end with the specified comparison order. </p>
<p>This is specific to the kind of collation element values and sequences returned by the <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>. Call <a class="el" href="classicu_1_1CollationElementIterator.html#ae6c3a2f6563a30984d2eaa08f179e45f" title="Return the maximum length of any expansion sequences that end with the specified comparison order...">CollationElementIterator::getMaxExpansion()</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>a collation order returned by <a class="el" href="classicu_1_1CollationElementIterator.html#a66e327b6a4b92679ee15dd5cf787d189" title="Get the ordering priority of the previous collation element in the string.">CollationElementIterator::previous</a> or <a class="el" href="classicu_1_1CollationElementIterator.html#ab905e96e1672a5dce5812f34938dc930" title="Gets the ordering priority of the next character in the string.">CollationElementIterator::next</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>maximum size of the expansion sequences ending with the collation element, or 1 if the collation element does not occur at the end of any expansion sequence </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classicu_1_1CollationElementIterator.html#ae6c3a2f6563a30984d2eaa08f179e45f" title="Return the maximum length of any expansion sequences that end with the specified comparison order...">CollationElementIterator::getMaxExpansion</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000245">Deprecated:</a></b></dt><dd>ICU 51 Use <a class="el" href="classicu_1_1CollationElementIterator.html#ae6c3a2f6563a30984d2eaa08f179e45f" title="Return the maximum length of any expansion sequences that end with the specified comparison order...">CollationElementIterator::getMaxExpansion()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="af5e6d4c602e2699dae1ed9cba31df959"></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::RuleBasedCollator::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 of the result string (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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004021">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#a18035cc173f7253b9b778eb52e32eae3">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a3b28742ad41e2a6989c69b5dd879d0a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::RuleBasedCollator::getRules </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the tailoring rules for this collator. </p>
<dl class="section return"><dt>Returns</dt><dd>the collation tailoring from which this collator was created </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004006">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1f0cea310deded117f874ea0ea05000f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icu::RuleBasedCollator::getRules </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">UColRuleOption</a> </td>
<td class="paramname"><em>delta</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>buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns current rules. </p>
<p>Delta defines whether full rules are returned or just the tailoring.</p>
<p>getRules(void) should normally be used instead. See <a href="http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales">http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">delta</td><td>one of UCOL_TAILORING_ONLY, UCOL_FULL_RULES. </td></tr>
<tr><td class="paramname">buffer</td><td><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> to store the result rules </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004011">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872fa6e027e190a33aa58b026afd48a97b67f" title="Retrieves the "UCA rules" concatenated with the tailoring rules.">UCOL_FULL_RULES</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0b1365bfa196f979480d96250ed4b5e7"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the sort key as an array of bytes from an <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>
<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#_stable004019">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a52ca2d2de5cd75fabd4b50fe61dd0165">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a1acd4527bc89dbed7a7e270a68baa44c"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the sort key as an array of bytes from an UChar buffer. </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#_stable004020">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a180abe61e22e0b12aa352b8c15d98ade">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a6e27ca183d6a802a5701130f5df4500f"></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="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::RuleBasedCollator::getStaticClassID </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>Returns the class ID for this class. </p>
<p>This is useful only for comparing to a return value from <a class="el" href="classicu_1_1RuleBasedCollator.html#aff44758642ebb0b39afa8cc2fc832a49" title="Returns a unique class ID POLYMORPHICALLY.">getDynamicClassID()</a>. For example: </p>
<pre>
Base* polymorphic_pointer = createPolymorphicObject();
if (polymorphic_pointer-><a class="el" href="classicu_1_1RuleBasedCollator.html#aff44758642ebb0b39afa8cc2fc832a49" title="Returns a unique class ID POLYMORPHICALLY.">getDynamicClassID()</a> ==
Derived::getStaticClassID()) ...
</pre> <dl class="section return"><dt>Returns</dt><dd>The class ID for all objects of this class. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004009">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5eca3366d198d8de015bdf3a94b942c7"></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::RuleBasedCollator::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 an <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 UCA. The object must be disposed of by using delete </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004018">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#ab4b6cdc4af0b4011d6867cb74f3287ce">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="acb7eab7a8ce047e5bdf8e8a1ad04e15e"></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::RuleBasedCollator::getUCollator </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">
<p>Get UCollator data struct. </p>
<p>Used only by <a class="el" href="classicu_1_1StringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching based on the compari...">StringSearch</a> & intltest. </p>
<dl class="section return"><dt>Returns</dt><dd>UCollator data struct </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000360">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Definition at line <a class="el" href="tblcoll_8h_source.html#l00850">850</a> of file <a class="el" href="tblcoll_8h_source.html">tblcoll.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3eb6f150fd7ad705f218c66b9f95969e"></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::RuleBasedCollator::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">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>
<p>Lower 16 bits are undefined and should be ignored. </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="stable"><dt><b><a class="el" href="stable.html#_stable004017">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a5aa9ae3225889380d10c53179e615790">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a3ced1d9d5a8cbb570f777082f8866da6"></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::RuleBasedCollator::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">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#_stable004007">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a26375fdb52b064d914b7f9861ec51236">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a2e4151dacde7a6eac7fb99b49954ccfa"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generates the hash code for the rule-based collation object. </p>
<dl class="section return"><dt>Returns</dt><dd>the hash code. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004005">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#aadde1f7d0f8156b9d33993aad707e7fa">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a3711f954bab897ce6eaa9ff681bc41ec"></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::RuleBasedCollator::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 properties 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://icu-project.org/userguide/Collate_Concepts.html#Naming_Collators">http://icu-project.org/userguide/Collate_Concepts.html#Naming_Collators</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#_internal000362">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#a088aaea714a628362839baa4cfaa516c">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a1a977c57fe95e8d7121fd899cefd1af8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a>& icu::RuleBasedCollator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1RuleBasedCollator.html">RuleBasedCollator</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>other <a class="el" href="classicu_1_1RuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables...">RuleBasedCollator</a> object to compare with. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003994">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0fd2ca09264d26f3067522ce03ec4c92"></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::RuleBasedCollator::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 argument is the same as this object. </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 arguments is the same as this object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003995">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#a042bb938d6eff7f670fca78e8d025500">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a53cc1952b0c7a8689e0f3fb86aee02d4"></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::RuleBasedCollator::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">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#_stable004012">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a4339fbf9104428a06923a25df7ffd7f4">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a4b5d90263cb69f616175d275c6757748"></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::RuleBasedCollator::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">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Used internally by registraton 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 requsted 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#_internal000361">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#a4136c816774f41452426abd922f7ab71">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a1f76d6e957f2c441129e0170c9c6f89a"></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::RuleBasedCollator::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>
<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="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></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004022">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1Collator.html#ad0d7f72096a46f480e1cf6653a679240">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="af703942fc0754b7cc7f9da288f34ac30"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to a collation element value of a string supplied. </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 a contraction<br/>
U_PRIMARY_TOO_LONG_ERROR if the primary for the variable top has more than two bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a 32 bit value containing the value of the variable top in upper 16 bits. Lower 16 bits are undefined </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004014">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#af160cfa99c42483eb423ec8ea2d6abba">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a5b5d17deba77715b3c153e0bc8d2d593"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to a collation element value of a string supplied. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">varTop</td><td>an <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 a contraction<br/>
U_PRIMARY_TOO_LONG_ERROR if the primary for the variable top has more than two bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a 32 bit value containing the value of the variable top in upper 16 bits. Lower 16 bits are undefined </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004015">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#a6d37b263e04e014ff6b13ac0d3fbbce7">icu::Collator</a>.</p>
</div>
</div>
<a class="anchor" id="a1c068986eae08c7274ff1c6fd5d0d61f"></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::RuleBasedCollator::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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to a collation element value supplied. </p>
<p>Variable top is set to the upper 16 bits. Lower 16 bits are ignored. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">varTop</td><td>CE value, as returned by setVariableTop or ucol)getVariableTop </td></tr>
<tr><td class="paramname">status</td><td>error code (not changed by function) </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004016">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classicu_1_1Collator.html#ad9859bf87721ce8627d9f29d8920cd99">icu::Collator</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="tblcoll_8h_source.html">tblcoll.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 4 2013 14:10:26 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
