Main Page | Class Hierarchy | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

Collator Class Reference

The Collator class performs locale-sensitive string comparison. More...

#include <coll.h>

Inheritance diagram for Collator:

RuleBasedCollator

Public Types

enum  ECollationStrength {
  PRIMARY = 0, SECONDARY = 1, TERTIARY = 2, QUATERNARY = 3,
  IDENTICAL = 15
}
 Base letter represents a primary difference. More...
enum  EComparisonResult { LESS = -1, EQUAL = 0, GREATER = 1 }
 LESS is returned if source string is compared to be less than target string in the compare() method. More...

Public Member Functions

virtual ~Collator ()
 Destructor .
virtual UBool operator== (const Collator &other) const
 Returns true if "other" is the same as "this".
virtual UBool operator!= (const Collator &other) const
 Returns true if "other" is not the same as "this".
virtual Collatorclone (void) const =0
 Makes a shallow copy of the current object.
virtual EComparisonResult compare (const UnicodeString &source, const UnicodeString &target) const =0
 The comparison function compares the character data stored in two different strings.
virtual EComparisonResult compare (const UnicodeString &source, const UnicodeString &target, int32_t length) const =0
 Does the same thing as compare but limits the comparison to a specified length.
virtual EComparisonResult compare (const UChar *source, int32_t sourceLength, const UChar *target, int32_t targetLength) const =0
 The comparison function compares the character data stored in two different string arrays.
virtual CollationKeygetCollationKey (const UnicodeString &source, CollationKey &key, UErrorCode &status) const =0
 Transforms the string into a series of characters that can be compared with CollationKey::compareTo.
virtual CollationKeygetCollationKey (const UChar *source, int32_t sourceLength, CollationKey &key, UErrorCode &status) const =0
 Transforms the string into a series of characters that can be compared with CollationKey::compareTo.
virtual int32_t hashCode (void) const =0
 Generates the hash code for the collation object .
virtual const Locale getLocale (ULocDataLocaleType type, UErrorCode &status) const =0
 Gets the locale of the Collator ICU 2.1.
UBool greater (const UnicodeString &source, const UnicodeString &target) const
 Convenience method for comparing two strings based on the collation rules.
UBool greaterOrEqual (const UnicodeString &source, const UnicodeString &target) const
 Convenience method for comparing two strings based on the collation rules.
UBool equals (const UnicodeString &source, const UnicodeString &target) const
 Convenience method for comparing two strings based on the collation rules.
virtual ECollationStrength getStrength (void) const =0
 Determines the minimum strength that will be use in comparison or transformation.
virtual void setStrength (ECollationStrength newStrength)=0
 Sets the minimum strength to be used in comparison or transformation.
virtual void getVersion (UVersionInfo info) const =0
 Gets the version information for a Collator.
virtual UClassID getDynamicClassID (void) const =0
 Returns a unique class ID POLYMORPHICALLY.
virtual void setAttribute (UColAttribute attr, UColAttributeValue value, UErrorCode &status)=0
 Universal attribute setter.
virtual UColAttributeValue getAttribute (UColAttribute attr, UErrorCode &status)=0
 Universal attribute getter.
virtual uint32_t setVariableTop (const UChar *varTop, int32_t len, UErrorCode &status)=0
 Sets the variable top to a collation element value of a string supplied.
virtual uint32_t setVariableTop (const UnicodeString varTop, UErrorCode &status)=0
 Sets the variable top to a collation element value of a string supplied.
virtual void setVariableTop (const uint32_t varTop, UErrorCode &status)=0
 Sets the variable top to a collation element value supplied.
virtual uint32_t getVariableTop (UErrorCode &status) const =0
 Gets the variable top value of a Collator.
virtual CollatorsafeClone (void)=0
 Thread safe cloning operation.
virtual int32_t getSortKey (const UnicodeString &source, uint8_t *result, int32_t resultLength) const =0
 Get the sort key as an array of bytes from an UnicodeString.
virtual int32_t getSortKey (const UChar *source, int32_t sourceLength, uint8_t *result, int32_t resultLength) const =0
 Get the sort key as an array of bytes from an UChar buffer.
virtual Normalizer::EMode getDecomposition (void) const =0
 Get the decomposition mode of the Collator object.
virtual void setDecomposition (Normalizer::EMode mode)=0
 Set the decomposition mode of the Collator object.

Static Public Member Functions

