The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables. More...

#include <tblcoll.h>

Inheritance diagram for RuleBasedCollator:

Public Member Functions
	RuleBasedCollator (const UnicodeString &rules, UErrorCode &status)
	RuleBasedCollator constructor.

	RuleBasedCollator (const UnicodeString &rules, ECollationStrength collationStrength, UErrorCode &status)
	RuleBasedCollator constructor.

	RuleBasedCollator (const UnicodeString &rules, UColAttributeValue decompositionMode, UErrorCode &status)
	RuleBasedCollator constructor.

	RuleBasedCollator (const UnicodeString &rules, ECollationStrength collationStrength, UColAttributeValue decompositionMode, UErrorCode &status)
	RuleBasedCollator constructor.

	RuleBasedCollator (const RuleBasedCollator &other)
	Copy constructor.

	RuleBasedCollator (const uint8_t bin, int32_t length, const RuleBasedCollator base, UErrorCode &status)
	Opens a collator from a collator binary image created using cloneBinary.

virtual	~RuleBasedCollator ()
	Destructor.

RuleBasedCollator &	operator= (const RuleBasedCollator &other)
	Assignment operator.

virtual UBool	operator== (const Collator &other) const
	Returns true if argument is the same as this object.

virtual Collator *	clone (void) const
	Makes a copy of this object.

virtual CollationElementIterator *	createCollationElementIterator (const UnicodeString &source) const
	Creates a collation element iterator for the source string.

virtual CollationElementIterator *	createCollationElementIterator (const CharacterIterator &source) const
	Creates a collation element iterator for the source.

virtual UCollationResult	compare (const UnicodeString &source, const UnicodeString &target, UErrorCode &status) const
	The comparison function compares the character data stored in two different strings.

virtual UCollationResult	compare (const UnicodeString &source, const UnicodeString &target, int32_t length, UErrorCode &status) const
	Does the same thing as compare but limits the comparison to a specified length.

virtual UCollationResult	compare (const UChar source, int32_t sourceLength, const UChar target, int32_t targetLength, UErrorCode &status) const
	The comparison function compares the character data stored in two different string arrays.

virtual UCollationResult	compare (UCharIterator &sIter, UCharIterator &tIter, UErrorCode &status) const
	Compares two strings using the Collator.

virtual CollationKey &	getCollationKey (const UnicodeString &source, CollationKey &key, UErrorCode &status) const
	Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare.

virtual CollationKey &	getCollationKey (const UChar *source, int32_t sourceLength, CollationKey &key, UErrorCode &status) const
	Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare.

virtual int32_t	hashCode (void) const
	Generates the hash code for the rule-based collation object.

virtual Locale	getLocale (ULocDataLocaleType type, UErrorCode &status) const
	Gets the locale of the Collator.

const UnicodeString &	getRules (void) const
	Gets the tailoring rules for this collator.

virtual void	getVersion (UVersionInfo info) const
	Gets the version information for a Collator.

int32_t	getMaxExpansion (int32_t order) const
	Return the maximum length of any expansion sequences that end with the specified comparison order.

virtual UClassID	getDynamicClassID (void) const
	Returns a unique class ID POLYMORPHICALLY.

uint8_t *	cloneRuleData (int32_t &length, UErrorCode &status)
	Returns the binary format of the class's rules.

int32_t	cloneBinary (uint8_t *buffer, int32_t capacity, UErrorCode &status)
	Creates a binary image of a collator.

void	getRules (UColRuleOption delta, UnicodeString &buffer)
	Returns current rules.

virtual void	setAttribute (UColAttribute attr, UColAttributeValue value, UErrorCode &status)
	Universal attribute setter.

virtual UColAttributeValue	getAttribute (UColAttribute attr, UErrorCode &status) const
	Universal attribute getter.

virtual uint32_t	setVariableTop (const UChar *varTop, int32_t len, UErrorCode &status)
	Sets the variable top to a collation element value of a string supplied.

virtual uint32_t	setVariableTop (const UnicodeString &varTop, UErrorCode &status)
	Sets the variable top to a collation element value of a string supplied.

