<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ICU 4.4: SearchIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>SearchIterator Class Reference</h1><!-- doxytag: class="SearchIterator" --><!-- doxytag: inherits="UObject" -->
<p><code><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a></code> is an abstract base class that provides methods to search for a pattern within a text string.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="search_8h_source.html">search.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for SearchIterator:</div>
<div class="dynsection">
<div class="center">
<img src="classSearchIterator.gif" usemap="#SearchIterator_map" alt=""/>
<map id="SearchIterator_map" name="SearchIterator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,93,80"/>
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,93,24"/>
<area href="classStringSearch.html" alt="StringSearch" shape="rect" coords="0,168,93,192"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ace7cb7b0e085eaffc03f6229f1aeab3f">SearchIterator</a> (const <a class="el" href="classSearchIterator.html">SearchIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor that creates a <a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> instance with the same behavior, and iterating over the same text. <a href="#ace7cb7b0e085eaffc03f6229f1aeab3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ac088b4c1be49860879d4a7a37e71681f">~SearchIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac088b4c1be49860879d4a7a37e71681f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a051291e515560612b18fd5c58b2fc523">setOffset</a> (int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the index to point to the given position, and clears any state that's affected. <a href="#a051291e515560612b18fd5c58b2fc523"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d">getOffset</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current index in the text being searched. <a href="#a405b15d976003735d48fe1c534a5045d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ad82645422603995508e3d70990de5fd8">setAttribute</a> (<a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> attribute, <a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> value, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue. <a href="#ad82645422603995508e3d70990de5fd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a91aa5cc02700fc13ac0ae6b9fa3ec1b5">getAttribute</a> (<a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> attribute) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the text searching attributes. <a href="#a91aa5cc02700fc13ac0ae6b9fa3ec1b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a08250c1400fda7b63d2bbba7074db3a5">getMatchedStart</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index to the match in the text string that was searched. <a href="#a08250c1400fda7b63d2bbba7074db3a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a149e2eb5d6b1c719e26256981826ca02">getMatchedLength</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of text in the string which matches the search pattern. <a href="#a149e2eb5d6b1c719e26256981826ca02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ab389210832353fd4ac40319f1e7630a6">getMatchedText</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &result) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the text that was matched by the most recent call to <code>first</code>, <code>next</code>, <code>previous</code>, or <code>last</code>. <a href="#ab389210832353fd4ac40319f1e7630a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a5999b2f5d0759a054ef0d9fbfae8598b">setBreakIterator</a> (<a class="el" href="classBreakIterator.html">BreakIterator</a> *breakiter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. <a href="#a5999b2f5d0759a054ef0d9fbfae8598b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#af9586c922b1360ad177ae2d1a649d480">getBreakIterator</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that is used to restrict the points at which matches are detected. <a href="#af9586c922b1360ad177ae2d1a649d480"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a14a7f30bf44acdebd78559ec47424d7f">setText</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &text, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the string text to be searched. <a href="#a14a7f30bf44acdebd78559ec47424d7f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a104395a4fb609992e1e170c98080366c">setText</a> (<a class="el" href="classCharacterIterator.html">CharacterIterator</a> &text, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the string text to be searched. <a href="#a104395a4fb609992e1e170c98080366c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a1b343bf29465ac7be05493cbf9000534">getText</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string text to be searched. <a href="#a1b343bf29465ac7be05493cbf9000534"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ac404a3e74b33dcdabda002c4b9438132">operator==</a> (const <a class="el" href="classSearchIterator.html">SearchIterator</a> &that) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#ac404a3e74b33dcdabda002c4b9438132"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a9fd5b7677b8169e5e5102e621aae31cc">operator!=</a> (const <a class="el" href="classSearchIterator.html">SearchIterator</a> &that) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Not-equal operator. <a href="#a9fd5b7677b8169e5e5102e621aae31cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSearchIterator.html">SearchIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a7dfe65a9875be67e88151a1987053c6e">safeClone</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of <a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> with the same behavior, and iterating over the same text, as this one. <a href="#a7dfe65a9875be67e88151a1987053c6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ad4b0624d1dd56a45f1b11b39f569e185">first</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the first index at which the string text matches the search pattern. <a href="#ad4b0624d1dd56a45f1b11b39f569e185"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a6b8596ad970537354cb4dd68d1103a9d">following</a> (int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the first index greater than <code>position</code> at which the string text matches the search pattern. <a href="#a6b8596ad970537354cb4dd68d1103a9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#aa367405e344b6cb425c47e221293257d">last</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the last index in the target text at which it matches the search pattern. <a href="#aa367405e344b6cb425c47e221293257d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a55f50cb3ef1ffb73746121aeb43b1ae9">preceding</a> (int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the first index less than <code>position</code> at which the string text matches the search pattern. <a href="#a55f50cb3ef1ffb73746121aeb43b1ae9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#abc2fe871477a82214534b84062dd5763">next</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the next point at which the text matches the search pattern, starting from the current position The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. <a href="#abc2fe871477a82214534b84062dd5763"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a6adda71b217ffa8ea4a74fc72db3e0df">previous</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the previous point at which the string text matches the search pattern, starting at the current position. <a href="#a6adda71b217ffa8ea4a74fc72db3e0df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ad72b74b2fbe16ca0a449919984e85db9">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the iteration. <a href="#ad72b74b2fbe16ca0a449919984e85db9"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a528076f54b4118e76a1790ba04987e2c">SearchIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a528076f54b4118e76a1790ba04987e2c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#aaec88fe42044008487190bf00a2e4661">SearchIterator</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &text, <a class="el" href="classBreakIterator.html">BreakIterator</a> *breakiter=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for use by subclasses. <a href="#aaec88fe42044008487190bf00a2e4661"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a028a9602382aca4555f56df8c964bb04">SearchIterator</a> (<a class="el" href="classCharacterIterator.html">CharacterIterator</a> &text, <a class="el" href="classBreakIterator.html">BreakIterator</a> *breakiter=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for use by subclasses. <a href="#a028a9602382aca4555f56df8c964bb04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSearchIterator.html">SearchIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ada060084cf2fb3ccf7c64cb71488d89e">operator=</a> (const <a class="el" href="classSearchIterator.html">SearchIterator</a> &that)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ada060084cf2fb3ccf7c64cb71488d89e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a18c8f6a8faec99e860e6ee6e41fa630a">handleNext</a> (int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract method which subclasses override to provide the mechanism for finding the next match in the target text. <a href="#a18c8f6a8faec99e860e6ee6e41fa630a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#afa84ddfd9914bfb6857e8450b5571361">handlePrev</a> (int32_t position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract method which subclasses override to provide the mechanism for finding the previous match in the target text. <a href="#afa84ddfd9914bfb6857e8450b5571361"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a2d6d2c4af6c45121336b0fa3e06f2e14">setMatchLength</a> (int32_t length)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the length of the currently matched string in the text string to be searched. <a href="#a2d6d2c4af6c45121336b0fa3e06f2e14"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a030774198e9befb2ae0c37d85841dd0c">setMatchStart</a> (int32_t position)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the offset of the currently matched string in the text string to be searched. <a href="#a030774198e9befb2ae0c37d85841dd0c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a2ef0f691ef79cf6b3a673afb6f0ed2b8">setMatchNotFound</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sets match not found <a href="#a2ef0f691ef79cf6b3a673afb6f0ed2b8"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="search_8h.html#ab9a54441959795454ae0406609767131">USearch</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a37a71b3da6253680b3e24a3e0c3687a5">m_search_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">C search data struct. <a href="#a37a71b3da6253680b3e24a3e0c3687a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#a2fa2bb916a411a0df41f4f99e8e74419">m_breakiterator_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Break iterator. <a href="#a2fa2bb916a411a0df41f4f99e8e74419"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSearchIterator.html#ada31ca7238c22c2d69fd5192fe036d3d">m_text_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unicode string version of the search text. <a href="#ada31ca7238c22c2d69fd5192fe036d3d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><code><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a></code> is an abstract base class that provides methods to search for a pattern within a text string. </p>
<p>Instances of <code><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a></code> maintain a current position and scans over the target text, returning the indices the pattern is matched and the length of each match. </p>
<p><code><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a></code> defines a protocol for text searching. Subclasses provide concrete implementations of various search algorithms. For example, <code><a class="el" href="classStringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching...">StringSearch</a></code> implements language-sensitive pattern matching based on the comparison rules defined in a <code><a class="el" href="classRuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using...">RuleBasedCollator</a></code> object. </p>
<p>Other options for searching includes using a <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> to restrict the points at which matches are detected. </p>
<p><code><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a></code> provides an API that is similar to that of other text iteration classes such as <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>. Using this class, it is easy to scan through text looking for all occurances of a given pattern. The following example uses a <code><a class="el" href="classStringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching...">StringSearch</a></code> object to find all instances of "fox" in the target string. Any other subclass of <code><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a></code> can be used in an identical manner. </p>
<pre><code>
<a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> target("The quick brown fox jumped over the lazy fox");
<a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> pattern("fox");</code></pre><pre><code> <a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> *iter = new StringSearch(pattern, target);
UErrorCode error = U_ZERO_ERROR;
for (int pos = iter->first(error); pos != USEARCH_DONE;
pos = iter->next(error)) {
printf("Found match at %d pos, length is %d\n", pos,
iter.getMatchLength());
}
</code></pre><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classStringSearch.html" title="StringSearch is a SearchIterator that provides language-sensitive text searching...">StringSearch</a> </dd>
<dd>
<a class="el" href="classRuleBasedCollator.html" title="The RuleBasedCollator class provides the simple implementation of Collator, using...">RuleBasedCollator</a> </dd></dl>
<p>Definition at line <a class="el" href="search_8h_source.html#l00079">79</a> of file <a class="el" href="search_8h_source.html">search.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ace7cb7b0e085eaffc03f6229f1aeab3f"></a><!-- doxytag: member="SearchIterator::SearchIterator" ref="ace7cb7b0e085eaffc03f6229f1aeab3f" args="(const SearchIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SearchIterator::SearchIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSearchIterator.html">SearchIterator</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor that creates a <a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> instance with the same behavior, and iterating over the same text. </p>
<dl><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 <a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> instance to be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003036">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac088b4c1be49860879d4a7a37e71681f"></a><!-- doxytag: member="SearchIterator::~SearchIterator" ref="ac088b4c1be49860879d4a7a37e71681f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual SearchIterator::~SearchIterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Cleans up the search iterator data struct. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003037">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a528076f54b4118e76a1790ba04987e2c"></a><!-- doxytag: member="SearchIterator::SearchIterator" ref="a528076f54b4118e76a1790ba04987e2c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SearchIterator::SearchIterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Initializes data to the default values. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003063">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aaec88fe42044008487190bf00a2e4661"></a><!-- doxytag: member="SearchIterator::SearchIterator" ref="aaec88fe42044008487190bf00a2e4661" args="(const UnicodeString &text, BreakIterator *breakiter=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SearchIterator::SearchIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBreakIterator.html">BreakIterator</a> * </td>
<td class="paramname"> <em>breakiter</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for use by subclasses. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The target text to be searched. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>breakiter</em> </td><td>A <a class="el" href="classBreakIterator.html">BreakIterator</a> that is used to restrict the points at which matches are detected. If <code>handleNext</code> or <code>handlePrev</code> finds a match, but the match's start or end index is not a boundary as determined by the <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>, the match is rejected and <code>handleNext</code> or <code>handlePrev</code> is called again. If this parameter is <code>NULL</code>, no break detection is attempted. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a18c8f6a8faec99e860e6ee6e41fa630a" title="Abstract method which subclasses override to provide the mechanism for finding the...">handleNext</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#afa84ddfd9914bfb6857e8450b5571361" title="Abstract method which subclasses override to provide the mechanism for finding the...">handlePrev</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003064">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a028a9602382aca4555f56df8c964bb04"></a><!-- doxytag: member="SearchIterator::SearchIterator" ref="a028a9602382aca4555f56df8c964bb04" args="(CharacterIterator &text, BreakIterator *breakiter=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SearchIterator::SearchIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCharacterIterator.html">CharacterIterator</a> & </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBreakIterator.html">BreakIterator</a> * </td>
<td class="paramname"> <em>breakiter</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for use by subclasses. </p>
<p>Note: No parsing of the text within the <code><a class="el" href="classCharacterIterator.html" title="Abstract class that defines an API for iteration on text objects.">CharacterIterator</a></code> will be done during searching for this version. The block of text in <code><a class="el" href="classCharacterIterator.html" title="Abstract class that defines an API for iteration on text objects.">CharacterIterator</a></code> will be used as it is. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The target text to be searched. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>breakiter</em> </td><td>A <a class="el" href="classBreakIterator.html">BreakIterator</a> that is used to restrict the points at which matches are detected. If <code>handleNext</code> or <code>handlePrev</code> finds a match, but the match's start or end index is not a boundary as determined by the <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>, the match is rejected and <code>handleNext</code> or <code>handlePrev</code> is called again. If this parameter is <code>NULL</code>, no break detection is attempted. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a18c8f6a8faec99e860e6ee6e41fa630a" title="Abstract method which subclasses override to provide the mechanism for finding the...">handleNext</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#afa84ddfd9914bfb6857e8450b5571361" title="Abstract method which subclasses override to provide the mechanism for finding the...">handlePrev</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003065">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad4b0624d1dd56a45f1b11b39f569e185"></a><!-- doxytag: member="SearchIterator::first" ref="ad4b0624d1dd56a45f1b11b39f569e185" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::first </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the first index at which the string text matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index USEARCH_DONE </p>
<dl><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>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character index of the first match, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d" title="Return the current index in the text being searched.">getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003053">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a6b8596ad970537354cb4dd68d1103a9d"></a><!-- doxytag: member="SearchIterator::following" ref="a6b8596ad970537354cb4dd68d1103a9d" args="(int32_t position, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::following </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the first index greater than <code>position</code> at which the string text matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index USEARCH_DONE </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>where search if to start from. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character index of the first match following <code>position</code>, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d" title="Return the current index in the text being searched.">getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003054">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a91aa5cc02700fc13ac0ae6b9fa3ec1b5"></a><!-- doxytag: member="SearchIterator::getAttribute" ref="a91aa5cc02700fc13ac0ae6b9fa3ec1b5" args="(USearchAttribute attribute) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> SearchIterator::getAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> </td>
<td class="paramname"> <em>attribute</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the text searching attributes. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>attribute</em> </td><td>text attribute (enum USearchAttribute) to be retrieve </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>text attribute value </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003041">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af9586c922b1360ad177ae2d1a649d480"></a><!-- doxytag: member="SearchIterator::getBreakIterator" ref="af9586c922b1360ad177ae2d1a649d480" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classBreakIterator.html">BreakIterator</a>* SearchIterator::getBreakIterator </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that is used to restrict the points at which matches are detected. </p>
<p>This will be the same object that was passed to the constructor or to <code>setBreakIterator</code>. Note that <code>NULL</code> is a legal value; it means that break detection should not be attempted. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> used to restrict matchings. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a5999b2f5d0759a054ef0d9fbfae8598b" title="Set the BreakIterator that will be used to restrict the points at which matches are...">setBreakIterator</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003046">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a149e2eb5d6b1c719e26256981826ca02"></a><!-- doxytag: member="SearchIterator::getMatchedLength" ref="a149e2eb5d6b1c719e26256981826ca02" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::getMatchedLength </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the length of text in the string which matches the search pattern. </p>
<p>This call returns a valid result only after a successful call to <code>first</code>, <code>next</code>, <code>previous</code>, or <code>last</code>. Just after construction, or after a searching method returns <code>USEARCH_DONE</code>, this method will return 0. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The length of the match in the target text, or 0 if there is no match currently. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#ad4b0624d1dd56a45f1b11b39f569e185" title="Returns the first index at which the string text matches the search pattern.">first</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#abc2fe871477a82214534b84062dd5763" title="Returns the index of the next point at which the text matches the search pattern...">next</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#a6adda71b217ffa8ea4a74fc72db3e0df" title="Returns the index of the previous point at which the string text matches the search...">previous</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#aa367405e344b6cb425c47e221293257d" title="Returns the last index in the target text at which it matches the search pattern...">last</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003043">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a08250c1400fda7b63d2bbba7074db3a5"></a><!-- doxytag: member="SearchIterator::getMatchedStart" ref="a08250c1400fda7b63d2bbba7074db3a5" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::getMatchedStart </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the index to the match in the text string that was searched. </p>
<p>This call returns a valid result only after a successful call to <code>first</code>, <code>next</code>, <code>previous</code>, or <code>last</code>. Just after construction, or after a searching method returns <code>USEARCH_DONE</code>, this method will return <code>USEARCH_DONE</code>. </p>
<p>Use getMatchedLength to get the matched string length. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>index of a substring within the text string that is being searched. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#ad4b0624d1dd56a45f1b11b39f569e185" title="Returns the first index at which the string text matches the search pattern.">first</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#abc2fe871477a82214534b84062dd5763" title="Returns the index of the next point at which the text matches the search pattern...">next</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#a6adda71b217ffa8ea4a74fc72db3e0df" title="Returns the index of the previous point at which the string text matches the search...">previous</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#aa367405e344b6cb425c47e221293257d" title="Returns the last index in the target text at which it matches the search pattern...">last</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003042">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab389210832353fd4ac40319f1e7630a6"></a><!-- doxytag: member="SearchIterator::getMatchedText" ref="ab389210832353fd4ac40319f1e7630a6" args="(UnicodeString &result) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SearchIterator::getMatchedText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>result</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the text that was matched by the most recent call to <code>first</code>, <code>next</code>, <code>previous</code>, or <code>last</code>. </p>
<p>If the iterator is not pointing at a valid match (e.g. just after construction or after <code>USEARCH_DONE</code> has been returned, returns an empty string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>stores the matched string or an empty string if a match is not found. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#ad4b0624d1dd56a45f1b11b39f569e185" title="Returns the first index at which the string text matches the search pattern.">first</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#abc2fe871477a82214534b84062dd5763" title="Returns the index of the next point at which the text matches the search pattern...">next</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#a6adda71b217ffa8ea4a74fc72db3e0df" title="Returns the index of the previous point at which the string text matches the search...">previous</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#aa367405e344b6cb425c47e221293257d" title="Returns the last index in the target text at which it matches the search pattern...">last</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003044">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a405b15d976003735d48fe1c534a5045d"></a><!-- doxytag: member="SearchIterator::getOffset" ref="a405b15d976003735d48fe1c534a5045d" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int32_t SearchIterator::getOffset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the current index in the text being searched. </p>
<p>If the iteration has gone past the end of the text (or past the beginning for a backwards search), USEARCH_DONE is returned. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>current index in the text being searched. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003039">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classStringSearch.html#a36072e965203eb7272bc050a0c5e6e6b">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="a1b343bf29465ac7be05493cbf9000534"></a><!-- doxytag: member="SearchIterator::getText" ref="a1b343bf29465ac7be05493cbf9000534" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& SearchIterator::getText </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the string text to be searched. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>text string to be searched. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003049">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a18c8f6a8faec99e860e6ee6e41fa630a"></a><!-- doxytag: member="SearchIterator::handleNext" ref="a18c8f6a8faec99e860e6ee6e41fa630a" args="(int32_t position, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int32_t SearchIterator::handleNext </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Abstract method which subclasses override to provide the mechanism for finding the next match in the target text. </p>
<p>This allows different subclasses to provide different search algorithms. </p>
<p>If a match is found, the implementation should return the index at which the match starts and should call <code>setMatchLength</code> with the number of characters in the target text that make up the match. If no match is found, the method should return USEARCH_DONE. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>The index in the target text at which the search should start. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for error codes if it occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>index at which the match starts, else if match is not found USEARCH_DONE is returned </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a2d6d2c4af6c45121336b0fa3e06f2e14" title="Sets the length of the currently matched string in the text string to be searched...">setMatchLength</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003067">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classStringSearch.html#af72f5e342a08ab606435ae49dd41d23b">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="afa84ddfd9914bfb6857e8450b5571361"></a><!-- doxytag: member="SearchIterator::handlePrev" ref="afa84ddfd9914bfb6857e8450b5571361" args="(int32_t position, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int32_t SearchIterator::handlePrev </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Abstract method which subclasses override to provide the mechanism for finding the previous match in the target text. </p>
<p>This allows different subclasses to provide different search algorithms. </p>
<p>If a match is found, the implementation should return the index at which the match starts and should call <code>setMatchLength</code> with the number of characters in the target text that make up the match. If no match is found, the method should return USEARCH_DONE. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>The index in the target text at which the search should start. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for error codes if it occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>index at which the match starts, else if match is not found USEARCH_DONE is returned </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a2d6d2c4af6c45121336b0fa3e06f2e14" title="Sets the length of the currently matched string in the text string to be searched...">setMatchLength</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003068">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classStringSearch.html#aaeb4d82bf1a5917a2fd5819d179d050a">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="aa367405e344b6cb425c47e221293257d"></a><!-- doxytag: member="SearchIterator::last" ref="aa367405e344b6cb425c47e221293257d" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::last </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the last index in the target text at which it matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index USEARCH_DONE. </p>
<dl><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>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the first match, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d" title="Return the current index in the text being searched.">getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003055">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="abc2fe871477a82214534b84062dd5763"></a><!-- doxytag: member="SearchIterator::next" ref="abc2fe871477a82214534b84062dd5763" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the index of the next point at which the text matches the search pattern, starting from the current position The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. </p>
<p>If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to a position after the end of the text string. </p>
<dl><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>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the next match after the current position, or <code>USEARCH_DONE</code> if there are no more matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d" title="Return the current index in the text being searched.">getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003057">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a9fd5b7677b8169e5e5102e621aae31cc"></a><!-- doxytag: member="SearchIterator::operator!=" ref="a9fd5b7677b8169e5e5102e621aae31cc" args="(const SearchIterator &that) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> SearchIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSearchIterator.html">SearchIterator</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Not-equal operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> instance to be compared. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>FALSE if operator== returns TRUE, and vice versa. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003051">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="search_8h_source.html#l00560">560</a> of file <a class="el" href="search_8h_source.html">search.h</a>.</p>
<p>References <a class="el" href="classSearchIterator.html#ac404a3e74b33dcdabda002c4b9438132">operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="ada060084cf2fb3ccf7c64cb71488d89e"></a><!-- doxytag: member="SearchIterator::operator=" ref="ada060084cf2fb3ccf7c64cb71488d89e" args="(const SearchIterator &that)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSearchIterator.html">SearchIterator</a>& SearchIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSearchIterator.html">SearchIterator</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Sets this iterator to have the same behavior, and iterate over the same text, as the one passed in. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td>instance to be copied. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003066">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classStringSearch.html#a91aed07e16b843f72fe850c7f2c19008">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="ac404a3e74b33dcdabda002c4b9438132"></a><!-- doxytag: member="SearchIterator::operator==" ref="ac404a3e74b33dcdabda002c4b9438132" args="(const SearchIterator &that) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> SearchIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSearchIterator.html">SearchIterator</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Equality operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td><a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> instance to be compared. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if both BreakIterators are of the same class, have the same behavior, terates over the same text and have the same attributes. FALSE otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003050">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Referenced by <a class="el" href="search_8h_source.html#l00560">operator!=()</a>.</p>
</div>
</div>
<a class="anchor" id="a55f50cb3ef1ffb73746121aeb43b1ae9"></a><!-- doxytag: member="SearchIterator::preceding" ref="a55f50cb3ef1ffb73746121aeb43b1ae9" args="(int32_t position, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::preceding </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the first index less than <code>position</code> at which the string text matches the search pattern. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index USEARCH_DONE </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>where search is to start from. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The character index of the first match preceding <code>position</code>, or <code>USEARCH_DONE</code> if there are no matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d" title="Return the current index in the text being searched.">getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003056">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a6adda71b217ffa8ea4a74fc72db3e0df"></a><!-- doxytag: member="SearchIterator::previous" ref="a6adda71b217ffa8ea4a74fc72db3e0df" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SearchIterator::previous </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the index of the previous point at which the string text matches the search pattern, starting at the current position. </p>
<p>The iterator is adjusted so that its current index (as returned by <code>getOffset</code>) is the match position if one was found. If a match is not found, <code>USEARCH_DONE</code> will be returned and the iterator will be adjusted to the index USEARCH_DONE </p>
<dl><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>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The index of the previous match before the current position, or <code>USEARCH_DONE</code> if there are no more matches. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a405b15d976003735d48fe1c534a5045d" title="Return the current index in the text being searched.">getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003058">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad72b74b2fbe16ca0a449919984e85db9"></a><!-- doxytag: member="SearchIterator::reset" ref="ad72b74b2fbe16ca0a449919984e85db9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SearchIterator::reset </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the iteration. </p>
<p>Search will begin at the start of the text string if a forward iteration is initiated before a backwards iteration. Otherwise if a backwards iteration is initiated before a forwards iteration, the search will begin at the end of the text string. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003059">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classStringSearch.html#a298259adcc5316a74ac9ce9b22e97c03">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="a7dfe65a9875be67e88151a1987053c6e"></a><!-- doxytag: member="SearchIterator::safeClone" ref="a7dfe65a9875be67e88151a1987053c6e" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classSearchIterator.html">SearchIterator</a>* SearchIterator::safeClone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a copy of <a class="el" href="classSearchIterator.html" title="SearchIterator is an abstract base class that provides methods to search for a pattern...">SearchIterator</a> with the same behavior, and iterating over the same text, as this one. </p>
<p>Note that all data will be replicated, except for the text string to be searched. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>cloned object </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003052">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classStringSearch.html#a4b33f73a68dceee80574f86f421798f4">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="ad82645422603995508e3d70990de5fd8"></a><!-- doxytag: member="SearchIterator::setAttribute" ref="ad82645422603995508e3d70990de5fd8" args="(USearchAttribute attribute, USearchAttributeValue value, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SearchIterator::setAttribute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="usearch_8h.html#aa382f146f1968a9d1dc182100b23ac03">USearchAttribute</a> </td>
<td class="paramname"> <em>attribute</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="usearch_8h.html#afbe777746540a229c0a2ff3323e292d1">USearchAttributeValue</a> </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue. </p>
<p>USEARCH_DEFAULT can be used for all attributes for resetting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>attribute</em> </td><td>text attribute (enum USearchAttribute) to be set </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>text attribute value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003040">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5999b2f5d0759a054ef0d9fbfae8598b"></a><!-- doxytag: member="SearchIterator::setBreakIterator" ref="a5999b2f5d0759a054ef0d9fbfae8598b" args="(BreakIterator *breakiter, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SearchIterator::setBreakIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBreakIterator.html">BreakIterator</a> * </td>
<td class="paramname"> <em>breakiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. </p>
<p>The user is responsible for deleting the breakiterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>breakiter</em> </td><td>A <a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by the <code><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a></code>, the match will be rejected and another will be searched for. If this parameter is <code>NULL</code>, no break detection is attempted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries...">BreakIterator</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003045">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2d6d2c4af6c45121336b0fa3e06f2e14"></a><!-- doxytag: member="SearchIterator::setMatchLength" ref="a2d6d2c4af6c45121336b0fa3e06f2e14" args="(int32_t length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SearchIterator::setMatchLength </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>length</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the length of the currently matched string in the text string to be searched. </p>
<p>Subclasses' <code>handleNext</code> and <code>handlePrev</code> methods should call this when they find a match in the target text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>length of the matched text. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a18c8f6a8faec99e860e6ee6e41fa630a" title="Abstract method which subclasses override to provide the mechanism for finding the...">handleNext</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#afa84ddfd9914bfb6857e8450b5571361" title="Abstract method which subclasses override to provide the mechanism for finding the...">handlePrev</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003069">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2ef0f691ef79cf6b3a673afb6f0ed2b8"></a><!-- doxytag: member="SearchIterator::setMatchNotFound" ref="a2ef0f691ef79cf6b3a673afb6f0ed2b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SearchIterator::setMatchNotFound </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets match not found </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003071">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a030774198e9befb2ae0c37d85841dd0c"></a><!-- doxytag: member="SearchIterator::setMatchStart" ref="a030774198e9befb2ae0c37d85841dd0c" args="(int32_t position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SearchIterator::setMatchStart </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the offset of the currently matched string in the text string to be searched. </p>
<p>Subclasses' <code>handleNext</code> and <code>handlePrev</code> methods should call this when they find a match in the target text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>start offset of the matched text. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSearchIterator.html#a18c8f6a8faec99e860e6ee6e41fa630a" title="Abstract method which subclasses override to provide the mechanism for finding the...">handleNext</a> </dd>
<dd>
<a class="el" href="classSearchIterator.html#afa84ddfd9914bfb6857e8450b5571361" title="Abstract method which subclasses override to provide the mechanism for finding the...">handlePrev</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003070">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a051291e515560612b18fd5c58b2fc523"></a><!-- doxytag: member="SearchIterator::setOffset" ref="a051291e515560612b18fd5c58b2fc523" args="(int32_t position, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SearchIterator::setOffset </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the index to point to the given position, and clears any state that's affected. </p>
<p>This method takes the argument index and sets the position in the text string accordingly without checking if the index is pointing to a valid starting point to begin searching. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>within the text to be set. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if it occurs </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003038">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classStringSearch.html#a6cdb73b15960f85ef3b046a551a61ecf">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="a104395a4fb609992e1e170c98080366c"></a><!-- doxytag: member="SearchIterator::setText" ref="a104395a4fb609992e1e170c98080366c" args="(CharacterIterator &text, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SearchIterator::setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCharacterIterator.html">CharacterIterator</a> & </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the string text to be searched. </p>
<p>Text iteration will hence begin at the start of the text string. This method is useful if you want to re-use an iterator to search for the same pattern within a different body of text. </p>
<p>Note: No parsing of the text within the <code><a class="el" href="classCharacterIterator.html" title="Abstract class that defines an API for iteration on text objects.">CharacterIterator</a></code> will be done during searching for this version. The block of text in <code><a class="el" href="classCharacterIterator.html" title="Abstract class that defines an API for iteration on text objects.">CharacterIterator</a></code> will be used as it is. The user is responsible for deleting the text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>string iterator to be searched. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors if any. If the text length is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003048">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classStringSearch.html#a755fec7f70c3f7f9e2cb06985839ac43">StringSearch</a>.</p>
</div>
</div>
<a class="anchor" id="a14a7f30bf44acdebd78559ec47424d7f"></a><!-- doxytag: member="SearchIterator::setText" ref="a14a7f30bf44acdebd78559ec47424d7f" args="(const UnicodeString &text, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SearchIterator::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the string text to be searched. </p>
<p>Text iteration will hence begin at the start of the text string. This method is useful if you want to re-use an iterator to search for the same pattern within a different body of text. The user is responsible for deleting the text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>string to be searched. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>for errors. If the text length is 0, an U_ILLEGAL_ARGUMENT_ERROR is returned. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003047">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classStringSearch.html#a703c9716ef58efb5911229eaa2ed7e2a">StringSearch</a>.</p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a2fa2bb916a411a0df41f4f99e8e74419"></a><!-- doxytag: member="SearchIterator::m_breakiterator_" ref="a2fa2bb916a411a0df41f4f99e8e74419" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBreakIterator.html">BreakIterator</a>* <a class="el" href="classSearchIterator.html#a2fa2bb916a411a0df41f4f99e8e74419">SearchIterator::m_breakiterator_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Break iterator. </p>
<p>Currently the C++ breakiterator does not have getRules etc to reproduce another in C. Hence we keep the original around and do the verification at the end of the match. The user is responsible for deleting this break iterator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003061">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="search_8h_source.html#l00419">419</a> of file <a class="el" href="search_8h_source.html">search.h</a>.</p>
</div>
</div>
<a class="anchor" id="a37a71b3da6253680b3e24a3e0c3687a5"></a><!-- doxytag: member="SearchIterator::m_search_" ref="a37a71b3da6253680b3e24a3e0c3687a5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="search_8h.html#ab9a54441959795454ae0406609767131">USearch</a>* <a class="el" href="classSearchIterator.html#a37a71b3da6253680b3e24a3e0c3687a5">SearchIterator::m_search_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>C search data struct. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003060">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="search_8h_source.html#l00409">409</a> of file <a class="el" href="search_8h_source.html">search.h</a>.</p>
</div>
</div>
<a class="anchor" id="ada31ca7238c22c2d69fd5192fe036d3d"></a><!-- doxytag: member="SearchIterator::m_text_" ref="ada31ca7238c22c2d69fd5192fe036d3d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> <a class="el" href="classSearchIterator.html#ada31ca7238c22c2d69fd5192fe036d3d">SearchIterator::m_text_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unicode string version of the search text. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable003062">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="search_8h_source.html#l00425">425</a> of file <a class="el" href="search_8h_source.html">search.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="search_8h_source.html">search.h</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
178