static CollatorcreateInstance (UErrorCode &err)
 Creates the Collator object for the current default locale.
static CollatorcreateInstance (const Locale &loc, UErrorCode &err)
 Gets the table-based collation object for the desired locale.
static CollatorcreateInstance (const Locale &loc, UVersionInfo version, UErrorCode &err)
 Create a Collator with a specific version.
static UnicodeStringgetDisplayName (const Locale &objectLocale, const Locale &displayLocale, UnicodeString &name)
 Get name of the object for the desired Locale, in the desired langauge.
static UnicodeStringgetDisplayName (const Locale &objectLocale, UnicodeString &name)
 Get name of the object for the desired Locale, in the langauge of the default locale.
static const Locale * getAvailableLocales (int32_t &count)
 Get the set of Locales for which Collations are installed.
static int32_t getBound (const uint8_t *source, int32_t sourceLength, UColBoundMode boundType, uint32_t noOfLevels, uint8_t *result, int32_t resultLength, UErrorCode &status)
 Produce a bound for a given sortkey and a number of levels.

Protected Member Functions

 Collator ()
 Default constructor.
 Collator (UCollationStrength collationStrength, UNormalizationMode decompositionMode)
 Constructor.
 Collator (const Collator &other)
 Copy constructor.

Detailed Description

The Collator class performs locale-sensitive string comparison.


You use this class to build searching and sorting routines for natural language text.
Important: The ICU collation service has been reimplemented in order to achieve better performance and UCA compliance. For details, see the collation design document.

Collator is an abstract base class. Subclasses implement specific collation strategies. One subclass, RuleBasedCollator, is currently provided and is applicable to a wide set of languages. Other subclasses may be created to handle more specialized needs.

Like other locale-sensitive classes, you can use the static factory method, createInstance, to obtain the appropriate Collator object for a given locale. You will only need to look at the subclasses of Collator if you need to understand the details of a particular collation strategy or if you need to modify that strategy.

The following example shows how to compare two strings using the Collator for the default locale. <blockquote>

 // Compare two strings in the default locale
 UErrorCode success = U_ZERO_ERROR;
 Collator* myCollator = Collator::createInstance(success);
 if (myCollator->compare("abc", "ABC") < 0)
   cout << "abc is less than ABC" << endl;
 else
   cout << "abc is greater than or equal to ABC" << endl;
</blockquote>

You can set a Collator's strength property to determine the level of difference considered significant in comparisons. Five strengths are provided: PRIMARY, SECONDARY, TERTIARY, QUATERNARY and IDENTICAL. The exact assignment of strengths to language features is locale dependant. For example, in Czech, "e" and "f" are considered primary differences, while "e" and "\u00EA" are secondary differences, "e" and "E" are tertiary differences and "e" and "e" are identical. The following shows how both case and accents could be ignored for US English. <blockquote>

 //Get the Collator for US English and set its strength to PRIMARY 
 UErrorCode success = U_ZERO_ERROR;
 Collator* usCollator = 
                            Collator::createInstance(Locale::US, success);
 usCollator->setStrength(Collator::PRIMARY);
 if (usCollator->compare("abc", "ABC") == 0)
   cout << 
 "'abc' and 'ABC' strings are equivalent with strength PRIMARY" << 
 endl;
</blockquote>

For comparing strings exactly once, the compare method provides the best performance. When sorting a list of strings however, it is generally necessary to compare each string multiple times. In this case, sort keys provide better performance. The getSortKey methods convert a string to a series of bytes that can be compared bitwise against other sort keys using strcmp(). Sort keys are written as zero-terminated byte strings. They consist of several substrings, one for each collation strength level, that are delimited by 0x01 bytes. If the string code points are appended for UCOL_IDENTICAL, then they are processed for correct code point order comparison and may contain 0x01 bytes but not zero bytes.

An older set of APIs returns a CollationKey object that wraps the sort key bytes instead of returning the bytes themselves. Its use is deprecated, but it is still available for compatibility with Java.

Note: Collators with different Locale, and CollationStrength settings will return different sort orders for the same set of strings. Locales have specific collation rules, and the way in which secondary and tertiary differences are taken into account, for example, will result in a different sorting order for same strings.

See also:
RuleBasedCollator

CollationKey

CollationElementIterator

Locale

Normalizer

Version:
2.0 11/15/01


Member Enumeration Documentation