virtual void	setVariableTop (uint32_t varTop, UErrorCode &status)
	Sets the variable top to a collation element value supplied.

virtual uint32_t	getVariableTop (UErrorCode &status) const
	Gets the variable top value of a Collator.

virtual UnicodeSet *	getTailoredSet (UErrorCode &status) const
	Get an UnicodeSet that contains all the characters and sequences tailored in this collator.

virtual int32_t	getSortKey (const UnicodeString &source, uint8_t *result, int32_t resultLength) const
	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
	Get the sort key as an array of bytes from an UChar buffer.

virtual int32_t	getReorderCodes (int32_t *dest, int32_t destCapacity, UErrorCode &status) const
	Retrieves the reordering codes for this collator.

virtual void	setReorderCodes (const int32_t *reorderCodes, int32_t reorderCodesLength, UErrorCode &status)
	Sets the ordering of scripts for this collator.

const UCollator *	getUCollator ()
	Get UCollator data struct.

virtual int32_t	internalGetShortDefinitionString (const char locale, char buffer, int32_t capacity, UErrorCode &status) const
	Get the short definition string for a collator.

virtual EComparisonResult	compare (const UnicodeString &source, const UnicodeString &target) const
	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
	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
	The comparison function compares the character data stored in two different string arrays.

Public Member Functions inherited from Collator
virtual	~Collator ()
	Destructor.

virtual UBool	operator!= (const Collator &other) const
	Returns true if "other" is not the same as "this".

virtual UCollationResult	compareUTF8 (const StringPiece &source, const StringPiece &target, UErrorCode &status) const
	Compares two UTF-8 strings using the Collator.

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
	Determines the minimum strength that will be used in comparison or transformation.

virtual void	setStrength (ECollationStrength newStrength)
	Sets the minimum strength to be used in comparison or transformation.

virtual Collator *	safeClone (void) const
	Same as clone().

Public Member Functions inherited from UObject
virtual	~UObject ()
	Destructor.

Static Public Member Functions
static UClassID	getStaticClassID (void)
	Returns the class ID for this class.

static int32_t	getEquivalentReorderCodes (int32_t reorderCode, int32_t *dest, int32_t destCapacity, UErrorCode &status)
	Retrieves the reorder codes that are grouped with the given reorder code.

Static Public Member Functions inherited from Collator
static Collator *	createInstance (UErrorCode &err)
	Creates the Collator object for the current default locale.

static Collator *	createInstance (const Locale &loc, UErrorCode &err)
	Gets the table-based collation object for the desired locale.

static int32_t	getEquivalentReorderCodes (int32_t reorderCode, int32_t *dest, int32_t destCapacity, UErrorCode &status)
	Retrieves the reorder codes that are grouped with the given reorder code.

static UnicodeString &	getDisplayName (const Locale &objectLocale, const Locale &displayLocale, UnicodeString &name)
	Get name of the object for the desired Locale, in the desired langauge.

