Collator  - AS3

Nazwa bieżącego identyfikatora ustawień regionalnych używanych przez dany obiekt klasy Collator.

Istnieją trzy możliwości dla wartości nazwy — w zależności od systemu operacyjnego i wartości parametru requestedLocaleIDName przekazywanego do konstruktora Collator().

1. Jeśli zażądano innych ustawień narodowych niż LocaleID.DEFAULT, a system operacyjny zapewnia obsługę dla żądanych ustawień, wówczas zwrócona nazwa będzie taka sama, jak właściwość requestedLocaleIDName.
2. Jeśli wartością parametru requestedLocaleIDName przekazanego do konstruktora było LocaleID.DEFAULT, wówczas używana będzie nazwa bieżących ustawień narodowych określonych przez system operacyjny użytkownika. Wartość LocaleID.DEFAULT powoduje zachowanie niestandardowych ustawień użytkownika w systemie operacyjnym. Przekazanie wartości jawnej jako parametru requestedLocaleIDName nie spowoduje uzyskania takiego samego rezultatu, jak użycie LocaleID.DEFAULT, nawet jeśli obydwa identyfikatory ustawień narodowych są takie same. Możliwe, że użytkownik dostosował ustawienia narodowe na własnym komputerze, a żądanie jawnego identyfikatora ustawień narodowych — zamiast LocaleID.DEFAULT — sprawi, że aplikacja nie odczyta tych niestandardowych ustawień.
3. Jeśli system nie obsługuje parametru requestedLocaleIDName określonego w konstruktorze, wówczas zostanie udostępniony identyfikator alternatywnych ustawień narodowych.

Powiązane elementy interfejsu API

Jeśli dla tej właściwości ustawiono wartość true, wówczas identyczne ciągi znaków i ciągi znaków, które różnią się tylko wielkościami znaków, będą traktowane jako równe. Na przykład: compare("ABC", "abc") zwróci true, jeśli właściwość ignoreCase zostanie ustawiona na true.

Przekształcanie wielkości znaków w ciągach znaków będzie zgodne z regułami dla określonych ustawień narodowych.

Jeśli właściwość ignoreCase ma wartość false, wówczas wielkie i małe znaki nie będą równe.

Jeśli do tej właściwości zostanie przypisana wartość i nie wystąpiły żadne błędy ani ostrzeżenia, wówczas właściwość lastOperationStatus zostaje ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Wartość domyślna wynosi true, gdy w konstruktorze Collator() parametr initialMode jest ustawiony na wartość Collator.MATCHING. Wartość domyślna wynosi false, gdy w konstruktorze Collator() parametr initialMode jest ustawiony na wartość Collator.SORTING.

Powiązane elementy interfejsu API

Jeśli ta właściwość ma wartość true, wówczas formy niektórych znaków chińskich i japońskich o pełnej i połówkowej szerokości będą traktowane jako równe.

W celu zapewnienia zgodności z istniejącymi standardami dla zestawów znaków języków chińskiego i japońskiego Unicode udostępnia kody znaków dla form o pełnej i połówkowej szerokości niektórych znaków. Na przykład: gdy właściwość ignoreCharacterWidth jest ustawiona na true, wówczas compare("Ａｱ", "Aア") zwróci true.

Jeśli właściwość ignoreCharacterWidth jest ustawiona na false, wówczas formy o pełnej i połówkowej szerokości nie będą traktowane jako równe.

Jeśli do tej właściwości zostanie przypisana wartość i nie wystąpiły żadne błędy ani ostrzeżenia, wówczas właściwość lastOperationStatus zostaje ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Wartością domyślną jest false.

Powiązane elementy interfejsu API

Jeśli dla tej właściwości ustawiono wartość true, ciągi znaków, które wykorzystują te same znaki podstawowe, ale różne akcenty lub inne znaki diakrytyczne, będą traktowane jako równe. Na przykład: compare("coté", "côte") zwróci true, jeśli właściwość ignoreDiacritics jest ustawiona na true.

Jeśli właściwość ignoreDiacritics jest ustawiona na false, wówczas znaki podstawowe ze znakami diakrytycznymi lub akcentami nie będą traktowane jako równe.

Jeśli do tej właściwości zostanie przypisana wartość i nie wystąpiły żadne błędy ani ostrzeżenia, wówczas właściwość lastOperationStatus zostaje ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Wartością domyślną jest false.

Powiązane elementy interfejsu API