enum Collator::ECollationStrength
 

Base letter represents a primary difference.

Set comparison level to PRIMARY to ignore secondary and tertiary differences.
Use this to set the strength of a Collator object.
Example of primary difference, "abc" < "abd"

Diacritical differences on the same base letter represent a secondary difference. Set comparison level to SECONDARY to ignore tertiary differences. Use this to set the strength of a Collator object.
Example of secondary difference, "ä" >> "a".

Uppercase and lowercase versions of the same character represents a tertiary difference. Set comparison level to TERTIARY to include all comparison differences. Use this to set the strength of a Collator object.
Example of tertiary difference, "abc" <<< "ABC".

Two characters are considered "identical" when they have the same unicode spellings.
For example, "ä" == "ä".

UCollationStrength is also used to determine the strength of sort keys generated from Collator objects.

enum Collator::EComparisonResult
 

LESS is returned if source string is compared to be less than target string in the compare() method.

EQUAL is returned if source string is compared to be equal to target string in the compare() method. GREATER is returned if source string is compared to be greater than target string in the compare() method.

See also:
Collator::compare


Constructor & Destructor Documentation

Collator::Collator  )  [protected]
 

Default constructor.

Constructor is different from the old default Collator constructor. The task for determing the default collation strength and normalization mode is left to the child class.

Collator::Collator UCollationStrength  collationStrength,
UNormalizationMode  decompositionMode
[protected]
 

Constructor.

Empty constructor, does not handle the arguments. This constructor is done for backward compatibility with 1.7 and 1.8. The task for handling the argument collation strength and normalization mode is left to the child class.

Parameters:
collationStrength collation strength
decompositionMode 

Collator::Collator const Collator other  )  [protected]
 

Copy constructor.

Parameters:
other Collator object to be copied from


Member Function Documentation

virtual Collator* Collator::clone void   )  const [pure virtual]
 

Makes a shallow copy of the current object.

Returns:
a copy of this object

Implemented in RuleBasedCollator.

virtual EComparisonResult Collator::compare const UChar source,
int32_t  sourceLength,
const UChar target,
int32_t  targetLength
const [pure virtual]
 

The comparison function compares the character data stored in two different string arrays.

Returns information about whether a string array is less than, greater than or equal to another string array.

Parameters:
source the source string array to be compared with.
sourceLength the length of the source string array. If this value is equal to -1, the string array is null-terminated.
target the string that is to be compared with the source string.
targetLength the length of the target string array. If this value is equal to -1, the string array is null-terminated.
Returns:
Returns a byte value. GREATER if source is greater than target; EQUAL if source is equal to target; LESS if source is less than target

Implemented in RuleBasedCollator.

virtual EComparisonResult Collator::compare const UnicodeString source,
const UnicodeString target,
int32_t  length
const [pure virtual]
 

Does the same thing as compare but limits the comparison to a specified length.

Parameters:
source the source string to be compared with.
target the string that is to be compared with the source string.
length the length the comparison is limitted to
Returns:
Returns a byte value. GREATER if source (up to the specified length) is greater than target; EQUAL if source (up to specified length) is equal to target; LESS if source (up to the specified length) is less than target.

Implemented in RuleBasedCollator.

virtual EComparisonResult Collator::compare const UnicodeString source,
const UnicodeString target
const [pure virtual]
 

The comparison function compares the character data stored in two different strings.

Returns information about whether a string is less than, greater than or equal to another string.

Parameters:
source the source string to be compared with.
target the string that is to be compared with the source string.
Returns:
Returns a byte value. GREATER if source is greater than target; EQUAL if source is equal to target; LESS if source is less than target

Implemented in RuleBasedCollator.

static Collator* Collator::createInstance const Locale &  loc,
UVersionInfo  version,
UErrorCode err
[static]
 

Create a Collator with a specific version.

This is the same as createInstance(loc, err) except that getVersion() of the returned object is guaranteed to be the same as the version parameter. This is designed to be used to open the same collator for a given locale even when ICU is updated. The same locale and version guarantees the same sort keys and comparison results.

Parameters:
loc The locale ID for which to open a collator.
version The requested collator version.
err A reference to a UErrorCode, must not indicate a failure before calling this function.
Returns:
A pointer to a Collator, or 0 if an error occurred or a collator with the requested version is not available.
See also:
getVersion ICU 1.8

static Collator* Collator::createInstance const Locale &  loc,
UErrorCode err
[static]
 

