Normalizer

class Normalizer : Cloneable

Old Unicode normalization API.

This API has been replaced by the Normalizer2 class and is only available for backward compatibility. This class simply delegates to the Normalizer2 class. There are two exceptions: The new API does not provide a replacement for QuickCheckResult and compare().

normalize transforms Unicode text into an equivalent composed or decomposed form, allowing for easier sorting and searching of text. normalize supports the standard normalization forms described in Unicode Standard Annex #15 — Unicode Normalization Forms.

Characters with accents or other adornments can be encoded in several different ways in Unicode. For example, take the character A-acute. In Unicode, this can be encoded as a single character (the "composed" form):

00C1    LATIN CAPITAL LETTER A WITH ACUTE
  

0041    LATIN CAPITAL LETTER A
       0301    COMBINING ACUTE ACCENT
  

To a user of your program, however, both of these sequences should be treated as the same "user-level" character "A with acute accent". When you are searching or comparing text, you must ensure that these two sequences are treated equivalently. In addition, you must handle characters with more than one accent. Sometimes the order of a character's combining accents is significant, while in other cases accent sequences in different orders are really equivalent.

Similarly, the string "ffi" can be encoded as three separate letters:

0066    LATIN SMALL LETTER F
       0066    LATIN SMALL LETTER F
       0069    LATIN SMALL LETTER I
  

FB03    LATIN SMALL LIGATURE FFI
  

The ffi ligature is not a distinct semantic character, and strictly speaking it shouldn't be in Unicode at all, but it was included for compatibility with existing character sets that already provided it. The Unicode standard identifies such characters by giving them "compatibility" decompositions into the corresponding semantic characters. When sorting and searching, you will often want to use these mappings.

normalize helps solve these problems by transforming text into the canonical composed and decomposed forms as shown in the first example above. In addition, you can have it perform compatibility decompositions so that you can treat compatibility characters the same as their equivalents. Finally, normalize rearranges accents into the proper canonical order, so that you do not have to worry about accent rearrangement on your own.

Form FCD, "Fast C or D", is also designed for collation. It allows to work on strings that are not necessarily normalized with an algorithm (like in collation) that works under "canonical closure", i.e., it treats precomposed characters and their decomposed equivalents the same.

It is not a normalization form because it does not provide for uniqueness of representation. Multiple strings may be canonically equivalent (their NFDs are identical) and may all conform to FCD without being identical themselves.

The form is defined such that the "raw decomposition", the recursive canonical decomposition of each character, results in a string that is canonically ordered. This means that precomposed characters are allowed for as long as their decompositions do not need canonical reordering.

Its advantage for a process like collation is that all NFD and most NFC texts - and many unnormalized texts - already conform to FCD and do not need to be normalized (NFD) for such a process. The FCD quick check will return YES for most strings in practice.

normalize(FCD) may be implemented with NFD.

For more details on FCD see Unicode Technical Note #5 (Canonical Equivalence in Applications): http://www.unicode.org/notes/tn5/#FCD

ICU collation performs either NFD or FCD normalization automatically if normalization is turned on for the collator object. Beyond collation and string search, normalized strings may be useful for string equivalence comparisons, transliteration/transcription, unique representations, etc.

The W3C generally recommends to exchange texts in NFC. Note also that most legacy character encodings use only precomposed forms and often do not encode any combining marks by themselves. For conversion to such character encodings the Unicode text needs to be normalized to NFC. For more usage examples, see the Unicode Standard Annex.

Note: The Normalizer class also provides API for iterative normalization. While the setIndex() and getIndex() refer to indices in the underlying Unicode input text, the next() and previous() methods iterate through characters in the normalized output. This means that there is not necessarily a one-to-one correspondence between characters returned by next() and previous() and the indices passed to and returned from setIndex() and getIndex(). It is for this reason that Normalizer does not implement the CharacterIterator interface.

Summary

Constants

static val COMPARE_CODE_POINT_ORDER: Int

Value: 32768

static val COMPARE_IGNORE_CASE: Int

Value: 65536

static val FOLD_CASE_DEFAULT: Int

Value: 0

static val FOLD_CASE_EXCLUDE_SPECIAL_I: Int

Value: 1

static val INPUT_IS_FCD: Int

Value: 131072

Public methods

static fun compare(
    s1: CharArray!, 
    s2: CharArray!, 
    options: Int
): Int

static fun compare(
    s1: CharArray!, 
    s1Start: Int, 
    s1Limit: Int, 
    s2: CharArray!, 
    s2Start: Int, 
    s2Limit: Int, 
    options: Int
): Int

static fun compare(
    char32a: Int, 
    char32b: Int, 
    options: Int
): Int

static fun compare(
    char32a: Int, 
    str2: String!, 
    options: Int
): Int

static fun compare(
    s1: String!, 
    s2: String!, 
    options: Int
): Int

Properties

static val MAYBE: Normalizer.QuickCheckResult!

static val NO: Normalizer.QuickCheckResult!

static val YES: Normalizer.QuickCheckResult!