Movatterモバイル変換

Base letter represents a primary difference.

Set comparison level to PRIMARY to ignore secondary and tertiary differences.
Use this to set the strength of aCollator 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 aCollator object.
Example of secondary difference, "&auml;" >> "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 aCollator object.
Example of tertiary difference, "abc" <<< "ABC".

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

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

Stable:

ICU 2.0

Definition at line203 of filecoll.h.

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

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

See also

Collator::compare

Deprecated:

ICU 2.6. Use C enum UCollationResult defined inucol.h

Definition at line226 of filecoll.h.

Destructor.

Stable:

ICU 2.0

Default constructor.

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

Stable:

ICU 2.0

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

Deprecated:

ICU 2.4. Subclasses should use the default constructor instead and handle the strength and normalization mode themselves.

Copy constructor.

Parameters

other

Collator object to be copied from

Stable:

ICU 2.0

Makes a copy of this object.

Returns

a copy of this object, owned by the caller

Stable:

ICU 2.0

Implemented inicu::RuleBasedCollator.

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:

.       char16_t ABC[] = {0x41, 0x42, 0x43, 0};  // = "ABC".       char16_t abc[] = {0x61, 0x62, 0x63, 0};  // = "abc".       UErrorCode status = U_ZERO_ERROR;.Collator *myCollation =.                         Collator::createInstance(Locale::getUS(), 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 &

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

Implemented inicu::RuleBasedCollator.

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 &

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 &

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

Implemented inicu::RuleBasedCollator.

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

Implemented inicu::RuleBasedCollator.

Compares two strings using theCollator.

Returns whether the first one compares less than/equal to/greater than the second one. This version takesUCharIterator 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 inicu::RuleBasedCollator.

Compares two UTF-8 strings using theCollator.

Returns whether the first one compares less than/equal to/greater than the second one. This version takes UTF-8 input. Note that aStringPiece can be implicitly constructed from a std::string or a NUL-terminated const char * string.

Parameters

source	the first UTF-8 string
target	the second UTF-8 string
status	ICU status

Returns

UCOL_LESS, UCOL_EQUAL or UCOL_GREATER

Stable:

ICU 4.2

Reimplemented inicu::RuleBasedCollator.

Gets the collation object for the desired locale.

The resource of the desired locale will be loaded.

Locale::getRoot() is the base collation table and all other languages are built on top of it with additional language-specific modifications.

For some languages, multiple collation types are available; for example, "de@collation=phonebook". Starting with ICU 54, collation attributes can be specified via locale keywords as well, in the old locale extension syntax ("el@colCaseFirst=upper") or in language tag syntax ("el-u-kf-upper"). SeeUser Guide: Collation API.

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 ofU_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

loc	The locale ID for which to open a collator.
err	the error code status.

Returns

the created table-based collation object based on the desired locale.

See also

Locale

ResourceLoader

Stable:

ICU 2.2

Creates theCollator object for the current default locale.

The default locale is determined byLocale::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 ofU_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

err	the error code status.

Returns

the collation object of the default locale.(for example, en_US)

See also

Locale::getDefault

Stable:

ICU 2.0

Creates a comparison function object that uses this collator.

Likestd::equal_to but uses the collator instead ofoperator==.

Stable:

ICU 76

Definition at line602 of filecoll.h.

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

Stable:

ICU 2.0

Internal:

Do not use.

This API is for internal use only.

Definition at line1236 of filecoll.h.

Internal:

Do not use.

This API is for internal use only.

Definition at line1232 of filecoll.h.

Referenced byicu::RuleBasedCollator::rbcFromUCollator().

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

Implemented inicu::RuleBasedCollator.

Return aStringEnumeration over the locales available at the time of the call, including registered locales.

If a severe error occurs (such as out of memory condition) this will return null. If there is no locale data, an empty enumeration will be returned.

Returns

aStringEnumeration over the locales available at the time of the call

Stable:

ICU 2.6

Get the set of Locales for which Collations are installed.

Note this does not include locales supported by registered collators. If collators might have been registered, use the overload of getAvailableLocales that returns aStringEnumeration.

Parameters

count