Jeśli dla tej właściwości ustawiona jest wartość true, wówczas ciągi znaków, które różnią się tylko typem używanego znaku kana, będą traktowane jako równe. Na przykład wywołanie compare("カナ", "かな") zwróci true, gdy właściwość ignoreKanaType jest ustawiona na true.

Jeśli właściwość ignoreKanaType jest ustawiona na false, wówczas znaki hiragana i katakana, które odwołują się do tej samej sylaby nie będą sobie równe.

Jeśli do tej właściwości zostanie przypisana wartość i nie wystąpiły żadne błędy ani ostrzeżenia, wówczas właściwość lastOperationStatus zostaje ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Wartością domyślną jest false.

Powiązane elementy interfejsu API

Jeśli dla tej właściwości ustawiona jest wartość true, wówczas podczas sortowania lub dopasowywania niektóre znaki, takie jak spacje, symbole walut, symbole matematyczne i inne typy symboli, będą ignorowane. Na przykład: ciągi znaków „OBrian”, „O'Brian” i „O Brian” będą traktowane jako równe, jeśli dla właściwości ignoreSymbols ustawiona jest wartość true.

Jeśli właściwość ignoreSymbols ma wartość false, wówczas znaki symboli będą uwzględniane podczas porównywania ciągów znaków.

Jeśli do tej właściwości zostanie przypisana wartość i nie wystąpiły żadne błędy ani ostrzeżenia, wówczas właściwość lastOperationStatus zostaje ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Wartością domyślną jest false.

Powiązane elementy interfejsu API

Status ostatniej operacji wykonanej przez ten obiekt Collator. Status lastOperationStatus zostanie ustawiony przy każdej okazji wywołania konstruktora lub metody klasy lub w przypadku ustawienia właściwości. Możliwe wartości przedstawiają opisy poszczególnych metod.

Powiązane elementy interfejsu API

Kontroluje, w jaki sposób podczas porównywania ciągów znaków będą traktowane wartości liczbowe osadzone w ciągach znaków.

Jeśli właściwość numericComparison jest ustawiona na true, metoda compare będzie przekształcać liczby, które pojawiają się w ciągach znaków na wartości liczbowe w celu porównania.

Jeśli ta właściwość jest ustawiona na false, wówczas podczas porównywania liczby będą traktowane jako kody znaków i będą sortowane zgodnie z regułami sortowania znaków, jakie obowiązują w określonych ustawieniach narodowych.

Na przykład: jeśli dla tej właściwości ustawiona jest wartość true dla ustawień narodowych „en-US”, wówczas ciągi znaków „version1”, „version10” i „version2” będą sortowane w następującej kolejności: version1 < version2 < version10.

Jeśli właściwość ma wartość false dla ustawień narodowych „en-US”, wówczas te ciągi znaków będą sortowane w następującej kolejności: version1 < version10 < version2.

Jeśli do tej właściwości zostanie przypisana wartość i nie wystąpiły żadne błędy ani ostrzeżenia, wówczas właściwość lastOperationStatus zostaje ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Wartością domyślną jest false.

Powiązane elementy interfejsu API

Nazwa identyfikatora żądanych ustawień regionalnych, która została przekazana do konstruktora obiektu klasy Collator.

Jeśli użyto wartości LocaleID.DEFAULT, wówczas zwrócona zostanie nazwa „i-default”. W przypadku zastosowania awaryjnych ustawień narodowych rzeczywiste ustawienia mogą się różnić od żądanych ustawień narodowych. Nazwę rzeczywistych ustawień narodowych można uzyskać za pomocą właściwości actualLocaleIDName.

Powiązane elementy interfejsu API

Tworzy nowy obiekt klasy Collator w celu zapewnienia porównywania ciągów znaków zgodnie z konwencjami określonych ustawień narodowych.

Jeśli bieżący system operacyjny nie obsługuje identyfikatora ustawień narodowych, który został przekazany w parametrze requestedLocaleIDName, wówczas zostaną określone alternatywne ustawienia narodowe. Jeśli używane są ustawienia alternatywne, wówczas właściwość lastOperationStatus zostanie ustawiona w taki sposób, aby wskazywała typ ustawień alternatywnych.

Parametr initialMode ustawia różne opcje porządkowania do zastosowań ogólnych. Może przyjąć jedną z następujących wartości:

• CollatorMode.SORTING: ustawia opcje porządkowania dla ogólnych zastosowań sortowania lingwistycznego, takich jak sortowanie listy ciągów znaków, które zostaną wyświetlone dla użytkownika końcowego. Jeśli w tym trybie wykonywane będzie porównywanie ciągów znaków, wówczas będą uwzględniane różnice w postaci małych i wielkich liter, znaki akcentowane oraz inne różnice właściwe dla konkretnych ustawień narodowych.
• CollatorMode.MATCHING: ustawia opcje porządkowania dla ogólnych zastosowań, takich jak określenie, czy dwa ciągi znaków są równoważne. W tym trybie różnice między małymi i wielkimi literami, znakami akcentowanymi itp. będą ignorowane w czasie porównywania ciągów znaków.

Poniżej przedstawiono przykład sortowanej listy utworzonej za pomocą obiektu klasy Collator z ustawieniami narodowymi „en-US” (angielski w USA) oraz z wykorzystaniem opcji CollatorMode.SORTING:

Wszystkie znaki są traktowane w taki sposób, jakby miały inne wartości, ale w kolejności lingwistycznej.

Poniżej przedstawiono przykład sortowanej listy utworzonej za pomocą obiektu klasy Collator z ustawieniami narodowymi „en-US” (angielski w USA) oraz z wykorzystaniem opcji CollatorMode.MATCHING:

Powyżej przedstawiono, że niektóre znaki są w kolejności lingwistycznej i są traktowane w taki sposób, jakby miały tę samą wartość znaku.

W celu zapewnienia dokładniejszej kontroli kolejności sortowania można zmienić właściwości obiektu klasy Collator, takie jak Collator.ignoreCase i Collator.ignoreDiacritics.

W celu porównania przedstawiono przykładowe sortowanie z wykorzystaniem standardowego sortowania Array.sort(), w którym ustawienia narodowe nie są uwzględniane:

Wszystkie znaki są sortowane zgodnie z wartością liczbową kodu Unicode. Takie sortowanie nie ma znaczenia lingwistycznego.

W celu wykorzystania preferencji użytkownika dotyczące bieżącego systemu operacyjnego należy przekazać do konstruktora wartość LocaleID.DEFAULT w parametrze requestedLocaleIDName.

W niektórych ustawieniach narodowych istnieje kilka wariantów kolejności sortowania. Na przykład w języku niemieckim kolejność sortowania używana w przypadku książek telefonicznych jest inna od kolejności wykorzystywanej w słownikach. W języku chińskim słowom zwykle towarzyszy transliteracja znaków na pinyin. Różne kolejności sortowania można wybierać poprzez dołączanie słowa kluczowego „collation” do ciągu znaków przekazywanego w parametrze requestedLocaleIDName do konstruktora.

         var germanPhonebook:LocaleID = new LocaleID("de-DE@collation=phonebook");
         var chinesePinyin:LocaleID = new LocaleID("zh-Hant@collation=pinyin");
         

Poniżej przedstawiono możliwe wartości ciągu znaków kolejności sortowania. Języki, na które ma wpływ dana wartość, podano w nawiasach:

Jeśli platforma nie obsługuje żądanego typu porządkowania, wówczas będzie używane porządkowanie alternatywne, a właściwość lastOperationStatus zostanie ustawiona w taki sposób, aby wskazywała wybraną opcję alternatywną. Właściwości actualLocaleIDName można użyć do określenia wartości, która została użyta jako rezerwowa, w sposób przedstawiony w poniższym przykładzie:

         var collator:Collator = new Collator("fr-FR");
         if (collator.lastOperationStatus == LastOperationStatus.USING_FALLBACK_WARNING)
         {
           trace ("Using fallback locale: " + collator.actualLocaleIDName);
         }
         

Jeśli działanie konstruktora zostanie pomyślnie zakończone, wówczas właściwość lastOperationStatus jest ustawiana na:

• LastOperationStatus.NO_ERROR

Jeśli ustawienia narodowe o żądanym identyfikatorze nie są dostępne, wówczas właściwość lastOperationStatus zostanie ustawiona na jedną z poniższych wartości:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Szczegółowe informacje na temat ostrzeżeń przedstawionych powyżej oraz na temat innych możliwych wartości właściwości lastOperationStatus zawierają opisy w klasie LastOperationStatus.

Powiązane elementy interfejsu API

Porównuje dwa ciągi znaków i zwraca wartość całkowitą, która wskazuje, czy pierwszy ciąg znaków jest krótszy, równy, czy dłuższy od drugiego ciągu znaków. W porównaniu wykorzystywane są reguły kolejności sortowania dla ustawień narodowych, których identyfikator określono w konstruktorze Collator().

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Porównuje dwa ciągi znaków i zwraca wartość logiczną, która określa, czy ciągi są równe. W porównaniu wykorzystywane są reguły kolejności sortowania dla ustawień narodowych, których identyfikator określono w konstruktorze Collator().