static UnicodeString &	getDisplayName (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 StringEnumeration *	getAvailableLocales (void)
	Return a StringEnumeration over the locales available at the time of the call, including registered locales.

static StringEnumeration *	getKeywords (UErrorCode &status)
	Create a string enumerator of all possible keywords that are relevant to collation.

static StringEnumeration *	getKeywordValues (const char *keyword, UErrorCode &status)
	Given a keyword, create a string enumeration of all values for that keyword that are currently in use.

static StringEnumeration *	getKeywordValuesForLocale (const char *keyword, const Locale &locale, UBool commonlyUsed, UErrorCode &status)
	Given a key and a locale, returns an array of string values in a preferred order that would make a difference.

static Locale	getFunctionalEquivalent (const char *keyword, const Locale &locale, UBool &isAvailable, UErrorCode &status)
	Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service.

static URegistryKey	registerInstance (Collator *toAdopt, const Locale &locale, UErrorCode &status)
	Register a new Collator.

static URegistryKey	registerFactory (CollatorFactory *toAdopt, UErrorCode &status)
	Register a new CollatorFactory.

static UBool	unregister (URegistryKey key, UErrorCode &status)
	Unregister a previously-registered Collator or CollatorFactory using the key returned from the register call.

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.

static UCollator *	createUCollator (const char loc, UErrorCode status)
	used only by ucol_open, not for public use

Protected Member Functions
virtual void	setLocales (const Locale &requestedLocale, const Locale &validLocale, const Locale &actualLocale)
	Used internally by registraton to define the requested and valid locales.

Protected Member Functions inherited from Collator
	Collator ()
	Default constructor.

	Collator (UCollationStrength collationStrength, UNormalizationMode decompositionMode)
	Constructor.

	Collator (const Collator &other)
	Copy constructor.

Friends
class	CollationElementIterator
	Used to iterate over collation elements in a character source.

class	Collator
	Collator ONLY needs access to RuleBasedCollator(const Locale&, UErrorCode&)

class	StringSearch
	Searching over collation elements in a character source.

Additional Inherited Members
Public Types inherited from Collator
enum	ECollationStrength { PRIMARY = UCOL_PRIMARY , SECONDARY = UCOL_SECONDARY , TERTIARY = UCOL_TERTIARY , QUATERNARY = UCOL_QUATERNARY , IDENTICAL = UCOL_IDENTICAL }
	Base letter represents a primary difference. More...

enum	EComparisonResult { LESS = UCOL_LESS , EQUAL = UCOL_EQUAL , GREATER = UCOL_GREATER }
	LESS is returned if source string is compared to be less than target string in the compare() method. More...

Detailed Description

The RuleBasedCollator class provides the simple implementation of Collator, using data-driven tables.

The user can create a customized table-based collation.

Important: The ICU collation service has been reimplemented in order to achieve better performance and UCA compliance. For details, see the collation design document.

RuleBasedCollator is a thin C++ wrapper over the C implementation.

For more information about the collation service see the users guide.

Collation service provides correct sorting orders for most locales supported in ICU. If specific data for a locale is not available, the orders eventually falls back to the UCA sort order.

Sort ordering may be customized by providing your own set of rules. For more on this subject see the Collation customization section of the users guide.

Note, RuleBasedCollator is not to be subclassed.

See also: Collator

Version: 2.0 11/15/2001

Definition at line 111 of file tblcoll.h.

Constructor & Destructor Documentation

◆ RuleBasedCollator() [1/6]

RuleBasedCollator::RuleBasedCollator	(	const UnicodeString &	rules,
		UErrorCode &	status )

RuleBasedCollator constructor.

This takes the table rules and builds a collation table out of them. Please see RuleBasedCollator class description for more details on the collation rule syntax.

Parameters

rules	the collation rules to build the collation table from.
status	reporting a success or an error.

See also: Locale

Stable: ICU 2.0

Referenced by operator=(), RuleBasedCollator(), RuleBasedCollator(), and StringSearch.

◆ RuleBasedCollator() [2/6]

RuleBasedCollator::RuleBasedCollator	(	const UnicodeString &	rules,
		ECollationStrength	collationStrength,
		UErrorCode &	status )

RuleBasedCollator constructor.

This takes the table rules and builds a collation table out of them. Please see RuleBasedCollator class description for more details on the collation rule syntax.

Parameters

rules	the collation rules to build the collation table from.
collationStrength	default strength for comparison
status	reporting a success or an error.

See also: Locale

Stable: ICU 2.0

◆ RuleBasedCollator() [3/6]

RuleBasedCollator::RuleBasedCollator	(	const UnicodeString &	rules,
		UColAttributeValue	decompositionMode,
		UErrorCode &	status )

RuleBasedCollator constructor.

This takes the table rules and builds a collation table out of them. Please see RuleBasedCollator class description for more details on the collation rule syntax.

Parameters

rules	the collation rules to build the collation table from.
decompositionMode	the normalisation mode
status	reporting a success or an error.

See also: Locale

Stable: ICU 2.0

◆ RuleBasedCollator() [4/6]

RuleBasedCollator::RuleBasedCollator	(	const UnicodeString &	rules,
		ECollationStrength	collationStrength,
		UColAttributeValue	decompositionMode,
		UErrorCode &	status )

RuleBasedCollator constructor.

This takes the table rules and builds a collation table out of them. Please see RuleBasedCollator class description for more details on the collation rule syntax.

Parameters

rules	the collation rules to build the collation table from.
collationStrength	default strength for comparison
decompositionMode	the normalisation mode
status	reporting a success or an error.

See also: Locale

Stable: ICU 2.0

◆ RuleBasedCollator() [5/6]

RuleBasedCollator::RuleBasedCollator ( const RuleBasedCollator & other )

Copy constructor.

Parameters

other the RuleBasedCollator object to be copied

See also: Locale

Stable: ICU 2.0

References RuleBasedCollator().

◆ RuleBasedCollator() [6/6]

RuleBasedCollator::RuleBasedCollator	(	const uint8_t *	bin,
		int32_t	length,
		const RuleBasedCollator *	base,
		UErrorCode &	status )

Opens a collator from a collator binary image created using cloneBinary.

Binary image used in instantiation of the collator remains owned by the user and should stay around for the lifetime of the collator. The API also takes a base collator which usualy should be UCA.

Parameters

bin	binary image owned by the user and required through the lifetime of the collator
length	size of the image. If negative, the API will try to figure out the length of the image
base	fallback collator, usually UCA. Base is required to be present through the lifetime of the collator. Currently it cannot be NULL.
status	for catching errors

Returns: newly created collator

See also: cloneBinary

Stable: ICU 3.4

References RuleBasedCollator().

◆ ~RuleBasedCollator()

virtual RuleBasedCollator::~RuleBasedCollator ( )

virtual

Destructor.

Stable: ICU 2.0

Member Function Documentation

◆ clone()

virtual Collator * RuleBasedCollator::clone ( void ) const

virtual

Makes a copy of this object.

Returns: a copy of this object, owned by the caller

Stable: ICU 2.0

Implements Collator.

References Collator.

◆ cloneBinary()

int32_t RuleBasedCollator::cloneBinary	(	uint8_t *	buffer,
		int32_t	capacity,
		UErrorCode &	status )

Creates a binary image of a collator.

This binary image can be stored and later used to instantiate a collator using ucol_openBinary. This API supports preflighting.

Parameters

buffer	a fill-in buffer to receive the binary image
capacity	capacity of the destination buffer
status	for catching errors

Returns: size of the image

See also: ucol_openBinary

Stable: ICU 3.4

◆ cloneRuleData()

uint8_t * RuleBasedCollator::cloneRuleData	(	int32_t &	length,
		UErrorCode &	status )

Returns the binary format of the class's rules.

The format is that of .col files.

Parameters

length	Returns the length of the data, in bytes
status	the error code status.

Returns: memory, owned by the caller, of size 'length' bytes.

Stable: ICU 2.2

◆ compare() [1/7]

virtual EComparisonResult Collator::compare	(	const UChar *	source,
		int32_t	sourceLength,
		const UChar *	target,
		int32_t	targetLength ) const

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.

Example of use:

.       UChar ABC[] = {0x41, 0x42, 0x43, 0};  // = "ABC"
.       UChar abc[] = {0x61, 0x62, 0x63, 0};  // = "abc"
.       UErrorCode status = U_ZERO_ERROR;
.       Collator *myCollation =
.                         Collator::createInstance(Locale::US, status);
.       if (U_FAILURE(status)) return;
.       myCollation->setStrength(Collator::PRIMARY);
.       // result would be Collator::EQUAL ("abc" == "ABC")
.       // (no primary difference between "abc" and "ABC")
.       Collator::EComparisonResult result =
.                             myCollation->compare(abc, 3, ABC, 3);
.       myCollation->setStrength(Collator::TERTIARY);
.       // result would be Collator::LESS ("abc" <<< "ABC")
.       // (with tertiary difference between "abc" and "ABC")
.       result = myCollation->compare(abc, 3, ABC, 3);

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

Deprecated: ICU 2.6 use the overload with UErrorCode &

Reimplemented from Collator.

◆ compare() [2/7]

virtual UCollationResult RuleBasedCollator::compare	(	const UChar *	source,
		int32_t	sourceLength,
		const UChar *	target,
		int32_t	targetLength,
		UErrorCode &	status ) const

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.
status	possible error code

Returns: Returns an enum value. UCOL_GREATER if source is greater than target; UCOL_EQUAL if source is equal to target; UCOL_LESS if source is less than target

Stable: ICU 2.6

Implements Collator.

◆ compare() [3/7]

virtual EComparisonResult Collator::compare	(	const UnicodeString &	source,
		const UnicodeString &	target ) const

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

Deprecated: ICU 2.6 use the overload with UErrorCode &

Reimplemented from Collator.

◆ compare() [4/7]

virtual EComparisonResult Collator::compare	(	const UnicodeString &	source,
		const UnicodeString &	target,
		int32_t	length ) const

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 limited 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.

Deprecated: ICU 2.6 use the overload with UErrorCode &

Reimplemented from Collator.

◆ compare() [5/7]

virtual UCollationResult RuleBasedCollator::compare	(	const UnicodeString &	source,
		const UnicodeString &	target,
		int32_t	length,
		UErrorCode &	status ) const

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 limited to
status	possible error code

Returns: Returns an enum value. UCOL_GREATER if source (up to the specified length) is greater than target; UCOL_EQUAL if source (up to specified length) is equal to target; UCOL_LESS if source (up to the specified length) is less than target.

Stable: ICU 2.6

Implements Collator.

◆ compare() [6/7]

virtual UCollationResult RuleBasedCollator::compare	(	const UnicodeString &	source,
		const UnicodeString &	target,
		UErrorCode &	status ) const

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.
status	possible error code

Returns: Returns an enum value. UCOL_GREATER if source is greater than target; UCOL_EQUAL if source is equal to target; UCOL_LESS if source is less than target

Stable: ICU 2.6

Implements Collator.

◆ compare() [7/7]

virtual UCollationResult RuleBasedCollator::compare	(	UCharIterator &	sIter,
		UCharIterator &	tIter,
		UErrorCode &	status ) const

virtual

Compares two strings using the Collator.

Returns whether the first one compares less than/equal to/greater than the second one. This version takes UCharIterator input.

Parameters

sIter	the first ("source") string iterator
tIter	the second ("target") string iterator
status	ICU status

Returns: UCOL_LESS, UCOL_EQUAL or UCOL_GREATER

Stable: ICU 4.2

Reimplemented from Collator.

◆ createCollationElementIterator() [1/2]

virtual CollationElementIterator * RuleBasedCollator::createCollationElementIterator ( const CharacterIterator & source ) const

virtual

Creates a collation element iterator for the source.

The caller of this method is responsible for the memory management of the returned pointer.

Parameters

source the CharacterIterator which produces the characters over which the CollationElementItgerator will iterate.

Returns: the collation element iterator of the source using this as the based Collator.

Stable: ICU 2.2

References CollationElementIterator, and Collator::compare().

◆ createCollationElementIterator() [2/2]

virtual CollationElementIterator * RuleBasedCollator::createCollationElementIterator ( const UnicodeString & source ) const

virtual

Creates a collation element iterator for the source string.

The caller of this method is responsible for the memory management of the return pointer.

Parameters

source the string over which the CollationElementIterator will iterate.

Returns: the collation element iterator of the source string using this as the based Collator.

Stable: ICU 2.2

References CollationElementIterator.

◆ getAttribute()

virtual UColAttributeValue RuleBasedCollator::getAttribute	(	UColAttribute	attr,
		UErrorCode &	status ) const

virtual

Universal attribute getter.

Parameters

attr	attribute type
status	to indicate whether the operation went on smoothly or there were errors

Returns: attribute value

Stable: ICU 2.2

Implements Collator.

◆ getCollationKey() [1/2]

virtual CollationKey & RuleBasedCollator::getCollationKey	(	const UChar *	source,
		int32_t	sourceLength,
		CollationKey &	key,
		UErrorCode &	status ) const

virtual

Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare.

Use a CollationKey when you need to do repeated comparisions on the same string. For a single comparison the compare method will be faster.

Parameters

source	the source string.
sourceLength	the length of the source string.
key	the transformed key of the source string.
status	the error code status.

Returns: the transformed key.

See also: CollationKey

Stable: ICU 2.0

Implements Collator.

◆ getCollationKey() [2/2]

virtual CollationKey & RuleBasedCollator::getCollationKey	(	const UnicodeString &	source,
		CollationKey &	key,
		UErrorCode &	status ) const

virtual

Transforms a specified region of the string into a series of characters that can be compared with CollationKey.compare.

Use a CollationKey when you need to do repeated comparisions on the same string. For a single comparison the compare method will be faster.

Parameters

source	the source string.
key	the transformed key of the source string.
status	the error code status.

Returns: the transformed key.

See also: CollationKey

Stable: ICU 2.0

Implements Collator.

◆ getDynamicClassID()

virtual UClassID RuleBasedCollator::getDynamicClassID ( void ) const

virtual

Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. 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.

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.

Stable: ICU 2.0

Implements Collator.

◆ getEquivalentReorderCodes()

static int32_t RuleBasedCollator::getEquivalentReorderCodes	(	int32_t	reorderCode,
		int32_t *	dest,
		int32_t	destCapacity,
		UErrorCode &	status )

static

Retrieves the reorder codes that are grouped with the given reorder code.

Some reorder codes will be grouped and must reorder together.

Parameters

reorderCode	The reorder code to determine equivalence for.
dest	The array to fill with the script equivalene reordering codes.
destCapacity	The length of dest. If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting).
status	A reference to an error code value, which must not indicate a failure before the function call.