Gets the table-based collation object for the desired locale.

The resource of the desired locale will be loaded by ResourceLoader. Locale::ENGLISH is the base collation table and all other languages are built on top of it with additional language-specific modifications. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of U_SUCCESS(err). If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it.

Parameters:
desiredLocale the desired locale to create the collation table with.
Returns:
the created table-based collation object based on the desired locale.
See also:
Locale

ResourceLoader

static Collator* Collator::createInstance UErrorCode err  )  [static]
 

Creates the Collator object for the current default locale.

The default locale is determined by Locale::getDefault. The UErrorCode& err parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of U_SUCCESS(err). If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_ERROR indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_ERROR indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it.

Returns:
the collation object of the default locale.(for example, en_US)
See also:
Locale::getDefault

UBool Collator::equals const UnicodeString source,
const UnicodeString target
const
 

Convenience method for comparing two strings based on the collation rules.

Parameters:
source the source string to be compared with.
target the target string to be compared with.
Returns:
true if the strings are equal according to the collation rules. false, otherwise.
See also:
Collator::compare

virtual UColAttributeValue Collator::getAttribute UColAttribute  attr,
UErrorCode status
[pure virtual]
 

Universal attribute getter.

Parameters:
attr attribute type
status to indicate whether the operation went on smoothly or there were errors
Returns:
attribute value ICU 1.8

Implemented in RuleBasedCollator.

static const Locale* Collator::getAvailableLocales int32_t &  count  )  [static]
 

Get the set of Locales for which Collations are installed.

Parameters:
count the output parameter of number of elements in the locale list
Returns:
the list of available locales which collations are installed

static int32_t Collator::getBound const uint8_t *  source,
int32_t  sourceLength,
UColBoundMode  boundType,
uint32_t  noOfLevels,
uint8_t *  result,
int32_t  resultLength,
UErrorCode status
[static]
 

Produce a bound for a given sortkey and a number of levels.

Return value is always the number of bytes needed, regardless of whether the result buffer was big enough or even valid.
Resulting bounds can be used to produce a range of strings that are between upper and lower bounds. For example, if bounds are produced for a sortkey of string "smith", strings between upper and lower bounds with one level would include "Smith", "SMITH", "sMiTh".
There are two upper bounds that can be produced. If UCOL_BOUND_UPPER is produced, strings matched would be as above. However, if bound produced using UCOL_BOUND_UPPER_LONG is used, the above example will also match "Smithsonian" and similar.
For more on usage, see example in cintltst/capitst.c in procedure TestBounds. Sort keys may be compared using strcmp.

Parameters:
source The source sortkey.
sourceLength The length of source, or -1 if null-terminated. (If an unmodified sortkey is passed, it is always null terminated).
boundType Type of bound required. It can be UCOL_BOUND_LOWER, which produces a lower inclusive bound, UCOL_BOUND_UPPER, that produces upper bound that matches strings of the same length or UCOL_BOUND_UPPER_LONG that matches strings that have the same starting substring as the source string.
noOfLevels Number of levels required in the resulting bound (for most uses, the recommended value is 1). See users guide for explanation on number of levels a sortkey can have.
result A pointer to a buffer to receive the resulting sortkey.
resultLength The maximum size of result.
status Used for returning error code if something went wrong. If the number of levels requested is higher than the number of levels in the source key, a warning (U_SORT_KEY_TOO_SHORT_WARNING) is issued.
Returns:
The size needed to fully store the bound.
See also:
ucol_keyHashCode ICU 2.1

virtual CollationKey& Collator::getCollationKey const UChar source,
int32_t  sourceLength,
CollationKey key,
UErrorCode status
const [pure virtual]
 

Transforms the string into a series of characters that can be compared with CollationKey::compareTo.

It is not possible to restore the original string from the chars in the sort key. The generated sort key handles only a limited number of ignorable characters.

Use CollationKey::equals or CollationKey::compare to compare the generated sort keys.

If the source string is null, a null collation key will be returned.

Parameters:
source the source string to be transformed into a sort key.
sourceLength length of the collation key
key the collation key to be filled in
Returns:
the collation key of the string based on the collation rules.
See also:
CollationKey::compare

Implemented in RuleBasedCollator.

virtual CollationKey& Collator::getCollationKey const UnicodeString source,
CollationKey key,
UErrorCode status
const [pure virtual]
 

