IBitwiseCollation

IBitwiseCollation provides bitwise comparison services for text strings. IBitwiseCollation is a concrete class derived from ICollation. It provides the protocol for language-insensitive comparison of text strings. The comparison functions in this class perform a bitwise comparison of the numeric Unicode values in the text strings. ICollation::createCollation creates a bitwise comparison object when the POSIX locale "C" is given as the locale key.

Do not derive from this class.


IBitwiseCollation - Member Functions and Data by Group

Constructors & Destructor

Construct and destruct IBitwiseCollation objects.


[view class]
~IBitwiseCollation
public:
virtual ~IBitwiseCollation()
Destructor for deleting an IBitwiseCollation object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IBitwiseCollation


Overload 1
public:
IBitwiseCollation()
The default constructor for creating a bitwise comparison object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
protected:
IBitwiseCollation(const IBitwiseCollation& copy)
Initializes an IBitwiseCollation object from another IBitwiseCollation object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Assignment Operator

Assign one IBitwiseCollation object to another.


[view class]
operator =
protected:
IBitwiseCollation& operator =( const IBitwiseCollation& that )
Replaces the entire contents with the IBitwiseCollation object being copied in.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Displayable names

Access the displayable name.


[view class]
displayName
public:
virtual IText displayName( const ILocaleKey& desiredLanguage = ILocaleKey::defaultLocale ( ), ILocaleKey::ELookupStrategy strategy = ILocaleKey::kAnyLanguage ) const
Returns the displayable name of a collation object in the specified language, using the given lookup strategy.
desiredLanguage
The locale which the current locale name of this collation object will be displayed in.
strategy
The look-up strategy for the display name of the current collation object. The default value is kAnyLanguage.

Exception

IOutofSystemResource If there is no display name for the given collation object.
IInvalidRequest If the desired locale is supported but not installed.
IInvalidParameter If the desired locale ID is invalid.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Implementation

Overrides of implementation methods of the parent.


[view class]
do_compare
The actual comparison algorithm.
protected:
virtual int do_compare( const UniChar* sourceLow, const UniChar* sourceHigh, const UniChar* targetLow, const UniChar* targetHigh ) const

The actual comparison algorithm. Returns 1 if the source is greater than the target, 0 if both are equal and -1 if the source is less than the target.

sourceLow
Source string beginning offset.
sourceHigh
Source string ending offset.
targetLow
Target string beginning offset.
targetHigh
Target string ending offset.

Exception

IInvalidParameter If sourceHigh is less than sourceLow, or targetHigh is less than targetLow.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
do_transform
protected:
virtual IText do_transform(const IText& source) const
The actual text transforming algorithm Use IText::operator== for the equality test of two transformed strings. Use transform when dealing with index building on large amount of data as one example. Returns the transformed text by value.
source
The source text to be transformed with.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IBitwiseCollation - Inherited Member Functions and Data

Inherited Public Functions

ICollation

Inherited Public Data

Inherited Protected Functions

ICollation

Inherited Protected Data