Returns: The length of the of the reordering code equivalence array.

See also: ucol_setReorderCodes; Collator::getReorderCodes; Collator::setReorderCodes

Stable: ICU 4.8

◆ getLocale()

virtual Locale RuleBasedCollator::getLocale	(	ULocDataLocaleType	type,
		UErrorCode &	status ) const

virtual

Gets the locale of the Collator.

Parameters

type	can be either requested, valid or actual locale. For more information see the definition of ULocDataLocaleType in uloc.h
status	the error code status.

Returns: locale where the collation data lives. If the collator was instantiated from rules, locale is empty.

Deprecated: ICU 2.8 likely to change in ICU 3.0, based on feedback

Implements Collator.

◆ getMaxExpansion()

int32_t RuleBasedCollator::getMaxExpansion ( int32_t order ) const

Return the maximum length of any expansion sequences that end with the specified comparison order.

Parameters

order a collation order returned by previous or next.

Returns: maximum size of the expansion sequences ending with the collation element or 1 if collation element does not occur at the end of any expansion sequence

See also: CollationElementIterator::getMaxExpansion

Stable: ICU 2.0

◆ getReorderCodes()

virtual int32_t RuleBasedCollator::getReorderCodes	(	int32_t *	dest,
		int32_t	destCapacity,
		UErrorCode &	status ) const