the output parameter of number of elements in the locale list

Returns

the list of available locales for which collations are installed

Stable:

ICU 2.0

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

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

Stable:

ICU 2.1

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

It is not possible to restore the original string from the chars in the sort key.

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.

Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.

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

Returns

the collation key of the string based on the collation rules.

See also

CollationKey::compare

Stable:

ICU 2.0

Implemented inicu::RuleBasedCollator.

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

It is not possible to restore the original string from the chars in the sort key.

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.

Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.

Parameters

source	the source string to be transformed into a sort key.
key	the collation key to be filled in
status	the error code status.

Returns

the collation key of the string based on the collation rules.

See also

CollationKey::compare

Stable:

ICU 2.0

Implemented inicu::RuleBasedCollator.

Get name of the object for the desiredLocale, in the desired language.

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

Stable:

ICU 2.0

Get name of the object for the desiredLocale, in the language 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

Stable:

ICU 2.0

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. Polymorphicoperator==() andclone() 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

Reimplemented fromicu::UObject.

Implemented inicu::RuleBasedCollator.

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

Some reorder codes will be grouped and must reorder together. Beginning with ICU 55, scripts only reorder together if they are primary-equal, for example Hiragana and Katakana.

Parameters

reorderCode	The reorder code to determine equivalence for.
dest	The array to fill with the script equivalence reordering codes.
destCapacity	The length of dest. If it is 0, then dest may be nullptr and the function will only return the length of the result without writing any codes (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

UScriptCode

UColReorderCode

Stable:

ICU 4.8

Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service.

If two locales return the same result, then collators instantiated for these locales will behave equivalently. The converse is not always true; two collators may in fact be equivalent, but return different results, due to internal details. The return result has no other meaning than that stated above, and implies nothing as to the relationship between the two locales. This is intended for use by applications who wish to cache collators, or otherwise reuse collators when possible. The functional equivalent may change over time. For more information, please see theLocales and Services section of the ICU User Guide.

Parameters

keyword	a particular keyword as enumerated by ucol_getKeywords.
locale	the requested locale
isAvailable	reference to a fillin parameter that indicates whether the requested locale was 'available' to the collation service. A locale is defined as 'available' if it physically exists within the collation locale data.
status	reference to input-output error code

Returns

the functionally equivalent collation locale, or the root locale upon error.

Stable:

ICU 3.0

Create a string enumerator of all possible keywords that are relevant to collation.

At this point, the only recognized keyword for this service is "collation".

Parameters

status

input-output error code

Returns

a string enumeration over locale strings. The caller is responsible for closing the result.

Stable:

ICU 3.0

Given a keyword, create a string enumeration of all values for that keyword that are currently in use.

Parameters

keyword	a particular keyword as enumerated by ucol_getKeywords. If any other keyword is passed in, status is set to U_ILLEGAL_ARGUMENT_ERROR.
status	input-output error code

Returns

a string enumeration over collation keyword values, or nullptr upon error. The caller is responsible for deleting the result.

Stable:

ICU 3.0

Given a key and a locale, returns an array of string values in a preferred order that would make a difference.

These are all and only those values where the open (creation) of the service with the locale formed from the input locale plus input keyword and that value has different behavior than creation with the input locale alone.

Parameters

keyword	one of the keys supported by this service. For now, only "collation" is supported.
locale	the locale
commonlyUsed	if set to true it will return only commonly used values with the given locale in preferred order. Otherwise, it will return all the available values for the locale.
status	ICU status

Returns

a string enumeration over keyword values for the given key and the locale.

Stable:

ICU 4.2

Gets the locale of theCollator.

Parameters

type	can be either requested, valid or actual locale. For more information see the definition of ULocDataLocaleType inuloc.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 This API is under consideration for revision in ICU 3.0.

Implemented inicu::RuleBasedCollator.

Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING.

The base class implementation returns UCOL_REORDER_CODE_PUNCTUATION.

Returns

the maximum variable reordering group.

See also

setMaxVariable

Stable:

ICU 53

Reimplemented inicu::RuleBasedCollator.

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 nullptr and the function will only return the length of the result without writing any codes (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

UScriptCode

UColReorderCode

Stable:

ICU 4.8

Reimplemented inicu::RuleBasedCollator.

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

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

Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.

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 nullptr, 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

Implemented inicu::RuleBasedCollator.

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

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

Note that sort keys are often less efficient than simply doing comparison. For more details, see the ICU User Guide.

Parameters

source	string to be processed.
result	buffer to store result in. If nullptr, 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

Implemented inicu::RuleBasedCollator.

Determines the minimum strength that will be used 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

Deprecated:

ICU 2.6 Use getAttribute(UCOL_STRENGTH...) instead

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

Parameters

status

error code of the operation

Returns

a pointer to aUnicodeSet object containing all the code points and sequences that may sort differently than in the root collator. The object must be disposed of by using delete

Stable:

ICU 2.4

Reimplemented inicu::RuleBasedCollator.

Gets the variable top value of aCollator.

Parameters

status

error code (not changed by function). If error code is set, the return value is undefined.

Returns

the variable top primary weight

See also

getMaxVariable

Stable:

ICU 2.0

Implemented inicu::RuleBasedCollator.

Gets the version information for aCollator.

Parameters

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

Stable:

ICU 2.0

Implemented inicu::RuleBasedCollator.

Creates a comparison function object that uses this collator.

Likestd::greater but uses the collator instead ofoperator>.

Stable:

ICU 76

Definition at line609 of filecoll.h.

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

Stable:

ICU 2.0

Creates a comparison function object that uses this collator.

Likestd::greater_equal but uses the collator instead ofoperator>=.

Stable:

ICU 76

Definition at line630 of filecoll.h.

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

Stable:

ICU 2.0

Generates the hash code for the collation object.

Stable:

ICU 2.0

Implemented inicu::RuleBasedCollator.

Implementsucol_strcollUTF8().

Internal:

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

Reimplemented inicu::RuleBasedCollator.

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 attributes 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:https://unicode-org.github.io/icu/userguide/collation/concepts#collator-naming-scheme 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 nullptr, 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 inicu::RuleBasedCollator.

Implementsucol_nextSortKeyPart().

Internal:

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

Reimplemented inicu::RuleBasedCollator.

Creates a comparison function object that uses this collator.

Likestd::less but uses the collator instead ofoperator<.

Stable:

ICU 76

Definition at line616 of filecoll.h.

Creates a comparison function object that uses this collator.

Likestd::less_equal but uses the collator instead ofoperator<=.

Stable:

ICU 76

Definition at line637 of filecoll.h.

Creates a comparison function object that uses this collator.

Likestd::not_equal_to but uses the collator instead ofoperator!=.

Stable:

ICU 76

Definition at line623 of filecoll.h.

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

Calls !operator==(const Collator&) constwhich works for all subclasses.

Parameters

other

Collator object to be compared

Returns

true if other is not the same as this.

Stable:

ICU 2.0

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

The base class implementation returns true if "other" has the same type/class as "this":typeid(*this) == typeid(other).

Subclass implementations should do something like the following:

if (this == &other) { return true; }if (!Collator::operator==(other)) { return false; }  // not the same classconst MyCollator &o = (const MyCollator&)other;(compare this vs. o's subclass fields)

Parameters

other

Collator object to be compared

Returns

true if other is the same as this.

Stable:

ICU 2.0

Reimplemented inicu::RuleBasedCollator.

Register a newCollatorFactory.

The factory will be adopted. Because ICU may choose to cache collators internally, this must be called at application startup, prior to any calls toCollator::createInstance to avoid undefined behavior.

Parameters

toAdopt	theCollatorFactory instance to be adopted
status	the in/out status code, no special meanings are assigned

Returns

a registry key that can be used to unregister this collator

Stable:

ICU 2.6

Register a newCollator.

The collator will be adopted. Because ICU may choose to cache collators internally, this must be called at application startup, prior to any calls toCollator::createInstance to avoid undefined behavior.

Parameters

toAdopt	theCollator instance to be adopted
locale	the locale with which the collator will be associated
status	the in/out status code, no special meanings are assigned

Returns

a registry key that can be used to unregister this collator

Stable:

ICU 2.6

Same asclone().

The base class implementation simply callsclone().

Returns

a copy of this object, owned by the caller

See also

clone()

Deprecated:

ICU 50 no need to have two methods for cloning

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

Implemented inicu::RuleBasedCollator.

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

Parameters

requestedLocale	the requested locale
validLocale	the valid locale
actualLocale	the actual locale

Internal:

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

Reimplemented inicu::RuleBasedCollator.

Sets the variable top to the top of the specified reordering group.

The variable top determines the highest-sorting character which is affected by UCOL_ALTERNATE_HANDLING. If that attribute is set to UCOL_NON_IGNORABLE, then the variable top has no effect.

The base class implementation sets U_UNSUPPORTED_ERROR.

Parameters

group	one of UCOL_REORDER_CODE_SPACE, UCOL_REORDER_CODE_PUNCTUATION, UCOL_REORDER_CODE_SYMBOL, UCOL_REORDER_CODE_CURRENCY; or UCOL_REORDER_CODE_DEFAULT to restore the default max variable group
errorCode	Standard ICU error code. Its input value must pass theU_SUCCESS() test, or else the function returns immediately. Check forU_FAILURE() on output or use with function chaining. (See User Guide for details.)

Returns

*this

See also

getMaxVariable

Stable:

ICU 53

Reimplemented inicu::RuleBasedCollator.

Sets the ordering of scripts for this collator.

The reordering codes are a combination of script codes and reorder codes.

Parameters

reorderCodes	An array of script codes in the new order. This can be nullptr 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

ucol_setReorderCodes

Collator::getReorderCodes

Collator::getEquivalentReorderCodes

UScriptCode

UColReorderCode

Stable:

ICU 4.8

Reimplemented inicu::RuleBasedCollator.

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

Example of use:

UErrorCode status =U_ZERO_ERROR;
Collator*myCollation =Collator::createInstance(Locale::getUS(), 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");
U_FAILURE
#define U_FAILURE(x)
Does the error code indicate a failure?
Definition:utypes.h:827

See also

Collator::getStrength

Parameters

newStrength

the new comparison level.

Deprecated:

ICU 2.6 Use setAttribute(UCOL_STRENGTH...) instead

Sets the variable top to the primary weight of the specified string.

Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. SeesetMaxVariable().

Parameters

varTop	one or more (if contraction) char16_ts 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 contraction U_ILLEGAL_ARGUMENT_ERROR if the variable top is beyond the last reordering group supported bysetMaxVariable()

Returns

variable top primary weight

Deprecated:

ICU 53 CallsetMaxVariable() instead.

Implemented inicu::RuleBasedCollator.

Sets the variable top to the primary weight of the specified string.

Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. SeesetMaxVariable().

Parameters

varTop	aUnicodeString size 1 or more (if contraction) of char16_ts 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 contraction U_ILLEGAL_ARGUMENT_ERROR if the variable top is beyond the last reordering group supported bysetMaxVariable()

Returns

variable top primary weight

Deprecated:

ICU 53 CallsetMaxVariable() instead.

Implemented inicu::RuleBasedCollator.

Sets the variable top to the specified primary weight.

Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. SeesetMaxVariable().

Parameters

varTop	primary weight, as returned by setVariableTop or ucol_getVariableTop
status	error code

Deprecated:

ICU 53 CallsetMaxVariable() instead.

Implemented inicu::RuleBasedCollator.

Internal:

Do not use.

This API is for internal use only.

Definition at line1240 of filecoll.h.

Internal:

Do not use.

This API is for internal use only.

Definition at line1244 of filecoll.h.

Unregister a previously-registeredCollator orCollatorFactory using the key returned from the register call.

Key becomes invalid after a successful call and should not be used again. The object corresponding to the key will be deleted. Because ICU may choose to cache collators internally, this should be called during application shutdown, after all calls toCollator::createInstance to avoid undefined behavior.

Parameters

key	the registry key returned by a previous call to registerInstance
status	the in/out status code, no special meanings are assigned

Returns

true if the collator for the key was successfully unregistered

Stable:

ICU 2.6