<!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: UnicodeFilter 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>UnicodeFilter Class Reference</h1><!-- doxytag: class="UnicodeFilter" --><!-- doxytag: inherits="UnicodeFunctor,UnicodeMatcher" --><code><a class="el" href="classUnicodeFilter.html">UnicodeFilter</a></code> defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Unicode characters.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="unifilt_8h-source.html">unifilt.h</a>></code>
<p>
<p>Inheritance diagram for UnicodeFilter:
<p><center><img src="classUnicodeFilter.png" usemap="#UnicodeFilter_map" border="0" alt=""></center>
<map name="UnicodeFilter_map">
<area href="classUnicodeFunctor.html" alt="UnicodeFunctor" shape="rect" coords="0,112,105,136">
<area href="classUnicodeMatcher.html" alt="UnicodeMatcher" shape="rect" coords="115,112,220,136">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,105,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,105,24">
<area href="classUnicodeSet.html" alt="UnicodeSet" shape="rect" coords="57,224,162,248">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#8da0b865dc5229c382282274e0c09d0d">~UnicodeFilter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#8da0b865dc5229c382282274e0c09d0d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#f39c18d121cdf8a349f54ffa4d9e5ff8">contains</a> (<a class="el" href="umachine_8h.html#a5c18ea10e60c576fe5ec420a7ef7b28">UChar32</a> c) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> for characters that are in the selected subset. <a href="#f39c18d121cdf8a349f54ffa4d9e5ff8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#3402ff27be422533bae39825b824b56f">toMatcher</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUnicodeFunctor.html">UnicodeFunctor</a> API. <a href="#3402ff27be422533bae39825b824b56f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="unimatch_8h.html#05562f7626edb48779ce8255b7530b0e">UMatchDegree</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#81d095e3b7cff3d61873d2e2a3d6a82b">matches</a> (const <a class="el" href="classReplaceable.html">Replaceable</a> &text, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> &offset, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> limit, <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> incremental)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implement <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> API. <a href="#81d095e3b7cff3d61873d2e2a3d6a82b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#d4a1e7c617f7b2ad8cf8fbaebd88799b">setData</a> (const TransliterationRuleData *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUnicodeFunctor.html">UnicodeFunctor</a> API. <a href="#d4a1e7c617f7b2ad8cf8fbaebd88799b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#08bcd24a75224e3c3eba026673c56fde">getDynamicClassID</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#08bcd24a75224e3c3eba026673c56fde"></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="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFilter.html#3ca4723bfe33095389205f18c15f57a4">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="#3ca4723bfe33095389205f18c15f57a4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<code><a class="el" href="classUnicodeFilter.html">UnicodeFilter</a></code> defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Unicode characters.
<p>
Currently, filters are used in conjunction with classes like <a class="el" href="classTransliterator.html">Transliterator</a> to only process selected characters through a transformation.<p>
Note: <a class="el" href="classUnicodeFilter.html">UnicodeFilter</a> currently stubs out two pure virtual methods of its base class, <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a>. These methods are <a class="el" href="classUnicodeMatcher.html#2fc8a484aa9ba939972e12d5499650c6">toPattern()</a> and <a class="el" href="classUnicodeMatcher.html#60f4f10e9a2f0a2d40c3e96d39a0b2a3">matchesIndexValue()</a>. This is done so that filter classes that are not actually used as matchers -- specifically, those in the UnicodeFilterLogic component, and those in tests -- can continue to work without defining these methods. As long as a filter is not used in an RBT during real transliteration, these methods will not be called. However, this breaks the <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> base class protocol, and it is not a correct solution.<p>
In the future we may revisit the <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> / <a class="el" href="classUnicodeFilter.html">UnicodeFilter</a> hierarchy and either redesign it, or simply remove the stubs in <a class="el" href="classUnicodeFilter.html">UnicodeFilter</a> and force subclasses to implement the full <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> protocol.<p>
<dl compact><dt><b>See also:</b></dt><dd>UnicodeFilterLogic </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001145">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="unifilt_8h-source.html#l00059">59</a> of file <a class="el" href="unifilt_8h-source.html">unifilt.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8da0b865dc5229c382282274e0c09d0d"></a><!-- doxytag: member="UnicodeFilter::~UnicodeFilter" ref="8da0b865dc5229c382282274e0c09d0d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual UnicodeFilter::~UnicodeFilter </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#_stable001146">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f39c18d121cdf8a349f54ffa4d9e5ff8"></a><!-- doxytag: member="UnicodeFilter::contains" ref="f39c18d121cdf8a349f54ffa4d9e5ff8" args="(UChar32 c) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> UnicodeFilter::contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a5c18ea10e60c576fe5ec420a7ef7b28">UChar32</a> </td>
<td class="paramname"> <em>c</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns <code>true</code> for characters that are in the selected subset.
<p>
In other words, if a character is <b>to be filtered</b>, then <code><a class="el" href="classUnicodeFilter.html#f39c18d121cdf8a349f54ffa4d9e5ff8">contains()</a></code> returns <b><code>false</code></b>. <dl compact><dt><b><a class="el" href="stable.html#_stable001147">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classUnicodeSet.html#ae986ada64c3e71fa0746d4ed49feac5">UnicodeSet</a>.
</div>
</div><p>
<a class="anchor" name="08bcd24a75224e3c3eba026673c56fde"></a><!-- doxytag: member="UnicodeFilter::getDynamicClassID" ref="08bcd24a75224e3c3eba026673c56fde" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> UnicodeFilter::getDynamicClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure 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#_stable001151">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Implements <a class="el" href="classUnicodeFunctor.html#a3a82494b7ae6452a0287b5c96bda137">UnicodeFunctor</a>.
<p>
Implemented in <a class="el" href="classUnicodeSet.html#3b6a82f16ebf6c7cdfa7d6290f585a63">UnicodeSet</a>.
</div>
</div><p>
<a class="anchor" name="3ca4723bfe33095389205f18c15f57a4"></a><!-- doxytag: member="UnicodeFilter::getStaticClassID" ref="3ca4723bfe33095389205f18c15f57a4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> UnicodeFilter::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#_stable001152">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUnicodeFunctor.html#6ea5dfe153e5e4ad5ea3fb5b388ad3d8">UnicodeFunctor</a>.
<p>
Reimplemented in <a class="el" href="classUnicodeSet.html#f96ad55b12fc59dab9c9d9ada476bafa">UnicodeSet</a>.
</div>
</div><p>
<a class="anchor" name="81d095e3b7cff3d61873d2e2a3d6a82b"></a><!-- doxytag: member="UnicodeFilter::matches" ref="81d095e3b7cff3d61873d2e2a3d6a82b" args="(const Replaceable &text, int32_t &offset, int32_t limit, UBool incremental)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="unimatch_8h.html#05562f7626edb48779ce8255b7530b0e">UMatchDegree</a> UnicodeFilter::matches </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classReplaceable.html">Replaceable</a> & </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> & </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>limit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td>
<td class="paramname"> <em>incremental</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implement <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> API.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001149">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>
Implements <a class="el" href="classUnicodeMatcher.html#b55373b0cb513d3cb56b66eeca2ec2f2">UnicodeMatcher</a>.
<p>
Reimplemented in <a class="el" href="classUnicodeSet.html#f9f72d9ed69c59a56cd1aced71ec71d2">UnicodeSet</a>.
</div>
</div><p>
<a class="anchor" name="d4a1e7c617f7b2ad8cf8fbaebd88799b"></a><!-- doxytag: member="UnicodeFilter::setData" ref="d4a1e7c617f7b2ad8cf8fbaebd88799b" args="(const TransliterationRuleData *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void UnicodeFilter::setData </td>
<td>(</td>
<td class="paramtype">const TransliterationRuleData * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classUnicodeFunctor.html">UnicodeFunctor</a> API.
<p>
Nothing to do. <dl compact><dt><b><a class="el" href="stable.html#_stable001150">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>
Implements <a class="el" href="classUnicodeFunctor.html#8c44925267dd6326925f7f56b54cdd10">UnicodeFunctor</a>.
</div>
</div><p>
<a class="anchor" name="3402ff27be422533bae39825b824b56f"></a><!-- doxytag: member="UnicodeFilter::toMatcher" ref="3402ff27be422533bae39825b824b56f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a>* UnicodeFilter::toMatcher </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classUnicodeFunctor.html">UnicodeFunctor</a> API.
<p>
Cast 'this' to a UnicodeMatcher* pointer and return the pointer. <dl compact><dt><b><a class="el" href="stable.html#_stable001148">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUnicodeFunctor.html#e154398d9824c8f8dd2280173b2c18ef">UnicodeFunctor</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="unifilt_8h-source.html">unifilt.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:55 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>