virtual

Retrieves the reordering codes for this collator.

Parameters

dest	The array to fill with the script ordering.
destCapacity	The length of dest. If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting).
status	A reference to an error code value, which must not indicate a failure before the function call.

Returns: The length of the script ordering array.

See also: ucol_setReorderCodes; Collator::getEquivalentReorderCodes; Collator::setReorderCodes

Stable: ICU 4.8

Reimplemented from Collator.

◆ getRules() [1/2]

void RuleBasedCollator::getRules	(	UColRuleOption	delta,
		UnicodeString &	buffer )

Returns current rules.

Delta defines whether full rules are returned or just the tailoring.

getRules(void) should normally be used instead. See http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales

Parameters

delta	one of UCOL_TAILORING_ONLY, UCOL_FULL_RULES.
buffer	UnicodeString to store the result rules

Stable: ICU 2.2

See also: UCOL_FULL_RULES

◆ getRules() [2/2]

const UnicodeString & RuleBasedCollator::getRules ( void ) const

Gets the tailoring rules for this collator.

Returns: the collation tailoring from which this collator was created

Stable: ICU 2.0

◆ getSortKey() [1/2]

virtual int32_t RuleBasedCollator::getSortKey	(	const UChar *	source,
		int32_t	sourceLength,
		uint8_t *	result,
		int32_t	resultLength ) const