Jeśli działanie wywołanej metody zakończy się pomyślnie, wówczas właściwość lastOperationStatus zostanie ustawiona na:

• LastOperationStatus.NO_ERROR

W przeciwnym wypadku właściwość lastOperationStatus zostanie ustawiona na jedną ze stałych zdefiniowanych w klasie LastOperationStatus.

Parametry

Powiązane elementy interfejsu API

Wyświetla listę identyfikatorów ustawień narodowych obsługiwanych przez tę klasę.

Jeśli ta klasa nie jest obsługiwana w bieżącym systemie operacyjnym, wówczas ta metoda zwróci wartość null.

1. Iteracyjnie przegląda tablicę nazw identyfikacyjnych ustawień narodowych, w tym identyfikator domyślnych ustawień narodowych systemu operacyjnego (określony jako LocaleID.DEFAULT).
2. Dla każdej nazwy identyfikacyjnej ustawień narodowych tworzy obiekt Collator w trybie „sortowania” (domyślnym).
3. Wyświetla nazwy identyfikacyjne żądanych i rzeczywistych ustawień narodowych oraz wartość właściwości lastOperationStatus, dzięki czemu można sprawdzić, czy użyte zostały alternatywne ustawienia narodowe.
4. Sortuje tablicę danych przy użyciu każdego obiektu Collator i wyświetla wyniki. Uzyskana kolejność jest inna dla każdych ustawień narodowych.

package {
    import flash.globalization.Collator;
    import flash.globalization.LocaleID;

    public class CollatorExample1
    {
        public var col:Collator;
        
        public function CollatorExample1():void
        {        
            var localeNames:Array = [LocaleID.DEFAULT,
                                     "de-DE", "sv-SE",
                                     "fr-FR", "lt-LT",
                                     "es-ES"];
            
            var testSortData:Array = [
                "y ", "i ", "k ", // Latvian
                "acxa ", "acha ", "adxa ", // es_traditional
                "n ", "ö ", "o ", "z ", "vu ", "wo ", // sw
                "däd ", "daed ", // de
                "öf ", "of ", // de_dictionary
                "côte ", "coté " // fr
            ];
            
            for each (var localeName:String in localeNames) {
            
                col = new Collator(localeName);
                
                trace("LocaleID requested: " + col.requestedLocaleIDName 
                       + "; actual: " + col.actualLocaleIDName);
                       
                trace("Last Operation Status: " + col.lastOperationStatus );
                
                var result:Array = testSortData.sort(col.compare);
                        
                trace ("sorted data: " + result); 
            }
        }      
    }
}

1. Tworzy obiekt Collator dla domyślnych ustawień narodowych użytkownika w trybie „zgodności”.
2. Naprzemiennie przypisuje właściwości Collator.ignoreDiacritics wartości false i true.
3. Porównuje zestawy ciągów zawierających znaki diakrytyczne oraz wielkie i małe litery.
4. Prezentuje zmiany wyników porównania po zmianie wartości właściwości Collator.ignoreDiacritics i Collator.ignoreCase.

package {
    import flash.display.Sprite;
    import flash.globalization.Collator;
    import flash.globalization.CollatorMode;
    import flash.globalization.LocaleID;
    
    public class CollatorExample2 extends Sprite
    {
        public var col:Collator;
        public var testMatchData:Array = ["cote", "Cote", "côte", "coté"];
        public var wordToMatch:String = "Cote";
        
        public function CollatorExample2()
        {
            col = new Collator( LocaleID.DEFAULT, CollatorMode.MATCHING );

            trace("LocaleID requested: " + col.requestedLocaleIDName 
                    + "; actual: " + col.actualLocaleIDName);
                    
            trace("Last Operation Status: " + col.lastOperationStatus );

            trace('\n' + "ignoreCase = " + col.ignoreCase);
            trace("ignoreDiacritics = " + col.ignoreDiacritics);

            compareString(testMatchData, wordToMatch) // All variations of the word cote match

            col.ignoreDiacritics = false;
            trace('\n' + "ignoreDiacritics = false");

            compareString(testMatchData, wordToMatch) // Variations with different diacritics will not match

            col.ignoreCase = false;
            trace('\n' + "ignoreCase = false");

            compareString(testMatchData, wordToMatch) // Variations with different case will not match
        }
    
        private function compareString(stringArray:Array, keyword:String):void
        {
            for each(var s:String in stringArray)
            {
                if(col.equals(s, keyword))    
                {
                    trace(keyword + " = " + s);
                }
            }
        }
    }
}