<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: Collator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<h1>Collator Class Reference</h1><!-- doxytag: class="Collator" --><!-- doxytag: inherits="UObject" -->The <code><a class="el" href="classCollator.html">Collator</a></code> class performs locale-sensitive string comparison.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="coll_8h-source.html">coll.h</a>></code>
<p>
<p>Inheritance diagram for Collator:
<p><center><img src="classCollator.png" usemap="#Collator_map" border="0" alt=""></center>
<map name="Collator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,116,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,116,24">
<area href="classRuleBasedCollator.html" alt="RuleBasedCollator" shape="rect" coords="0,168,116,192">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">ECollationStrength</a> { <br>
<b>PRIMARY</b> = 0,
<b>SECONDARY</b> = 1,
<b>TERTIARY</b> = 2,
<b>QUATERNARY</b> = 3,
<br>
<b>IDENTICAL</b> = 15
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base letter represents a primary difference. <a href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> { <b>LESS</b> = -1,
<b>EQUAL</b> = 0,
<b>GREATER</b> = 1
}</td></tr>
<tr><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="classCollator.html#ca611b586fa47a756d2b29996f713182">compare()</a> method. <a href="classCollator.html#05f22f81363f2613bea18a632b67686f">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#eed400dfca4ef25d95509265a1566ce9">~Collator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#eed400dfca4ef25d95509265a1566ce9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#58fa13068a2e4e07a8835f6c0f8c18b6">operator==</a> (const <a class="el" href="classCollator.html">Collator</a> &other) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if "other" is the same as "this". <a href="#58fa13068a2e4e07a8835f6c0f8c18b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#8c79adc0d04be5a7b82ac1991d445909">operator!=</a> (const <a class="el" href="classCollator.html">Collator</a> &other) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if "other" is not the same as "this". <a href="#8c79adc0d04be5a7b82ac1991d445909"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#5b7873505ee31c3745c207cf45d114b4">clone</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes a shallow copy of the current object. <a href="#5b7873505ee31c3745c207cf45d114b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different strings. <a href="#ca611b586fa47a756d2b29996f713182"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="ucol_8h.html#8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#87d53bab5e900d89ad27fd61ea6b985d">compare</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different strings. <a href="#87d53bab5e900d89ad27fd61ea6b985d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#e5dcb5135932d73ff6700b66d119b39f">compare</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="ucnv_8h.html#2b811fa5f6e9b580fa0122d38e9849b5">length</a>) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does the same thing as compare but limits the comparison to a specified length. <a href="#e5dcb5135932d73ff6700b66d119b39f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="ucol_8h.html#8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#550d7d5a20e5b885f93331f5fa508e40">compare</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="ucnv_8h.html#2b811fa5f6e9b580fa0122d38e9849b5">length</a>, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does the same thing as compare but limits the comparison to a specified length. <a href="#550d7d5a20e5b885f93331f5fa508e40"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#6ed570968d689706df2e232fdab844fa">compare</a> (const UChar *source, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> sourceLength, const UChar *target, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> targetLength) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different string arrays. <a href="#6ed570968d689706df2e232fdab844fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="ucol_8h.html#8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#5f32ec22ac5ed66bff8d7707db9260d7">compare</a> (const UChar *source, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> sourceLength, const UChar *target, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> targetLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The comparison function compares the character data stored in two different string arrays. <a href="#5f32ec22ac5ed66bff8d7707db9260d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollationKey.html">CollationKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#b48ddb212e12b9ef4ffa7163e2d7810a">getCollationKey</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, <a class="el" href="classCollationKey.html">CollationKey</a> &key, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transforms the string into a series of characters that can be compared with <a class="el" href="classCollationKey.html#9770a24d18b10909bad10f4cccdae3f6">CollationKey::compareTo</a>. <a href="#b48ddb212e12b9ef4ffa7163e2d7810a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollationKey.html">CollationKey</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#fd733f040738213f0e46847b1e31cf6a">getCollationKey</a> (const UChar *source, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> sourceLength, <a class="el" href="classCollationKey.html">CollationKey</a> &key, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transforms the string into a series of characters that can be compared with <a class="el" href="classCollationKey.html#9770a24d18b10909bad10f4cccdae3f6">CollationKey::compareTo</a>. <a href="#fd733f040738213f0e46847b1e31cf6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#989efcbd6664efd0a8e738a2c1d3f357">hashCode</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates the hash code for the collation object. <a href="#989efcbd6664efd0a8e738a2c1d3f357"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classLocale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#3a871f1b08787fde0a9a4fef135d2928">getLocale</a> (<a class="el" href="uloc_8h.html#df053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the locale of the <a class="el" href="classCollator.html">Collator</a>. <a href="#3a871f1b08787fde0a9a4fef135d2928"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#ea0a4ed08d95791194c307f95e4cd8f2">greater</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#ea0a4ed08d95791194c307f95e4cd8f2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#a87d324253cf094dc48a7a1e9b7b6afa">greaterOrEqual</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#a87d324253cf094dc48a7a1e9b7b6afa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#e00999fae1a46616421f3469c53b82f3">equals</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &target) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for comparing two strings based on the collation rules. <a href="#e00999fae1a46616421f3469c53b82f3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">ECollationStrength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#bbd68b496b6063c5a09a35ce96e4ce93">getStrength</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines the minimum strength that will be use in comparison or transformation. <a href="#bbd68b496b6063c5a09a35ce96e4ce93"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#0337d30970c7b73a6885a31d6d7d2afa">setStrength</a> (<a class="el" href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">ECollationStrength</a> newStrength)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum strength to be used in comparison or transformation. <a href="#0337d30970c7b73a6885a31d6d7d2afa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#a0be92c2d066910f88b27d914b4fb117">getVersion</a> (<a class="el" href="uversion_8h.html#61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> info) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the version information for a <a class="el" href="classCollator.html">Collator</a>. <a href="#a0be92c2d066910f88b27d914b4fb117"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#eaf10ab8b08d195a294a9b15aa7195da">getDynamicClassID</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID POLYMORPHICALLY. <a href="#eaf10ab8b08d195a294a9b15aa7195da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#132f1d7ad918bc1f4dcb956fd74ea808">setAttribute</a> (<a class="el" href="ucol_8h.html#583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> attr, <a class="el" href="ucol_8h.html#cc801048729e684bcabed328be85f77a">UColAttributeValue</a> value, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute setter. <a href="#132f1d7ad918bc1f4dcb956fd74ea808"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="ucol_8h.html#cc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#84c6c013a46196d829f71fa843ae7933">getAttribute</a> (<a class="el" href="ucol_8h.html#583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> attr, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute getter. <a href="#84c6c013a46196d829f71fa843ae7933"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#b6e4fc13e278beca8a39539dc326a913">setVariableTop</a> (const UChar *varTop, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> len, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to a collation element value of a string supplied. <a href="#b6e4fc13e278beca8a39539dc326a913"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#dbf3ad5122866f9a16d39ca07779ddce">setVariableTop</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> varTop, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to a collation element value of a string supplied. <a href="#dbf3ad5122866f9a16d39ca07779ddce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#fc34e06d5d3675e6e6ad26a1ee303690">setVariableTop</a> (const <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> varTop, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to a collation element value supplied. <a href="#fc34e06d5d3675e6e6ad26a1ee303690"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#f04197e6c46b619cb1afbd523c333643">getVariableTop</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the variable top value of a <a class="el" href="classCollator.html">Collator</a>. <a href="#f04197e6c46b619cb1afbd523c333643"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classUnicodeSet.html">UnicodeSet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#a62e72fedfe466e279f4ebf6343c520e">getTailoredSet</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an <a class="el" href="classUnicodeSet.html">UnicodeSet</a> that contains all the characters and sequences tailored in this collator. <a href="#a62e72fedfe466e279f4ebf6343c520e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#a97156a2a27c2e7fc0fccd0aee61de5a">safeClone</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thread safe cloning operation. <a href="#a97156a2a27c2e7fc0fccd0aee61de5a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#e524fd43a06d4429e2c76bef35874d4c">getSortKey</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, <a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *result, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> resultLength) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the sort key as an array of bytes from an <a class="el" href="classUnicodeString.html">UnicodeString</a>. <a href="#e524fd43a06d4429e2c76bef35874d4c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#f379292af58ae29650690a02c410bfe1">getSortKey</a> (const UChar *source, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> sourceLength, <a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *result, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> resultLength) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the sort key as an array of bytes from an UChar buffer. <a href="#f379292af58ae29650690a02c410bfe1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCollator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#685bc906ba633d0d7653089d1f1a4dc5">createInstance</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &err)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates the <a class="el" href="classCollator.html">Collator</a> object for the current default locale. <a href="#685bc906ba633d0d7653089d1f1a4dc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCollator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#8487edc8b01ce2e8267053b19ba114ee">createInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &loc, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &err)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the table-based collation object for the desired locale. <a href="#8487edc8b01ce2e8267053b19ba114ee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#6aed25d37a7937d21599685754198689">getDisplayName</a> (const <a class="el" href="classLocale.html">Locale</a> &objectLocale, const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the desired langauge. <a href="#6aed25d37a7937d21599685754198689"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#ce5e715921cbc6129449d08711c152df">getDisplayName</a> (const <a class="el" href="classLocale.html">Locale</a> &objectLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the langauge of the default locale. <a href="#ce5e715921cbc6129449d08711c152df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#f12be166591b536009fbcb636e56515f">getAvailableLocales</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> &count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Locales for which Collations are installed. <a href="#f12be166591b536009fbcb636e56515f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#cd369233c66c780d7ef230fa4fc5d972">getAvailableLocales</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> over the locales available at the time of the call, including registered locales. <a href="#cd369233c66c780d7ef230fa4fc5d972"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#a7f1d5f15b6fc722e8aace3160c52504">getKeywords</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a string enumerator of all possible keywords that are relevant to collation. <a href="#a7f1d5f15b6fc722e8aace3160c52504"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#1a1cc517b9c3b82cf8eea3956abdafc5">getKeywordValues</a> (const char *keyword, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><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="#1a1cc517b9c3b82cf8eea3956abdafc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classLocale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#23ffda18b6d183b6c62b36718416b528">getFunctionalEquivalent</a> (const char *keyword, const <a class="el" href="classLocale.html">Locale</a> &locale, <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> &isAvailable, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><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="#23ffda18b6d183b6c62b36718416b528"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="umisc_8h.html#b5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#101e1f1b5eac8264ad5274b8e8bb9eed">registerInstance</a> (<a class="el" href="classCollator.html">Collator</a> *toAdopt, const <a class="el" href="classLocale.html">Locale</a> &locale, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a new <a class="el" href="classCollator.html">Collator</a>. <a href="#101e1f1b5eac8264ad5274b8e8bb9eed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="umisc_8h.html#b5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#abab7bd7531b5697256e7e7f5437faa1">registerFactory</a> (<a class="el" href="classCollatorFactory.html">CollatorFactory</a> *toAdopt, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a new <a class="el" href="classCollatorFactory.html">CollatorFactory</a>. <a href="#abab7bd7531b5697256e7e7f5437faa1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#fb6f76b673673ddd0bbb2690d135fd56">unregister</a> (<a class="el" href="umisc_8h.html#b5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> key, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously-registered <a class="el" href="classCollator.html">Collator</a> or <a class="el" href="classCollatorFactory.html">CollatorFactory</a> using the key returned from the register call. <a href="#fb6f76b673673ddd0bbb2690d135fd56"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#771c2a750d025b9c5497210318473465">getBound</a> (const <a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *source, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> sourceLength, <a class="el" href="ucol_8h.html#a3b11e0e399df62d3048174b8309657c">UColBoundMode</a> boundType, <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> noOfLevels, <a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *result, <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> resultLength, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Produce a bound for a given sortkey and a number of levels. <a href="#771c2a750d025b9c5497210318473465"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="ucol_8h.html#3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#79465f4dba5cd6a6ee0ff1dc12f82ad9">createUCollator</a> (const char *loc, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">used only by ucol_open, not for public use <a href="#79465f4dba5cd6a6ee0ff1dc12f82ad9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#81d189c935adebdb742589212f9ba0e0">Collator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#81d189c935adebdb742589212f9ba0e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#2d56899e3a0bca4fa08a3b8a5f1752bc">Collator</a> (<a class="el" href="ucol_8h.html#cc801048729e684bcabed328be85f77a">UCollationStrength</a> collationStrength, <a class="el" href="unorm_8h.html#f317e3ace13f0ce7c86dd1ca48490ef7">UNormalizationMode</a> decompositionMode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#2d56899e3a0bca4fa08a3b8a5f1752bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#57d135eb7bb3a137536554f2bd979b05">Collator</a> (const <a class="el" href="classCollator.html">Collator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#57d135eb7bb3a137536554f2bd979b05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#da9ebd7bfb43f664a1ac43dd7b78967d">setLocales</a> (const <a class="el" href="classLocale.html">Locale</a> &requestedLocale, const <a class="el" href="classLocale.html">Locale</a> &validLocale)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used internally by registraton to define the requested and valid locales. <a href="#da9ebd7bfb43f664a1ac43dd7b78967d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6a9dabbbc5633905fce8c282b031ffc"></a><!-- doxytag: member="Collator::CFactory" ref="b6a9dabbbc5633905fce8c282b031ffc" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#b6a9dabbbc5633905fce8c282b031ffc">CFactory</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="80bbb65f28838eba42b00d611909e8d3"></a><!-- doxytag: member="Collator::SimpleCFactory" ref="80bbb65f28838eba42b00d611909e8d3" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#80bbb65f28838eba42b00d611909e8d3">SimpleCFactory</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dbce2a122c7c040633075706b9867183"></a><!-- doxytag: member="Collator::ICUCollatorFactory" ref="dbce2a122c7c040633075706b9867183" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#dbce2a122c7c040633075706b9867183">ICUCollatorFactory</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49f66cb9f432dd77eefae3d1ecaeb9f5"></a><!-- doxytag: member="Collator::ICUCollatorService" ref="49f66cb9f432dd77eefae3d1ecaeb9f5" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollator.html#49f66cb9f432dd77eefae3d1ecaeb9f5">ICUCollatorService</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classCollator.html">Collator</a></code> class performs locale-sensitive string comparison.
<p>
<br>
You use this class to build searching and sorting routines for natural language text.<br>
<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>
<code><a class="el" href="classCollator.html">Collator</a></code> is an abstract base class. Subclasses implement specific collation strategies. One subclass, <code><a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a></code>, is currently provided and is applicable to a wide set of languages. Other subclasses may be created to handle more specialized needs. <p>
Like other locale-sensitive classes, you can use the static factory method, <code>createInstance</code>, to obtain the appropriate <code><a class="el" href="classCollator.html">Collator</a></code> object for a given locale. You will only need to look at the subclasses of <code><a class="el" href="classCollator.html">Collator</a></code> if you need to understand the details of a particular collation strategy or if you need to modify that strategy. <p>
The following example shows how to compare two strings using the <code><a class="el" href="classCollator.html">Collator</a></code> for the default locale. <blockquote> <pre>
<div class="fragment"><pre class="fragment"> <span class="comment">// Compare two strings in the default locale</span>
<a class="code" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> success = <a class="code" href="utypes_8h.html#3343c1c8a8377277046774691c98d78ca43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;
<a class="code" href="classCollator.html">Collator</a>* myCollator = <a class="code" href="classCollator.html#685bc906ba633d0d7653089d1f1a4dc5">Collator::createInstance</a>(success);
<span class="keywordflow">if</span> (myCollator-><a class="code" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare</a>(<span class="stringliteral">"abc"</span>, <span class="stringliteral">"ABC"</span>) < 0)
cout << <span class="stringliteral">"abc is less than ABC"</span> << endl;
<span class="keywordflow">else</span>
cout << <span class="stringliteral">"abc is greater than or equal to ABC"</span> << endl;
</pre></div>
</pre> </blockquote> <p>
You can set a <code><a class="el" href="classCollator.html">Collator</a></code>'s <em>strength</em> property to determine the level of difference considered significant in comparisons. Five strengths are provided: <code>PRIMARY</code>, <code>SECONDARY</code>, <code>TERTIARY</code>, <code>QUATERNARY</code> and <code>IDENTICAL</code>. The exact assignment of strengths to language features is locale dependant. For example, in Czech, "e" and "f" are considered primary differences, while "e" and "\u00EA" are secondary differences, "e" and "E" are tertiary differences and "e" and "e" are identical. The following shows how both case and accents could be ignored for US English. <blockquote> <pre>
<div class="fragment"><pre class="fragment"> <span class="comment">//Get the Collator for US English and set its strength to PRIMARY</span>
<a class="code" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> success = <a class="code" href="utypes_8h.html#3343c1c8a8377277046774691c98d78ca43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;
<a class="code" href="classCollator.html">Collator</a>* usCollator = <a class="code" href="classCollator.html#685bc906ba633d0d7653089d1f1a4dc5">Collator::createInstance</a>(Locale::US, success);
usCollator-><a class="code" href="classCollator.html#0337d30970c7b73a6885a31d6d7d2afa">setStrength</a>(Collator::PRIMARY);
<span class="keywordflow">if</span> (usCollator-><a class="code" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare</a>(<span class="stringliteral">"abc"</span>, <span class="stringliteral">"ABC"</span>) == 0)
cout << <span class="stringliteral">"'abc' and 'ABC' strings are equivalent with strength PRIMARY"</span> << endl;
</pre></div>
</pre> </blockquote> <p>
For comparing strings exactly once, the <code>compare</code> method provides the best performance. When sorting a list of strings however, it is generally necessary to compare each string multiple times. In this case, sort keys provide better performance. The <code>getSortKey</code> methods convert a string to a series of bytes that can be compared bitwise against other sort keys using <code>strcmp()</code>. Sort keys are written as zero-terminated byte strings. They consist of several substrings, one for each collation strength level, that are delimited by 0x01 bytes. If the string code points are appended for UCOL_IDENTICAL, then they are processed for correct code point order comparison and may contain 0x01 bytes but not zero bytes. <p>
An older set of APIs returns a <code><a class="el" href="classCollationKey.html">CollationKey</a></code> object that wraps the sort key bytes instead of returning the bytes themselves. Its use is deprecated, but it is still available for compatibility with Java. <p>
<b>Note:</b> <code><a class="el" href="classCollator.html">Collator</a></code>s with different <a class="el" href="classLocale.html">Locale</a>, and CollationStrength settings will return different sort orders for the same set of strings. Locales have specific collation rules, and the way in which secondary and tertiary differences are taken into account, for example, will result in a different sorting order for same strings. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> <p>
<a class="el" href="classCollationKey.html">CollationKey</a> <p>
<a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> <p>
<a class="el" href="classLocale.html">Locale</a> <p>
<a class="el" href="classNormalizer.html">Normalizer</a> </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd>2.0 11/15/01 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="coll_8h-source.html#l00175">175</a> of file <a class="el" href="coll_8h-source.html">coll.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="2872c36ad74fc1100331783afe6b38d5"></a><!-- doxytag: member="Collator::ECollationStrength" ref="2872c36ad74fc1100331783afe6b38d5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">Collator::ECollationStrength</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Base letter represents a primary difference.
<p>
Set comparison level to PRIMARY to ignore secondary and tertiary differences.<br>
Use this to set the strength of a <a class="el" href="classCollator.html">Collator</a> object.<br>
Example of primary difference, "abc" < "abd"<p>
Diacritical differences on the same base letter represent a secondary difference. Set comparison level to SECONDARY to ignore tertiary differences. Use this to set the strength of a <a class="el" href="classCollator.html">Collator</a> object.<br>
Example of secondary difference, "&auml;" >> "a".<p>
Uppercase and lowercase versions of the same character represents a tertiary difference. Set comparison level to TERTIARY to include all comparison differences. Use this to set the strength of a <a class="el" href="classCollator.html">Collator</a> object.<br>
Example of tertiary difference, "abc" <<< "ABC".<p>
Two characters are considered "identical" when they have the same unicode spellings.<br>
For example, "&auml;" == "&auml;".<p>
UCollationStrength is also used to determine the strength of sort keys generated from <a class="el" href="classCollator.html">Collator</a> objects. <dl compact><dt><b><a class="el" href="stable.html#_stable002124">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coll_8h-source.html#l00205">205</a> of file <a class="el" href="coll_8h-source.html">coll.h</a>.
</div>
</div><p>
<a class="anchor" name="05f22f81363f2613bea18a632b67686f"></a><!-- doxytag: member="Collator::EComparisonResult" ref="05f22f81363f2613bea18a632b67686f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">Collator::EComparisonResult</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
LESS is returned if source string is compared to be less than target string in the <a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare()</a> method.
<p>
EQUAL is returned if source string is compared to be equal to target string in the <a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare()</a> method. GREATER is returned if source string is compared to be greater than target string in the <a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare()</a> method. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">Collator::compare</a> </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000183">Deprecated:</a></b></dt><dd>ICU 2.6. Use C enum UCollationResult defined in <a class="el" href="ucol_8h.html">ucol.h</a> </dd></dl>
<p>
Definition at line <a class="el" href="coll_8h-source.html#l00224">224</a> of file <a class="el" href="coll_8h-source.html">coll.h</a>.
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="eed400dfca4ef25d95509265a1566ce9"></a><!-- doxytag: member="Collator::~Collator" ref="eed400dfca4ef25d95509265a1566ce9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Collator::~Collator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable002125">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="81d189c935adebdb742589212f9ba0e0"></a><!-- doxytag: member="Collator::Collator" ref="81d189c935adebdb742589212f9ba0e0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Collator::Collator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
Constructor is different from the old default <a class="el" href="classCollator.html">Collator</a> constructor. The task for determing the default collation strength and normalization mode is left to the child class. <dl compact><dt><b><a class="el" href="stable.html#_stable002161">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2d56899e3a0bca4fa08a3b8a5f1752bc"></a><!-- doxytag: member="Collator::Collator" ref="2d56899e3a0bca4fa08a3b8a5f1752bc" args="(UCollationStrength collationStrength, UNormalizationMode decompositionMode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Collator::Collator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#cc801048729e684bcabed328be85f77a">UCollationStrength</a> </td>
<td class="paramname"> <em>collationStrength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unorm_8h.html#f317e3ace13f0ce7c86dd1ca48490ef7">UNormalizationMode</a> </td>
<td class="paramname"> <em>decompositionMode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Empty constructor, does not handle the arguments. This constructor is done for backward compatibility with 1.7 and 1.8. The task for handling the argument collation strength and normalization mode is left to the child class. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>collationStrength</em> </td><td>collation strength </td></tr>
<tr><td valign="top"></td><td valign="top"><em>decompositionMode</em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000192">Deprecated:</a></b></dt><dd>ICU 2.4. Subclasses should use the default constructor instead and handle the strength and normalization mode themselves. </dd></dl>
</div>
</div><p>
<a class="anchor" name="57d135eb7bb3a137536554f2bd979b05"></a><!-- doxytag: member="Collator::Collator" ref="57d135eb7bb3a137536554f2bd979b05" args="(const Collator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Collator::Collator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollator.html">Collator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td><a class="el" href="classCollator.html">Collator</a> object to be copied from </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002162">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="58fa13068a2e4e07a8835f6c0f8c18b6"></a><!-- doxytag: member="Collator::operator==" ref="58fa13068a2e4e07a8835f6c0f8c18b6" args="(const Collator &other) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Collator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollator.html">Collator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if "other" is the same as "this".
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td><a class="el" href="classCollator.html">Collator</a> object to be compared </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if other is the same as this. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002126">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#270d4f6ee757818e2ae675df1c8f0238">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="8c79adc0d04be5a7b82ac1991d445909"></a><!-- doxytag: member="Collator::operator!=" ref="8c79adc0d04be5a7b82ac1991d445909" args="(const Collator &other) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Collator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollator.html">Collator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if "other" is not the same as "this".
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td><a class="el" href="classCollator.html">Collator</a> object to be compared </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if other is not the same as this. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002127">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#b8ec2d43525f62148b627dc936f892b7">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="5b7873505ee31c3745c207cf45d114b4"></a><!-- doxytag: member="Collator::clone" ref="5b7873505ee31c3745c207cf45d114b4" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html">Collator</a>* Collator::clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Makes a shallow copy of the current object.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a copy of this object </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002128">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#fc3925de9f5b4b8c58192721cbb5bc57">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="685bc906ba633d0d7653089d1f1a4dc5"></a><!-- doxytag: member="Collator::createInstance" ref="685bc906ba633d0d7653089d1f1a4dc5" args="(UErrorCode &err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCollator.html">Collator</a>* Collator::createInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>err</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates the <a class="el" href="classCollator.html">Collator</a> object for the current default locale.
<p>
The default locale is determined by <a class="el" href="classLocale.html#c12d6326f2d283f5643f6b6caacfe88c">Locale::getDefault</a>. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#527f2c69e6b2e3b2c53ad8a99fb36711">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the collation object of the default locale.(for example, en_US) </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocale.html#c12d6326f2d283f5643f6b6caacfe88c">Locale::getDefault</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002129">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8487edc8b01ce2e8267053b19ba114ee"></a><!-- doxytag: member="Collator::createInstance" ref="8487edc8b01ce2e8267053b19ba114ee" args="(const Locale &loc, UErrorCode &err)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCollator.html">Collator</a>* Collator::createInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>err</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the table-based collation object for the desired locale.
<p>
The resource of the desired locale will be loaded by ResourceLoader. Locale::ENGLISH is the base collation table and all other languages are built on top of it with additional language-specific modifications. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#527f2c69e6b2e3b2c53ad8a99fb36711">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>loc</em> </td><td>The locale ID for which to open a collator. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the created table-based collation object based on the desired locale. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocale.html">Locale</a> <p>
ResourceLoader </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002130">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ca611b586fa47a756d2b29996f713182"></a><!-- doxytag: member="Collator::compare" ref="ca611b586fa47a756d2b29996f713182" args="(const UnicodeString &source, const UnicodeString &target) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The comparison function compares the character data stored in two different strings.
<p>
Returns information about whether a string is less than, greater than or equal to another string. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the string that is to be compared with the source string. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns a byte value. GREATER if source is greater than target; EQUAL if source is equal to target; LESS if source is less than target </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000184">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with UErrorCode & </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#49b2017fd4861a6361e6b568d887adc2">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="87d53bab5e900d89ad27fd61ea6b985d"></a><!-- doxytag: member="Collator::compare" ref="87d53bab5e900d89ad27fd61ea6b985d" args="(const UnicodeString &source, const UnicodeString &target, UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The comparison function compares the character data stored in two different strings.
<p>
Returns information about whether a string is less than, greater than or equal to another string. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the string that is to be compared with the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>possible error code </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable002131">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#b011371ceb1f45df5de1a458d7612aa8">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="e5dcb5135932d73ff6700b66d119b39f"></a><!-- doxytag: member="Collator::compare" ref="e5dcb5135932d73ff6700b66d119b39f" args="(const UnicodeString &source, const UnicodeString &target, int32_t length) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.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="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>length</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Does the same thing as compare but limits the comparison to a specified length.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the string that is to be compared with the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length the comparison is limited to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns a byte value. GREATER if source (up to the specified length) is greater than target; EQUAL if source (up to specified length) is equal to target; LESS if source (up to the specified length) is less than target. </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000185">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with UErrorCode & </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#4c013af7a29d4b307be548dfc631f65c">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="550d7d5a20e5b885f93331f5fa508e40"></a><!-- doxytag: member="Collator::compare" ref="550d7d5a20e5b885f93331f5fa508e40" args="(const UnicodeString &source, const UnicodeString &target, int32_t length, UErrorCode &status) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> Collator::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.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="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Does the same thing as compare but limits the comparison to a specified length.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the string that is to be compared with the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length the comparison is limited to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>possible error code </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable002132">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#1acb41e02ed136ecda2441796b727271">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="6ed570968d689706df2e232fdab844fa"></a><!-- doxytag: member="Collator::compare" ref="6ed570968d689706df2e232fdab844fa" args="(const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html#05f22f81363f2613bea18a632b67686f">EComparisonResult</a> Collator::compare </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>targetLength</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The comparison function compares the character data stored in two different string arrays.
<p>
Returns information about whether a string array is less than, greater than or equal to another string array. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string array to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceLength</em> </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 valign="top"></td><td valign="top"><em>target</em> </td><td>the string that is to be compared with the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>targetLength</em> </td><td>the length of the target string array. If this value is equal to -1, the string array is null-terminated. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Returns a byte value. GREATER if source is greater than target; EQUAL if source is equal to target; LESS if source is less than target </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000186">Deprecated:</a></b></dt><dd>ICU 2.6 use the overload with UErrorCode & </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#522f1279a6f70a1e94564f669ae4d410">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="5f32ec22ac5ed66bff8d7707db9260d7"></a><!-- doxytag: member="Collator::compare" ref="5f32ec22ac5ed66bff8d7707db9260d7" args="(const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength, UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> Collator::compare </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The comparison function compares the character data stored in two different string arrays.
<p>
Returns information about whether a string array is less than, greater than or equal to another string array. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string array to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceLength</em> </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 valign="top"></td><td valign="top"><em>target</em> </td><td>the string that is to be compared with the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>targetLength</em> </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 valign="top"></td><td valign="top"><em>status</em> </td><td>possible error code </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable002133">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#6d410b9e3a7a3c353ca961ffbe6f5fdb">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="b48ddb212e12b9ef4ffa7163e2d7810a"></a><!-- doxytag: member="Collator::getCollationKey" ref="b48ddb212e12b9ef4ffa7163e2d7810a" args="(const UnicodeString &source, CollationKey &key, UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollationKey.html">CollationKey</a>& Collator::getCollationKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classCollationKey.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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Transforms the string into a series of characters that can be compared with <a class="el" href="classCollationKey.html#9770a24d18b10909bad10f4cccdae3f6">CollationKey::compareTo</a>.
<p>
It is not possible to restore the original string from the chars in the sort key. The generated sort key handles only a limited number of ignorable characters. <p>
Use CollationKey::equals or CollationKey::compare to compare the generated sort keys. If the source string is null, a null collation key will be returned. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be transformed into a sort key. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the collation key to be filled in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the collation key of the string based on the collation rules. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>CollationKey::compare </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000187">Deprecated:</a></b></dt><dd>ICU 2.8 Use getSortKey(...) instead </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#509690ecc2c4de4683cc226b4317174f">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="fd733f040738213f0e46847b1e31cf6a"></a><!-- doxytag: member="Collator::getCollationKey" ref="fd733f040738213f0e46847b1e31cf6a" args="(const UChar *source, int32_t sourceLength, CollationKey &key, UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollationKey.html">CollationKey</a>& Collator::getCollationKey </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCollationKey.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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Transforms the string into a series of characters that can be compared with <a class="el" href="classCollationKey.html#9770a24d18b10909bad10f4cccdae3f6">CollationKey::compareTo</a>.
<p>
It is not possible to restore the original string from the chars in the sort key. The generated sort key handles only a limited number of ignorable characters. <p>
Use CollationKey::equals or CollationKey::compare to compare the generated sort keys. <p>
If the source string is null, a null collation key will be returned. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be transformed into a sort key. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceLength</em> </td><td>length of the collation key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the collation key to be filled in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the collation key of the string based on the collation rules. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd>CollationKey::compare </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000188">Deprecated:</a></b></dt><dd>ICU 2.8 Use getSortKey(...) instead </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#36b0939e2dfb7c47fef177e0eec93700">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="989efcbd6664efd0a8e738a2c1d3f357"></a><!-- doxytag: member="Collator::hashCode" ref="989efcbd6664efd0a8e738a2c1d3f357" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> Collator::hashCode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generates the hash code for the collation object.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable002134">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#326891c5ae3763fab6e8e00b2289a413">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="3a871f1b08787fde0a9a4fef135d2928"></a><!-- doxytag: member="Collator::getLocale" ref="3a871f1b08787fde0a9a4fef135d2928" args="(ULocDataLocaleType type, UErrorCode &status) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classLocale.html">Locale</a> Collator::getLocale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#df053345d343f8d82ae080f7a5871f34">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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the locale of the <a class="el" href="classCollator.html">Collator</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </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">uloc.h</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>locale where the collation data lives. If the collator was instantiated from rules, locale is empty. </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000189">Deprecated:</a></b></dt><dd>ICU 2.8 This API is under consideration for revision in ICU 3.0. </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#3d00b511fe6fc791bdf728c50a98c45c">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="ea0a4ed08d95791194c307f95e4cd8f2"></a><!-- doxytag: member="Collator::greater" ref="ea0a4ed08d95791194c307f95e4cd8f2" args="(const UnicodeString &source, const UnicodeString &target) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Collator::greater </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience method for comparing two strings based on the collation rules.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the target string to be compared with. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the first string is greater than the second one, according to the collation rules. false, otherwise. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">Collator::compare</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002135">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a87d324253cf094dc48a7a1e9b7b6afa"></a><!-- doxytag: member="Collator::greaterOrEqual" ref="a87d324253cf094dc48a7a1e9b7b6afa" args="(const UnicodeString &source, const UnicodeString &target) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Collator::greaterOrEqual </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience method for comparing two strings based on the collation rules.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the target string to be compared with. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the first string is greater than or equal to the second one, according to the collation rules. false, otherwise. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">Collator::compare</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002136">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e00999fae1a46616421f3469c53b82f3"></a><!-- doxytag: member="Collator::equals" ref="e00999fae1a46616421f3469c53b82f3" args="(const UnicodeString &source, const UnicodeString &target) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Collator::equals </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>target</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Convenience method for comparing two strings based on the collation rules.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the source string to be compared with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>the target string to be compared with. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the strings are equal according to the collation rules. false, otherwise. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html#ca611b586fa47a756d2b29996f713182">Collator::compare</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002137">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="bbd68b496b6063c5a09a35ce96e4ce93"></a><!-- doxytag: member="Collator::getStrength" ref="bbd68b496b6063c5a09a35ce96e4ce93" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">ECollationStrength</a> Collator::getStrength </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determines the minimum strength that will be use in comparison or transformation.
<p>
E.g. with strength == SECONDARY, the tertiary difference is ignored <p>
E.g. with strength == PRIMARY, the secondary and tertiary difference are ignored. <dl class="return" compact><dt><b>Returns:</b></dt><dd>the current comparison level. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html#0337d30970c7b73a6885a31d6d7d2afa">Collator::setStrength</a> </dd></dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000190">Deprecated:</a></b></dt><dd>ICU 2.6 Use getAttribute(UCOL_STRENGTH...) instead </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#4687629722826dd02625049df0dcff2f">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="0337d30970c7b73a6885a31d6d7d2afa"></a><!-- doxytag: member="Collator::setStrength" ref="0337d30970c7b73a6885a31d6d7d2afa" args="(ECollationStrength newStrength)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Collator::setStrength </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCollator.html#2872c36ad74fc1100331783afe6b38d5">ECollationStrength</a> </td>
<td class="paramname"> <em>newStrength</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the minimum strength to be used in comparison or transformation.
<p>
Example of use: <pre>
<div class="fragment"><pre class="fragment"> <a class="code" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> status = <a class="code" href="utypes_8h.html#3343c1c8a8377277046774691c98d78ca43dbfc9499c5f911d04e1a0ca3bf6f9">U_ZERO_ERROR</a>;
<a class="code" href="classCollator.html">Collator</a>*myCollation = <a class="code" href="classCollator.html#685bc906ba633d0d7653089d1f1a4dc5">Collator::createInstance</a>(Locale::US, status);
<span class="keywordflow">if</span> (<a class="code" href="utypes_8h.html#4d202200b6aa6f3c965ea370e0c8155f">U_FAILURE</a>(status)) <span class="keywordflow">return</span>;
myCollation-><a class="code" href="classCollator.html#0337d30970c7b73a6885a31d6d7d2afa">setStrength</a>(Collator::PRIMARY);
<span class="comment">// result will be "abc" == "ABC"</span>
<span class="comment">// tertiary differences will be ignored</span>
Collator::ComparisonResult result = myCollation-><a class="code" href="classCollator.html#ca611b586fa47a756d2b29996f713182">compare</a>(<span class="stringliteral">"abc"</span>, <span class="stringliteral">"ABC"</span>);
</pre></div>
</pre> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html#bbd68b496b6063c5a09a35ce96e4ce93">Collator::getStrength</a> </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newStrength</em> </td><td>the new comparison level. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000191">Deprecated:</a></b></dt><dd>ICU 2.6 Use setAttribute(UCOL_STRENGTH...) instead </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#124ab414f1dc23cb3a5acc3f61e6a2d2">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="6aed25d37a7937d21599685754198689"></a><!-- doxytag: member="Collator::getDisplayName" ref="6aed25d37a7937d21599685754198689" args="(const Locale &objectLocale, const Locale &displayLocale, UnicodeString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classUnicodeString.html">UnicodeString</a>& Collator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the desired langauge.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>objectLocale</em> </td><td>must be from getAvailableLocales </td></tr>
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>specifies the desired locale for output </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the fill-in parameter of the return value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>display-able name of the object for the object locale in the desired language </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002138">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ce5e715921cbc6129449d08711c152df"></a><!-- doxytag: member="Collator::getDisplayName" ref="ce5e715921cbc6129449d08711c152df" args="(const Locale &objectLocale, UnicodeString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classUnicodeString.html">UnicodeString</a>& Collator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the langauge of the default locale.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>objectLocale</em> </td><td>must be from getAvailableLocales </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the fill-in parameter of the return value </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>name of the object for the desired locale in the default language </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002139">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f12be166591b536009fbcb636e56515f"></a><!-- doxytag: member="Collator::getAvailableLocales" ref="f12be166591b536009fbcb636e56515f" args="(int32_t &count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>* Collator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> & </td>
<td class="paramname"> <em>count</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the set of Locales for which Collations are installed.
<p>
Note this does not include locales supported by registered collators. If collators might have been registered, use the overload of getAvailableLocales that returns a <a class="el" href="classStringEnumeration.html">StringEnumeration</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>the output parameter of number of elements in the locale list </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the list of available locales for which collations are installed </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002140">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="cd369233c66c780d7ef230fa4fc5d972"></a><!-- doxytag: member="Collator::getAvailableLocales" ref="cd369233c66c780d7ef230fa4fc5d972" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a>* Collator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> over the locales available at the time of the call, including registered locales.
<p>
If a severe error occurs (such as out of memory condition) this will return null. If there is no locale data, an empty enumeration will be returned. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> over the locales available at the time of the call </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002141">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a7f1d5f15b6fc722e8aace3160c52504"></a><!-- doxytag: member="Collator::getKeywords" ref="a7f1d5f15b6fc722e8aace3160c52504" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a>* Collator::getKeywords </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a string enumerator of all possible keywords that are relevant to collation.
<p>
At this point, the only recognized keyword for this service is "collation". <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>input-output error code </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a string enumeration over locale strings. The caller is responsible for closing the result. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002142">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1a1cc517b9c3b82cf8eea3956abdafc5"></a><!-- doxytag: member="Collator::getKeywordValues" ref="1a1cc517b9c3b82cf8eea3956abdafc5" args="(const char *keyword, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a>* Collator::getKeywordValues </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keyword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Given a keyword, create a string enumeration of all values for that keyword that are currently in use.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keyword</em> </td><td>a particular keyword as enumerated by ucol_getKeywords. If any other keyword is passed in, status is set to U_ILLEGAL_ARGUMENT_ERROR. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>input-output error code </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a string enumeration over collation keyword values, or NULL upon error. The caller is responsible for deleting the result. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002143">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="23ffda18b6d183b6c62b36718416b528"></a><!-- doxytag: member="Collator::getFunctionalEquivalent" ref="23ffda18b6d183b6c62b36718416b528" args="(const char *keyword, const Locale &locale, UBool &isAvailable, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classLocale.html">Locale</a> Collator::getFunctionalEquivalent </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>keyword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> & </td>
<td class="paramname"> <em>isAvailable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service.
<p>
If two locales return the same result, then collators instantiated for these locales will behave equivalently. The converse is not always true; two collators may in fact be equivalent, but return different results, due to internal details. The return result has no other meaning than that stated above, and implies nothing as to the relationship between the two locales. This is intended for use by applications who wish to cache collators, or otherwise reuse collators when possible. The functional equivalent may change over time. For more information, please see the <a href="http://icu-project.org/userguide/locale.html#services">Locales and Services</a> section of the ICU User Guide. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keyword</em> </td><td>a particular keyword as enumerated by ucol_getKeywords. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>the requested locale </td></tr>
<tr><td valign="top"></td><td valign="top"><em>isAvailable</em> </td><td>reference to a fillin parameter that indicates whether the requested locale was 'available' to the collation service. A locale is defined as 'available' if it physically exists within the collation locale data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>reference to input-output error code </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the functionally equivalent collation locale, or the root locale upon error. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002144">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="101e1f1b5eac8264ad5274b8e8bb9eed"></a><!-- doxytag: member="Collator::registerInstance" ref="101e1f1b5eac8264ad5274b8e8bb9eed" args="(Collator *toAdopt, const Locale &locale, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umisc_8h.html#b5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> Collator::registerInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCollator.html">Collator</a> * </td>
<td class="paramname"> <em>toAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a new <a class="el" href="classCollator.html">Collator</a>.
<p>
The collator will be adopted. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toAdopt</em> </td><td>the <a class="el" href="classCollator.html">Collator</a> instance to be adopted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>the locale with which the collator will be associated </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a registry key that can be used to unregister this collator </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002145">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="abab7bd7531b5697256e7e7f5437faa1"></a><!-- doxytag: member="Collator::registerFactory" ref="abab7bd7531b5697256e7e7f5437faa1" args="(CollatorFactory *toAdopt, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umisc_8h.html#b5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> Collator::registerFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCollatorFactory.html">CollatorFactory</a> * </td>
<td class="paramname"> <em>toAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a new <a class="el" href="classCollatorFactory.html">CollatorFactory</a>.
<p>
The factory will be adopted. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toAdopt</em> </td><td>the <a class="el" href="classCollatorFactory.html">CollatorFactory</a> instance to be adopted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a registry key that can be used to unregister this collator </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002146">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fb6f76b673673ddd0bbb2690d135fd56"></a><!-- doxytag: member="Collator::unregister" ref="fb6f76b673673ddd0bbb2690d135fd56" args="(URegistryKey key, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> Collator::unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umisc_8h.html#b5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unregister a previously-registered <a class="el" href="classCollator.html">Collator</a> or <a class="el" href="classCollatorFactory.html">CollatorFactory</a> using the key returned from the register call.
<p>
Key becomes invalid after a successful call and should not be used again. The object corresponding to the key will be deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the registry key returned by a previous call to registerInstance </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE if the collator for the key was successfully unregistered </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002147">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a0be92c2d066910f88b27d914b4fb117"></a><!-- doxytag: member="Collator::getVersion" ref="a0be92c2d066910f88b27d914b4fb117" args="(UVersionInfo info) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Collator::getVersion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uversion_8h.html#61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"> <em>info</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the version information for a <a class="el" href="classCollator.html">Collator</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>the version # information, the result will be filled in </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002148">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#c3e91383098974cd3cd4db490b5b7dcd">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="eaf10ab8b08d195a294a9b15aa7195da"></a><!-- doxytag: member="Collator::getDynamicClassID" ref="eaf10ab8b08d195a294a9b15aa7195da" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> Collator::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a unique class ID POLYMORPHICALLY.
<p>
Pure virtual method. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic <a class="el" href="classCollator.html#58fa13068a2e4e07a8835f6c0f8c18b6">operator==()</a> and <a class="el" href="classCollator.html#5b7873505ee31c3745c207cf45d114b4">clone()</a> methods call this method. <dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable002149">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#ce1dd31fb2c6f2c07dfebe8fd240ec37">UObject</a>.
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#475f2ae0796fc004c76c10d30b991ca5">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="132f1d7ad918bc1f4dcb956fd74ea808"></a><!-- doxytag: member="Collator::setAttribute" ref="132f1d7ad918bc1f4dcb956fd74ea808" args="(UColAttribute attr, UColAttributeValue value, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Collator::setAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#583fbe7fc4a850e2fcc692e766d2826c">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#cc801048729e684bcabed328be85f77a">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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Universal attribute setter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>attribute type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>attribute value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>to indicate whether the operation went on smoothly or there were errors </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002150">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#c1817cbafe92cd3184d8712a8b72d746">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="84c6c013a46196d829f71fa843ae7933"></a><!-- doxytag: member="Collator::getAttribute" ref="84c6c013a46196d829f71fa843ae7933" args="(UColAttribute attr, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="ucol_8h.html#cc801048729e684bcabed328be85f77a">UColAttributeValue</a> Collator::getAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#583fbe7fc4a850e2fcc692e766d2826c">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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Universal attribute getter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>attr</em> </td><td>attribute type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>to indicate whether the operation went on smoothly or there were errors </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>attribute value </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002151">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#4b104673bfec94c58f91478f14bcd286">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="b6e4fc13e278beca8a39539dc326a913"></a><!-- doxytag: member="Collator::setVariableTop" ref="b6e4fc13e278beca8a39539dc326a913" args="(const UChar *varTop, int32_t len, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> Collator::setVariableTop </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>varTop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the variable top to a collation element value of a string supplied.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>varTop</em> </td><td>one or more (if contraction) UChars to which the variable top should be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of variable top string. If -1 it is considered to be zero terminated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable002152">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#1049c65c7c51c9540ca91bae25bf9f54">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="dbf3ad5122866f9a16d39ca07779ddce"></a><!-- doxytag: member="Collator::setVariableTop" ref="dbf3ad5122866f9a16d39ca07779ddce" args="(const UnicodeString varTop, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> Collator::setVariableTop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the variable top to a collation element value of a string supplied.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>varTop</em> </td><td>an <a class="el" href="classUnicodeString.html">UnicodeString</a> size 1 or more (if contraction) of UChars to which the variable top should be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable002153">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#828496b246626823fd96abe7dcf86782">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="fc34e06d5d3675e6e6ad26a1ee303690"></a><!-- doxytag: member="Collator::setVariableTop" ref="fc34e06d5d3675e6e6ad26a1ee303690" args="(const uint32_t varTop, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Collator::setVariableTop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</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#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the variable top to a collation element value supplied.
<p>
Variable top is set to the upper 16 bits. Lower 16 bits are ignored. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>varTop</em> </td><td>CE value, as returned by setVariableTop or ucol)getVariableTop </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code (not changed by function) </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002154">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#da7dd7ac546e91febadd47c68df9c102">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="f04197e6c46b619cb1afbd523c333643"></a><!-- doxytag: member="Collator::getVariableTop" ref="f04197e6c46b619cb1afbd523c333643" args="(UErrorCode &status) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> Collator::getVariableTop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the variable top value of a <a class="el" href="classCollator.html">Collator</a>.
<p>
Lower 16 bits are undefined and should be ignored. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code (not changed by function). If error code is set, the return value is undefined. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002155">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#9ca19126249015219dcfea19339d2e5b">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="a62e72fedfe466e279f4ebf6343c520e"></a><!-- doxytag: member="Collator::getTailoredSet" ref="a62e72fedfe466e279f4ebf6343c520e" args="(UErrorCode &status) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeSet.html">UnicodeSet</a>* Collator::getTailoredSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an <a class="el" href="classUnicodeSet.html">UnicodeSet</a> that contains all the characters and sequences tailored in this collator.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code of the operation </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to a <a class="el" href="classUnicodeSet.html">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 compact><dt><b><a class="el" href="stable.html#_stable002156">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#40d5958bd18ed0da6baf0324c37769a5">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="a97156a2a27c2e7fc0fccd0aee61de5a"></a><!-- doxytag: member="Collator::safeClone" ref="a97156a2a27c2e7fc0fccd0aee61de5a" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html">Collator</a>* Collator::safeClone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Thread safe cloning operation.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the new clone, user should remove it. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002157">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#b58b1bbb98649f03131fe8b4dcd7b109">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="e524fd43a06d4429e2c76bef35874d4c"></a><!-- doxytag: member="Collator::getSortKey" ref="e524fd43a06d4429e2c76bef35874d4c" args="(const UnicodeString &source, uint8_t *result, int32_t resultLength) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> Collator::getSortKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>resultLength</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the sort key as an array of bytes from an <a class="el" href="classUnicodeString.html">UnicodeString</a>.
<p>
Sort key byte arrays are zero-terminated and can be compared using strcmp(). <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>string to be processed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>buffer to store result in. If NULL, number of bytes needed will be returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>length of the result buffer. If if not enough the buffer will be filled to capacity. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes needed for storing the sort key </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002158">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#572804441daa3ff64895a75b87991369">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="f379292af58ae29650690a02c410bfe1"></a><!-- doxytag: member="Collator::getSortKey" ref="f379292af58ae29650690a02c410bfe1" args="(const UChar *source, int32_t sourceLength, uint8_t *result, int32_t resultLength) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> Collator::getSortKey </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>resultLength</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the sort key as an array of bytes from an UChar buffer.
<p>
Sort key byte arrays are zero-terminated and can be compared using strcmp(). <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>string to be processed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceLength</em> </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 valign="top"></td><td valign="top"><em>result</em> </td><td>buffer to store result in. If NULL, number of bytes needed will be returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>length of the result buffer. If if not enough the buffer will be filled to capacity. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of bytes needed for storing the sort key </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002159">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedCollator.html#9c185650b038aa1d64f01dbc6fdfbfbb">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="771c2a750d025b9c5497210318473465"></a><!-- doxytag: member="Collator::getBound" ref="771c2a750d025b9c5497210318473465" args="(const uint8_t *source, int32_t sourceLength, UColBoundMode boundType, uint32_t noOfLevels, uint8_t *result, int32_t resultLength, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> Collator::getBound </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a3b11e0e399df62d3048174b8309657c">UColBoundMode</a> </td>
<td class="paramname"> <em>boundType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#435d1572bf3f880d55459d9805097f62">uint32_t</a> </td>
<td class="paramname"> <em>noOfLevels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#ba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>resultLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Produce a bound for a given sortkey and a number of levels.
<p>
Return value is always the number of bytes needed, regardless of whether the result buffer was big enough or even valid.<br>
Resulting bounds can be used to produce a range of strings that are between upper and lower bounds. For example, if bounds are produced for a sortkey of string "smith", strings between upper and lower bounds with one level would include "Smith", "SMITH", "sMiTh".<br>
There are two upper bounds that can be produced. If UCOL_BOUND_UPPER is produced, strings matched would be as above. However, if bound produced using UCOL_BOUND_UPPER_LONG is used, the above example will also match "Smithsonian" and similar.<br>
For more on usage, see example in cintltst/capitst.c in procedure TestBounds. Sort keys may be compared using <code>strcmp</code>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The source sortkey. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceLength</em> </td><td>The length of source, or -1 if null-terminated. (If an unmodified sortkey is passed, it is always null terminated). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>boundType</em> </td><td>Type of bound required. It can be UCOL_BOUND_LOWER, which produces a lower inclusive bound, UCOL_BOUND_UPPER, that produces upper bound that matches strings of the same length or UCOL_BOUND_UPPER_LONG that matches strings that have the same starting substring as the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>noOfLevels</em> </td><td>Number of levels required in the resulting bound (for most uses, the recommended value is 1). See users guide for explanation on number of levels a sortkey can have. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>A pointer to a buffer to receive the resulting sortkey. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>The maximum size of result. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Used for returning error code if something went wrong. If the number of levels requested is higher than the number of levels in the source key, a warning (U_SORT_KEY_TOO_SHORT_WARNING) is issued. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The size needed to fully store the bound. </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="ucoleitr_8h.html#705331b3ca250e3f5f74accfee861fa4">ucol_keyHashCode</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable002160">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="da9ebd7bfb43f664a1ac43dd7b78967d"></a><!-- doxytag: member="Collator::setLocales" ref="da9ebd7bfb43f664a1ac43dd7b78967d" args="(const Locale &requestedLocale, const Locale &validLocale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Collator::setLocales </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>validLocale</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used internally by registraton to define the requested and valid locales.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>requestedLocale</em> </td><td>the requsted locale </td></tr>
<tr><td valign="top"></td><td valign="top"><em>validLocale</em> </td><td>the valid locale </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="internal.html#_internal000128">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedCollator.html#24185345cc10b9fa5b167dae836e9aab">RuleBasedCollator</a>.
</div>
</div><p>
<a class="anchor" name="79465f4dba5cd6a6ee0ff1dc12f82ad9"></a><!-- doxytag: member="Collator::createUCollator" ref="79465f4dba5cd6a6ee0ff1dc12f82ad9" args="(const char *loc, UErrorCode *status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="ucol_8h.html#3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* Collator::createUCollator </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>loc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
used only by ucol_open, not for public use
<p>
<dl compact><dt><b><a class="el" href="internal.html#_internal000129">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="coll_8h-source.html">coll.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:39 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
280da2a01a3d16776505ea3f476de84f
>
files
>
51