virtual

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

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

Stable: ICU 2.2

Implements Collator.

◆ getSortKey() [2/2]

virtual int32_t RuleBasedCollator::getSortKey	(	const UnicodeString &	source,
		uint8_t *	result,
		int32_t	resultLength ) const

virtual

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

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

Stable: ICU 2.0

Implements Collator.

◆ getStaticClassID()

static UClassID RuleBasedCollator::getStaticClassID ( void )

static

Returns the class ID for this class.

This is useful only for comparing to a return value from getDynamicClassID(). For example:

Base* polymorphic_pointer = createPolymorphicObject();
if (polymorphic_pointer->getDynamicClassID() ==
                                         Derived::getStaticClassID()) ...

Returns: The class ID for all objects of this class.

Stable: ICU 2.0

◆ getTailoredSet()

virtual UnicodeSet * RuleBasedCollator::getTailoredSet ( UErrorCode & status ) const

virtual

Get an UnicodeSet that contains all the characters and sequences tailored in this collator.

Parameters

status error code of the operation

Returns: a pointer to a UnicodeSet object containing all the code points and sequences that may sort differently than in the UCA. The object must be disposed of by using delete

Stable: ICU 2.4

Reimplemented from Collator.

◆ getUCollator()

const UCollator * RuleBasedCollator::getUCollator ( )

