<!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.6: CollationElementIterator 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.4.7 -->
<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>CollationElementIterator Class Reference</h1><!-- doxytag: class="CollationElementIterator" --><!-- doxytag: inherits="UObject" -->The <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> class is used as an iterator to walk through each character of an international string.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="coleitr_8h-source.html">coleitr.h</a>></code>
<p>
<p>Inheritance diagram for CollationElementIterator:
<p><center><img src="classCollationElementIterator.png" usemap="#CollationElementIterator_map" border="0" alt=""></center>
<map name="CollationElementIterator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,145,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,145,24">
</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#aedb32179f7651773d1b56194ce9f4cce6c5a810a2b83426dfcd03714076d57a">NULLORDER</a> = (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a>)0xffffffff</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">NULLORDER indicates that an error has occured while processing. <a href="#aedb32179f7651773d1b56194ce9f4cce6c5a810a2b83426dfcd03714076d57a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classCollationElementIterator.html#aedb32179f7651773d1b56194ce9f4cce6c5a810a2b83426dfcd03714076d57a">NULLORDER</a> = (int32_t)0xffffffff
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#bdd21e6c40c4b30e625aa2219447fd7e">CollationElementIterator</a> (const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#bdd21e6c40c4b30e625aa2219447fd7e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#1520541069568e65f9c6876ec2c0f549">~CollationElementIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#1520541069568e65f9c6876ec2c0f549"></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="classCollationElementIterator.html#641def3a04da7bda41ab1c52b911160f">operator==</a> (const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if "other" is the same as "this". <a href="#641def3a04da7bda41ab1c52b911160f"></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="classCollationElementIterator.html#9b34d706755dee4116de536525615d8c">operator!=</a> (const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</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="#9b34d706755dee4116de536525615d8c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#9d9ad0ca4208888e53452e7868e62eb2">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the cursor to the beginning of the string. <a href="#9d9ad0ca4208888e53452e7868e62eb2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">next</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the ordering priority of the next character in the string. <a href="#5399fd6f2442c75fef0aef0561a1f487"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">previous</a> (<a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ordering priority of the previous collation element in the string. <a href="#1052461ecaa4ef8f7b6904ca16f22275"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#b0cc9747f553df1649021d677061497e">getMaxExpansion</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum length of any expansion sequences that end with the specified comparison order. <a href="#b0cc9747f553df1649021d677061497e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#18c1fde03bc63a9185059ee8af5819d1">strengthOrder</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the comparison order in the desired strength. <a href="#18c1fde03bc63a9185059ee8af5819d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#f800b86206814828221f8410cd2e9a52">setText</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &str, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the source string. <a href="#f800b86206814828221f8410cd2e9a52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#e60d0b5c20b9eaf788123a2adb42be8b">setText</a> (<a class="el" href="classCharacterIterator.html">CharacterIterator</a> &str, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the source string. <a href="#e60d0b5c20b9eaf788123a2adb42be8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#ddf5ceade65878a92ca3fb8f3ea9b3af">getOffset</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the offset of the currently processed character in the source string. <a href="#ddf5ceade65878a92ca3fb8f3ea9b3af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#a267b27b2078ec9ff998df4a6a5fc20e">setOffset</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> newOffset, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the offset of the currently processed character in the source string. <a href="#a267b27b2078ec9ff998df4a6a5fc20e"></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="classCollationElementIterator.html#7903132671ddaacd41774162597fbe47">getDynamicClassID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#7903132671ddaacd41774162597fbe47"></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="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#e09d16618097b31ed15bd05e99d35e3d">primaryOrder</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the primary order of a collation order. <a href="#e09d16618097b31ed15bd05e99d35e3d"></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="classCollationElementIterator.html#f13e4d75c867a2d9706e2923cc8c3e6c">secondaryOrder</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the secondary order of a collation order. <a href="#f13e4d75c867a2d9706e2923cc8c3e6c"></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="classCollationElementIterator.html#c154c9eceda5c4810241f60208da0684">tertiaryOrder</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the tertiary order of a collation order. <a href="#c154c9eceda5c4810241f60208da0684"></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="classCollationElementIterator.html#ab4a3b39c449460ee7dd6726e257f78e">isIgnorable</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if a comparison order is ignorable. <a href="#ab4a3b39c449460ee7dd6726e257f78e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#998eb0226d4f5cff0574f47b89ec69d9">getStaticClassID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#998eb0226d4f5cff0574f47b89ec69d9"></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="classCollationElementIterator.html#461371fcb9d86aa87c23a3aeed6a8847">CollationElementIterator</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &sourceText, const <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> *order, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> constructor. <a href="#461371fcb9d86aa87c23a3aeed6a8847"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#b8fc4a949e6eaa2f909ae1848a45fbd4">CollationElementIterator</a> (const <a class="el" href="classCharacterIterator.html">CharacterIterator</a> &sourceText, const <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> *order, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> constructor. <a href="#b8fc4a949e6eaa2f909ae1848a45fbd4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#2e0131a00dff1a0c40378263ece4f6e2">operator=</a> (const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#2e0131a00dff1a0c40378263ece4f6e2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollationElementIterator.html#1918e53ed4bb8208fdd6df3ed4ec2548">RuleBasedCollator</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> class is used as an iterator to walk through each character of an international string.
<p>
Use the iterator to return the ordering priority of the positioned character. The ordering priority of a character, which we refer to as a key, defines how a character is collated in the given collation object. For example, consider the following in Spanish: <pre>
"ca" -> the first key is key('c') and second key is key('a').
"cha" -> the first key is key('ch') and second key is key('a').</pre> And in German, <pre> "æb"-> the first key is key('a'), the second key is key('e'), and
the third key is key('b'). </pre> The key of a character, is an integer composed of primary order(short), secondary order(char), and tertiary order(char). Java strictly defines the size and signedness of its primitive data types. Therefore, the static functions <a class="el" href="classCollationElementIterator.html#e09d16618097b31ed15bd05e99d35e3d">primaryOrder()</a>, <a class="el" href="classCollationElementIterator.html#f13e4d75c867a2d9706e2923cc8c3e6c">secondaryOrder()</a>, and <a class="el" href="classCollationElementIterator.html#c154c9eceda5c4810241f60208da0684">tertiaryOrder()</a> return int32_t to ensure the correctness of the key value. <p>
Example of the iterator usage: (without error checking) <pre>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> CollationElementIterator_Example()
{
<a class="code" href="classUnicodeString.html">UnicodeString</a> str = <span class="stringliteral">"This is a test"</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="classRuleBasedCollator.html">RuleBasedCollator</a>* rbc =
(<a class="code" href="classRuleBasedCollator.html">RuleBasedCollator</a>*) <a class="code" href="classCollator.html#685bc906ba633d0d7653089d1f1a4dc5">RuleBasedCollator::createInstance</a>(success);
<a class="code" href="classCollationElementIterator.html">CollationElementIterator</a>* c =
rbc-><a class="code" href="classRuleBasedCollator.html#a00694d6f6463f3f21566ce173462fb6">createCollationElementIterator</a>( str );
<a class="code" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> order = c-><a class="code" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">next</a>(success);
c-><a class="code" href="classCollationElementIterator.html#9d9ad0ca4208888e53452e7868e62eb2">reset</a>();
order = c-><a class="code" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">previous</a>(success);
<span class="keyword">delete</span> c;
<span class="keyword">delete</span> rbc;
}
</pre></div>
</pre> <p>
<a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">CollationElementIterator::next</a> returns the collation order of the next character based on the comparison level of the collator. <a class="el" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">CollationElementIterator::previous</a> returns the collation order of the previous character based on the comparison level of the collator. The Collation Element Iterator moves only in one direction between calls to <a class="el" href="classCollationElementIterator.html#9d9ad0ca4208888e53452e7868e62eb2">CollationElementIterator::reset</a>. That is, <a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">CollationElementIterator::next()</a> and <a class="el" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">CollationElementIterator::previous</a> can not be inter-used. Whenever <a class="el" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">CollationElementIterator::previous</a> is to be called after <a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">CollationElementIterator::next()</a> or vice versa, <a class="el" href="classCollationElementIterator.html#9d9ad0ca4208888e53452e7868e62eb2">CollationElementIterator::reset</a> has to be called first to reset the status, shifting pointers to either the end or the start of the string. Hence at the next call of <a class="el" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">CollationElementIterator::previous</a> or <a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">CollationElementIterator::next()</a>, the first or last collation order will be returned. If a change of direction is done without a <a class="el" href="classCollationElementIterator.html#9d9ad0ca4208888e53452e7868e62eb2">CollationElementIterator::reset()</a>, the result is undefined. The result of a forward iterate (<a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">CollationElementIterator::next</a>) and reversed result of the backward iterate (<a class="el" href="classCollationElementIterator.html#1052461ecaa4ef8f7b6904ca16f22275">CollationElementIterator::previous</a>) on the same string are equivalent, if collation orders with the value UCOL_IGNORABLE are ignored. Character based on the comparison level of the collator. A collation order consists of primary order, secondary order and tertiary order. The data type of the collation order is <b>t_int32</b>.<p>
Note, <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> should not be subclassed. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classCollator.html">Collator</a> <p>
<a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> </dd></dl>
<dl compact><dt><b>Version:</b></dt><dd>1.8 Jan 16 2001 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00119">119</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="aedb32179f7651773d1b56194ce9f4cc"></a><!-- doxytag: member="CollationElementIterator::@15" ref="aedb32179f7651773d1b56194ce9f4cc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="aedb32179f7651773d1b56194ce9f4cce6c5a810a2b83426dfcd03714076d57a"></a><!-- doxytag: member="NULLORDER" ref="aedb32179f7651773d1b56194ce9f4cce6c5a810a2b83426dfcd03714076d57a" args="" -->NULLORDER</em> </td><td>
NULLORDER indicates that an error has occured while processing.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001929">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00124">124</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bdd21e6c40c4b30e625aa2219447fd7e"></a><!-- doxytag: member="CollationElementIterator::CollationElementIterator" ref="bdd21e6c40c4b30e625aa2219447fd7e" args="(const CollationElementIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CollationElementIterator::CollationElementIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></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>the object to be copied from </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001906">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1520541069568e65f9c6876ec2c0f549"></a><!-- doxytag: member="CollationElementIterator::~CollationElementIterator" ref="1520541069568e65f9c6876ec2c0f549" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CollationElementIterator::~CollationElementIterator </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#_stable001907">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="461371fcb9d86aa87c23a3aeed6a8847"></a><!-- doxytag: member="CollationElementIterator::CollationElementIterator" ref="461371fcb9d86aa87c23a3aeed6a8847" args="(const UnicodeString &sourceText, const RuleBasedCollator *order, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CollationElementIterator::CollationElementIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>sourceText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> * </td>
<td class="paramname"> <em>order</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> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> constructor.
<p>
This takes the source string and the collation object. The cursor will walk thru the source string based on the predefined collation rules. If the source string is empty, NULLORDER will be returned on the calls to <a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">next()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sourceText</em> </td><td>the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>order</em> </td><td>the collation object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001926">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b8fc4a949e6eaa2f909ae1848a45fbd4"></a><!-- doxytag: member="CollationElementIterator::CollationElementIterator" ref="b8fc4a949e6eaa2f909ae1848a45fbd4" args="(const CharacterIterator &sourceText, const RuleBasedCollator *order, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CollationElementIterator::CollationElementIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCharacterIterator.html">CharacterIterator</a> & </td>
<td class="paramname"> <em>sourceText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a> * </td>
<td class="paramname"> <em>order</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> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> constructor.
<p>
This takes the source string and the collation object. The cursor will walk thru the source string based on the predefined collation rules. If the source string is empty, NULLORDER will be returned on the calls to <a class="el" href="classCollationElementIterator.html#5399fd6f2442c75fef0aef0561a1f487">next()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sourceText</em> </td><td>the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>order</em> </td><td>the collation object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001927">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7903132671ddaacd41774162597fbe47"></a><!-- doxytag: member="CollationElementIterator::getDynamicClassID" ref="7903132671ddaacd41774162597fbe47" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> CollationElementIterator::getDynamicClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for the actual class.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001923">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.
</div>
</div><p>
<a class="anchor" name="b0cc9747f553df1649021d677061497e"></a><!-- doxytag: member="CollationElementIterator::getMaxExpansion" ref="b0cc9747f553df1649021d677061497e" args="(int32_t order) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::getMaxExpansion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>order</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the maximum length of any expansion sequences that end with the specified comparison order.
<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>order</em> </td><td>a collation order returned by previous or next. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>maximum size of the expansion sequences ending with the collation element or 1 if collation element does not occur at the end of any expansion sequence </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001916">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00385">385</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
<p>
References <a class="el" href="ucoleitr_8h.html#b87f69840736227870f8b1d47b6ddffd">ucol_getMaxExpansion()</a>.
</div>
</div><p>
<a class="anchor" name="ddf5ceade65878a92ca3fb8f3ea9b3af"></a><!-- doxytag: member="CollationElementIterator::getOffset" ref="ddf5ceade65878a92ca3fb8f3ea9b3af" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::getOffset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the offset of the currently processed character in the source string.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the offset of the character. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001921">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="998eb0226d4f5cff0574f47b89ec69d9"></a><!-- doxytag: member="CollationElementIterator::getStaticClassID" ref="998eb0226d4f5cff0574f47b89ec69d9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> CollationElementIterator::getStaticClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for this class.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001924">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ab4a3b39c449460ee7dd6726e257f78e"></a><!-- doxytag: member="CollationElementIterator::isIgnorable" ref="ab4a3b39c449460ee7dd6726e257f78e" args="(int32_t order)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> CollationElementIterator::isIgnorable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>order</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if a comparison order is ignorable.
<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>order</em> </td><td>the collation order. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>TRUE if a character is ignorable, FALSE otherwise. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001920">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00390">390</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
<p>
References <a class="el" href="coleitr_8h-source.html#l00358">primaryOrder()</a>.
</div>
</div><p>
<a class="anchor" name="5399fd6f2442c75fef0aef0561a1f487"></a><!-- doxytag: member="CollationElementIterator::next" ref="5399fd6f2442c75fef0aef0561a1f487" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::next </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%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the ordering priority of the next character in the string.
<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>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the next character's ordering. otherwise returns NULLORDER if an error has occured or if the end of string has been reached </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001911">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="9b34d706755dee4116de536525615d8c"></a><!-- doxytag: member="CollationElementIterator::operator!=" ref="9b34d706755dee4116de536525615d8c" args="(const CollationElementIterator &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> CollationElementIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const</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>the object to be compared </td></tr>
</table>
</dl>
<dl 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#_stable001909">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2e0131a00dff1a0c40378263ece4f6e2"></a><!-- doxytag: member="CollationElementIterator::operator=" ref="2e0131a00dff1a0c40378263ece4f6e2" args="(const CollationElementIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a>& CollationElementIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</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>
Assignment operator.
<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>the object to be copied </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001928">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="641def3a04da7bda41ab1c52b911160f"></a><!-- doxytag: member="CollationElementIterator::operator==" ref="641def3a04da7bda41ab1c52b911160f" args="(const CollationElementIterator &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> CollationElementIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCollationElementIterator.html">CollationElementIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const</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>the object to be compared </td></tr>
</table>
</dl>
<dl 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#_stable001908">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="1052461ecaa4ef8f7b6904ca16f22275"></a><!-- doxytag: member="CollationElementIterator::previous" ref="1052461ecaa4ef8f7b6904ca16f22275" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::previous </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%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the ordering priority of the previous collation element in the string.
<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>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the previous element's ordering. otherwise returns NULLORDER if an error has occured or if the start of string has been reached </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001912">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e09d16618097b31ed15bd05e99d35e3d"></a><!-- doxytag: member="CollationElementIterator::primaryOrder" ref="e09d16618097b31ed15bd05e99d35e3d" args="(int32_t order)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::primaryOrder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>order</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the primary order of a collation order.
<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>order</em> </td><td>the collation order </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the primary order of a collation order. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001913">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00358">358</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
<p>
Referenced by <a class="el" href="coleitr_8h-source.html#l00390">isIgnorable()</a>.
</div>
</div><p>
<a class="anchor" name="9d9ad0ca4208888e53452e7868e62eb2"></a><!-- doxytag: member="CollationElementIterator::reset" ref="9d9ad0ca4208888e53452e7868e62eb2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CollationElementIterator::reset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resets the cursor to the beginning of the string.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001910">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f13e4d75c867a2d9706e2923cc8c3e6c"></a><!-- doxytag: member="CollationElementIterator::secondaryOrder" ref="f13e4d75c867a2d9706e2923cc8c3e6c" args="(int32_t order)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::secondaryOrder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>order</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the secondary order of a collation order.
<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>order</em> </td><td>the collation order </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the secondary order of a collation order. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001914">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00369">369</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
</div>
</div><p>
<a class="anchor" name="a267b27b2078ec9ff998df4a6a5fc20e"></a><!-- doxytag: member="CollationElementIterator::setOffset" ref="a267b27b2078ec9ff998df4a6a5fc20e" args="(int32_t newOffset, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CollationElementIterator::setOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>newOffset</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%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the offset of the currently processed character in the source string.
<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>newOffset</em> </td><td>the new offset. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the offset of the character. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001922">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e60d0b5c20b9eaf788123a2adb42be8b"></a><!-- doxytag: member="CollationElementIterator::setText" ref="e60d0b5c20b9eaf788123a2adb42be8b" args="(CharacterIterator &str, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CollationElementIterator::setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCharacterIterator.html">CharacterIterator</a> & </td>
<td class="paramname"> <em>str</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%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the source string.
<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>str</em> </td><td>the source character iterator. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001919">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f800b86206814828221f8410cd2e9a52"></a><!-- doxytag: member="CollationElementIterator::setText" ref="f800b86206814828221f8410cd2e9a52" args="(const UnicodeString &str, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CollationElementIterator::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>str</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%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the source string.
<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>str</em> </td><td>the source string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code status. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001918">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="18c1fde03bc63a9185059ee8af5819d1"></a><!-- doxytag: member="CollationElementIterator::strengthOrder" ref="18c1fde03bc63a9185059ee8af5819d1" args="(int32_t order) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::strengthOrder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>order</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the comparison order in the desired strength.
<p>
Ignore the other differences. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>order</em> </td><td>The order value </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001917">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c154c9eceda5c4810241f60208da0684"></a><!-- doxytag: member="CollationElementIterator::tertiaryOrder" ref="c154c9eceda5c4810241f60208da0684" args="(int32_t order)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> CollationElementIterator::tertiaryOrder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td>
<td class="paramname"> <em>order</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the tertiary order of a collation order.
<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>order</em> </td><td>the collation order </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the tertiary order of a collation order. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001915">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00380">380</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="1918e53ed4bb8208fdd6df3ed4ec2548"></a><!-- doxytag: member="CollationElementIterator::RuleBasedCollator" ref="1918e53ed4bb8208fdd6df3ed4ec2548" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001925">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="coleitr_8h-source.html#l00295">295</a> of file <a class="el" href="coleitr_8h-source.html">coleitr.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="coleitr_8h-source.html">coleitr.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:56 2011 for ICU 3.6 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