Transforms the string into a series of characters that can be compared with CollationKey::compareTo.

It is not possible to restore the original string from the chars in the sort key. The generated sort key handles only a limited number of ignorable characters.

Use CollationKey::equals or CollationKey::compare to compare the generated sort keys. If the source string is null, a null collation key will be returned.

Parameters:
source the source string to be transformed into a sort key.
key the collation key to be filled in
Returns:
the collation key of the string based on the collation rules.
See also:
CollationKey::compare

Implemented in RuleBasedCollator.

virtual Normalizer::EMode Collator::getDecomposition void   )  const [pure virtual]
 

Get the decomposition mode of the Collator object.

Returns:
the decomposition mode
See also:
Collator::setDecomposition
Deprecated:
To be removed after 2002-sep-30; use getAttribute().

Implemented in RuleBasedCollator.

static UnicodeString& Collator::getDisplayName const Locale &  objectLocale,
UnicodeString name
[static]
 

Get name of the object for the desired Locale, in the langauge of the default locale.

Parameters:
objectLocale must be from getAvailableLocales
name the fill-in parameter of the return value
Returns:
name of the object for the desired locale in the default language

static UnicodeString& Collator::getDisplayName const Locale &  objectLocale,
const Locale &  displayLocale,
UnicodeString name
[static]
 

Get name of the object for the desired Locale, in the desired langauge.

Parameters:
objectLocale must be from getAvailableLocales
displayLocale specifies the desired locale for output
name the fill-in parameter of the return value
Returns:
display-able name of the object for the object locale in the desired language

virtual UClassID Collator::getDynamicClassID void   )  const [pure virtual]
 

Returns a unique class ID POLYMORPHICALLY.

Pure virtual method. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method. Concrete subclasses of Format must implement getDynamicClassID() and also a static method and data member: static UClassID getStaticClassID() { return (UClassID) } static char fgClassID;

Returns:
The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Implemented in RuleBasedCollator.

virtual int32_t Collator::getSortKey const UChar source,
int32_t  sourceLength,
uint8_t *  result,
int32_t  resultLength
const [pure virtual]
 

Get the sort key as an array of bytes from an UChar buffer.

Sort key byte arrays are zero-terminated and can be compared using strcmp().

Parameters:
source string to be processed.
sourceLength length of string to be processed. If -1, the string is 0 terminated and length will be decided by the function.
result buffer to store result in. If NULL, number of bytes needed will be returned.
resultLength length of the result buffer. If if not enough the buffer will be filled to capacity.
Returns:
Number of bytes needed for storing the sort key ICU 1.8

Implemented in RuleBasedCollator.

virtual int32_t Collator::getSortKey const UnicodeString source,
uint8_t *  result,
int32_t  resultLength
const [pure virtual]
 

Get the sort key as an array of bytes from an UnicodeString.

Sort key byte arrays are zero-terminated and can be compared using strcmp().

Parameters:
source string to be processed.
result buffer to store result in. If NULL, number of bytes needed will be returned.
resultLength length of the result buffer. If if not enough the buffer will be filled to capacity.
Returns:
Number of bytes needed for storing the sort key ICU 1.8

Implemented in RuleBasedCollator.

virtual ECollationStrength Collator::getStrength void   )  const [pure virtual]
 

Determines the minimum strength that will be use in comparison or transformation.

E.g. with strength == SECONDARY, the tertiary difference is ignored

E.g. with strength == PRIMARY, the secondary and tertiary difference are ignored.

Returns:
the current comparison level.
See also:
Collator::setStrength

Implemented in RuleBasedCollator.

virtual uint32_t Collator::getVariableTop UErrorCode status  )  const [pure virtual]
 

Gets the variable top value of a Collator.

Lower 16 bits are undefined and should be ignored.

Parameters:
status error code (not changed by function). If error code is set, the return value is undefined. ICU 2.0

Implemented in RuleBasedCollator.

virtual void Collator::getVersion UVersionInfo  info  )  const [pure virtual]
 

Gets the version information for a Collator.

Parameters:
info the version # information, the result will be filled in

Implemented in RuleBasedCollator.

UBool Collator::greater const UnicodeString source,
const UnicodeString target
const
 

Convenience method for comparing two strings based on the collation rules.

Parameters:
source the source string to be compared with.
target the target string to be compared with.
Returns:
true if the first string is greater than the second one, according to the collation rules. false, otherwise.
See also:
Collator::compare

