Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

UnicodeFilter Class Reference

UnicodeFilter defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Unicode characters. More...

#include <unifilt.h>

Inheritance diagram for UnicodeFilter::

UnicodeFunctor UnicodeMatcher UObject UMemory UnicodeSet List of all members.

Public Methods

virtual ~UnicodeFilter ()
 Destructor. More...

virtual UBool contains (UChar32 c) const=0
 Returns true for characters that are in the selected subset. More...

virtual UnicodeMatchertoMatcher () const
 UnicodeFunctor API. More...

virtual UMatchDegree matches (const Replaceable &text, int32_t &offset, int32_t limit, UBool incremental)
 Implement UnicodeMatcher API. More...

virtual void setData (const TransliterationRuleData *)
 UnicodeFunctor API. More...

virtual UClassID getDynamicClassID () const=0
 ICU "poor man's RTTI", returns a UClassID for the actual class. More...


Detailed Description

UnicodeFilter defines a protocol for selecting a subset of the full range (U+0000 to U+10FFFF) of Unicode characters.

Currently, filters are used in conjunction with classes like Transliterator to only process selected characters through a transformation.

Note: UnicodeFilter currently stubs out two pure virtual methods of its base class, UnicodeMatcher. These methods are toPattern() and matchesIndexValue(). 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 UnicodeMatcher base class protocol, and it is not a correct solution.

In the future we may revisit the UnicodeMatcher / UnicodeFilter hierarchy and either redesign it, or simply remove the stubs in UnicodeFilter and force subclasses to implement the full UnicodeMatcher protocol.

See also:
UnicodeFilterLogic
Stable:
ICU 2.0

Definition at line 51 of file unifilt.h.


Constructor & Destructor Documentation

virtual UnicodeFilter::~UnicodeFilter   [virtual]
 

Destructor.

Stable:
ICU 2.0


Member Function Documentation

virtual UBool UnicodeFilter::contains UChar32    c const [pure virtual]
 

Returns true for characters that are in the selected subset.

In other words, if a character is to be filtered, then contains() returns false.

Stable:
ICU 2.0

Reimplemented in UnicodeSet.

virtual UClassID UnicodeFilter::getDynamicClassID void    const [pure virtual]
 

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:
ICU 2.2

Reimplemented from UnicodeFunctor.

Reimplemented in UnicodeSet.

virtual UMatchDegree UnicodeFilter::matches const Replaceable   text,
int32_t &    offset,
int32_t    limit,
UBool    incremental
[virtual]
 

Implement UnicodeMatcher API.

Draft:
This API has been introduced in ICU 2.4. It is still in draft state and may be modified in a future release.

Reimplemented from UnicodeMatcher.

Reimplemented in UnicodeSet.

virtual void UnicodeFilter::setData const TransliterationRuleData *    [virtual]
 

UnicodeFunctor API.

Nothing to do.

Draft:
This API has been introduced in ICU 2.4. It is still in draft state and may be modified in a future release.

Reimplemented from UnicodeFunctor.

virtual UnicodeMatcher* UnicodeFilter::toMatcher   const [virtual]
 

UnicodeFunctor API.

Cast 'this' to a UnicodeMatcher* pointer and return the pointer.

Draft:
This API has been introduced in ICU 2.4. It is still in draft state and may be modified in a future release.

Reimplemented from UnicodeFunctor.


The documentation for this class was generated from the following file:
Generated on Mon Nov 24 14:37:01 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001