inline

Get UCollator data struct.

Used only by StringSearch & intltest.

Returns: UCollator data struct

Internal: Do not use. This API is for internal use only.

Definition at line 839 of file tblcoll.h.

Referenced by StringSearch.

◆ getVariableTop()

virtual uint32_t RuleBasedCollator::getVariableTop ( UErrorCode & status ) const

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.

Stable: ICU 2.0

Implements Collator.

◆ getVersion()

virtual void RuleBasedCollator::getVersion ( UVersionInfo info ) const

virtual

Gets the version information for a Collator.

Parameters

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

Stable: ICU 2.0

Implements Collator.

◆ hashCode()

virtual int32_t RuleBasedCollator::hashCode ( void ) const

virtual

Generates the hash code for the rule-based collation object.

Returns: the hash code.

Stable: ICU 2.0

Implements Collator.

◆ internalGetShortDefinitionString()

virtual int32_t RuleBasedCollator::internalGetShortDefinitionString	(	const char *	locale,
		char *	buffer,
		int32_t	capacity,
		UErrorCode &	status ) const

virtual

Get the short definition string for a collator.

This internal API harvests the collator's locale and the attribute set and produces a string that can be used for opening a collator with the same properties using the ucol_openFromShortString API. This string will be normalized. The structure and the syntax of the string is defined in the "Naming collators" section of the users guide: http://icu-project.org/userguide/Collate_Concepts.html#Naming_Collators This function supports preflighting.

This is internal, and intended to be used with delegate converters.

Parameters

locale	a locale that will appear as a collators locale in the resulting short string definition. If NULL, the locale will be harvested from the collator.
buffer	space to hold the resulting string
capacity	capacity of the buffer
status	for returning errors. All the preflighting errors are featured

Returns: length of the resulting string

See also: ucol_openFromShortString; ucol_normalizeShortDefinitionString; ucol_getShortDefinitionString

Internal: Do not use. This API is for internal use only.

Reimplemented from Collator.

◆ operator=()

RuleBasedCollator & RuleBasedCollator::operator= ( const RuleBasedCollator & other )

Assignment operator.

Parameters

other other RuleBasedCollator object to compare with.

Stable: ICU 2.0

References RuleBasedCollator().

◆ operator==()

virtual UBool RuleBasedCollator::operator== ( const Collator & other ) const

virtual

Returns true if argument is the same as this object.

Parameters

other Collator object to be compared.

Returns: true if arguments is the same as this object.

Stable: ICU 2.0

Reimplemented from Collator.

References Collator.

◆ setAttribute()

virtual void RuleBasedCollator::setAttribute	(	UColAttribute	attr,
		UColAttributeValue	value,
		UErrorCode &	status )

virtual

Universal attribute setter.

Parameters

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

Stable: ICU 2.2

Implements Collator.

◆ setLocales()

virtual void RuleBasedCollator::setLocales	(	const Locale &	requestedLocale,
		const Locale &	validLocale,
		const Locale &	actualLocale )