UBool Collator::greaterOrEqual const UnicodeString source,
const UnicodeString target
const
 

Convenience method for comparing two strings based on the collation rules.

Parameters:
source the source string to be compared with.
target the target string to be compared with.
Returns:
true if the first string is greater than or equal to the second one, according to the collation rules. false, otherwise.
See also:
Collator::compare

UBool Collator::operator!= const Collator other  )  const [inline, virtual]
 

Returns true if "other" is not the same as "this".

Parameters:
other Collator object to be compared
Returns:
true if other is not the same as this.

Reimplemented in RuleBasedCollator.

UBool Collator::operator== const Collator other  )  const [inline, virtual]
 

Returns true if "other" is the same as "this".

Parameters:
other Collator object to be compared
Returns:
true if other is the same as this.

Reimplemented in RuleBasedCollator.

virtual Collator* Collator::safeClone void   )  [pure virtual]
 

Thread safe cloning operation.

Returns:
pointer to the new clone, user should remove it. ICU 1.8

Implemented in RuleBasedCollator.

virtual void Collator::setAttribute UColAttribute  attr,
UColAttributeValue  value,
UErrorCode status
[pure virtual]
 

Universal attribute setter.

Parameters:
attr attribute type
value attribute value
status to indicate whether the operation went on smoothly or there were errors ICU 1.8

Implemented in RuleBasedCollator.

virtual void Collator::setDecomposition Normalizer::EMode  mode  )  [pure virtual]
 

Set the decomposition mode of the Collator object.

success is equal to U_ILLEGAL_ARGUMENT_ERROR if error occurs.

Parameters:
the new decomposition mode
See also:
Collator::getDecomposition
Deprecated:
To be removed after 2002-sep-30; use setAttribute().

Implemented in RuleBasedCollator.

virtual void Collator::setStrength ECollationStrength  newStrength  )  [pure virtual]
 

Sets the minimum strength to be used in comparison or transformation.

Example of use:

  UErrorCode status = U_ZERO_ERROR;
  Collator*myCollation = Collator::createInstance(Locale::US, 
                                                         status);
  if (U_FAILURE(status)) return;
  myCollation->setStrength(Collator::PRIMARY);
  // result will be "abc" == "ABC"
  // tertiary differences will be ignored
  Collator::ComparisonResult result = myCollation->compare("abc", 
                                                              "ABC");
See also:
Collator::getStrength
Parameters:
newStrength the new comparison level.

virtual void Collator::setVariableTop const uint32_t  varTop,
UErrorCode status
[pure virtual]
 

Sets the variable top to a collation element value supplied.

Variable top is set to the upper 16 bits. Lower 16 bits are ignored.

Parameters:
varTop CE value, as returned by setVariableTop or ucol)getVariableTop
status error code (not changed by function) ICU 2.0

Implemented in RuleBasedCollator.

virtual uint32_t Collator::setVariableTop const UnicodeString  varTop,
UErrorCode status
[pure virtual]
 

Sets the variable top to a collation element value of a string supplied.

Parameters:
varTop an UnicodeString size 1 or more (if contraction) of UChars to which the variable top should be set
status error code. If error code is set, the return value is undefined. Errors set by this function are:
U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such a contraction
U_PRIMARY_TOO_LONG_ERROR if the primary for the variable top has more than two bytes
Returns:
a 32 bit value containing the value of the variable top in upper 16 bits. Lower 16 bits are undefined ICU 2.0

Implemented in RuleBasedCollator.

virtual uint32_t Collator::setVariableTop const UChar varTop,
int32_t  len,
UErrorCode status
[pure virtual]
 

Sets the variable top to a collation element value of a string supplied.

Parameters:
varTop one or more (if contraction) UChars to which the variable top should be set
len length of variable top string. If -1 it is considered to be zero terminated.
status error code. If error code is set, the return value is undefined. Errors set by this function are:
U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such a contraction
U_PRIMARY_TOO_LONG_ERROR if the primary for the variable top has more than two bytes
Returns:
a 32 bit value containing the value of the variable top in upper 16 bits. Lower 16 bits are undefined ICU 2.0

Implemented in RuleBasedCollator.


The documentation for this class was generated from the following file:
Generated on Sun Aug 21 23:34:52 2005 for ICU 2.1 by  doxygen 1.4.4