protectedvirtual

Used internally by registraton to define the requested and valid locales.

Parameters

requestedLocale	the requsted locale
validLocale	the valid locale
actualLocale	the actual locale

Internal: Do not use. This API is for internal use only.

Reimplemented from Collator.

◆ setReorderCodes()

virtual void RuleBasedCollator::setReorderCodes	(	const int32_t *	reorderCodes,
		int32_t	reorderCodesLength,
		UErrorCode &	status )

virtual

Sets the ordering of scripts for this collator.

Parameters

reorderCodes	An array of script codes in the new order. This can be NULL if the length is also set to 0. An empty array will clear any reordering codes on the collator.
reorderCodesLength	The length of reorderCodes.
status	error code

See also: Collator::getReorderCodes; Collator::getEquivalentReorderCodes

Stable: ICU 4.8

Reimplemented from Collator.

◆ setVariableTop() [1/3]

virtual uint32_t RuleBasedCollator::setVariableTop	(	const UChar *	varTop,
		int32_t	len,
		UErrorCode &	status )

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

Stable: ICU 2.0

Implements Collator.

◆ setVariableTop() [2/3]

virtual uint32_t RuleBasedCollator::setVariableTop	(	const UnicodeString &	varTop,
		UErrorCode &	status )

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

Stable: ICU 2.0

Implements Collator.

◆ setVariableTop() [3/3]

virtual void RuleBasedCollator::setVariableTop	(	uint32_t	varTop,
		UErrorCode &	status )

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)

Stable: ICU 2.0

Implements Collator.

Friends And Related Symbol Documentation

◆ CollationElementIterator

friend class CollationElementIterator

friend

Used to iterate over collation elements in a character source.

Definition at line 690 of file tblcoll.h.

References CollationElementIterator.

Referenced by CollationElementIterator, createCollationElementIterator(), and createCollationElementIterator().

◆ Collator

friend class Collator

friend

Collator ONLY needs access to RuleBasedCollator(const Locale&, UErrorCode&)

Definition at line 696 of file tblcoll.h.

References Collator.

Referenced by clone(), Collator, and operator==().

◆ StringSearch

friend class StringSearch

friend

Searching over collation elements in a character source.

Definition at line 701 of file tblcoll.h.

References getUCollator(), RuleBasedCollator(), and StringSearch.

Referenced by StringSearch.

The documentation for this class was generated from the following file:

tblcoll.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RuleBasedCollator() [1/6]

◆ RuleBasedCollator() [2/6]

◆ RuleBasedCollator() [3/6]

◆ RuleBasedCollator() [4/6]

◆ RuleBasedCollator() [5/6]

◆ RuleBasedCollator() [6/6]

◆ ~RuleBasedCollator()

Member Function Documentation

◆ clone()

◆ cloneBinary()

◆ cloneRuleData()

◆ compare() [1/7]

◆ compare() [2/7]

◆ compare() [3/7]

◆ compare() [4/7]

◆ compare() [5/7]

◆ compare() [6/7]

◆ compare() [7/7]

◆ createCollationElementIterator() [1/2]

◆ createCollationElementIterator() [2/2]

◆ getAttribute()

◆ getCollationKey() [1/2]

◆ getCollationKey() [2/2]

◆ getDynamicClassID()

◆ getEquivalentReorderCodes()

◆ getLocale()

◆ getMaxExpansion()

◆ getReorderCodes()

◆ getRules() [1/2]

◆ getRules() [2/2]

◆ getSortKey() [1/2]

◆ getSortKey() [2/2]

◆ getStaticClassID()

◆ getTailoredSet()

◆ getUCollator()

◆ getVariableTop()

◆ getVersion()

◆ hashCode()

◆ internalGetShortDefinitionString()

◆ operator=()

◆ operator==()

◆ setAttribute()

◆ setLocales()

◆ setReorderCodes()

◆ setVariableTop() [1/3]

◆ setVariableTop() [2/3]

◆ setVariableTop() [3/3]

Friends And Related Symbol Documentation

◆ CollationElementIterator

◆ Collator

◆ StringSearch