Collator  - AS3

Имя фактического идентификатора локали, используемого этим объектом Collator.

В зависимости от операционной системы и значения параметра requestedLocaleIDName, передаваемого конструктору Collator(), имя может иметь одно из трех значений.

1. Если запрашиваемая локаль не является LocaleID.DEFAULT и поддерживается операционной системой, тогда возвращаемое имя совпадает со значением свойства requestedLocaleIDName.
2. Если константа LocaleID.DEFAULT использована в качестве значения параметра requestedLocaleIDName конструктора, то используется имя текущей локали, заданной в операционной системе пользователя. Значение LocaleID.DEFAULT сохраняет настройку ОС, заданную пользователем. Передача явного значения в качестве параметра requestedLocaleIDName не обязательно дает тот же результат, что использование LocaleID.DEFAULT, даже если при этом используются одинаковые имена идентификатора локали. Пользователь мог задать в своей системе пользовательские настройки локали, и запрос явного имени идентификатора локали вместо использования константы LocaleID.DEFAULT в программе не позволит извлечь эти пользовательские настройки.
3. Если система не поддерживает имя requestedLocaleIDName, определенное в конструкторе, то используется резервное имя идентификатора локали.

Связанные элементы API

Когда это свойство имеет значение true, идентичные строки и строки, отличающиеся только регистром букв, рассматриваются как равные. Например, метод compare("ABC", "abc") возвращает значение true, когда свойство ignoreCase имеет значение true.

Преобразование регистра строки выполняется по правилам для указанной локали.

Когда свойство ignoreCase имеет значение false, символы верхнего и нижнего регистра рассматриваются как разные.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значение по умолчанию – true, если для параметра initialMode конструктора Collator() установлено значение Collator.MATCHING. Значение по умолчанию – false, если для параметра initialMode конструктора Collator() установлено значение Collator.SORTING.

Связанные элементы API

Когда это свойство имеет значение true, полноширинные и полуширинные формы некоторых китайских и японских символов рассматриваются как одинаковые.

Для обеспечения совместимости с существующими стандартами для китайских и японских наборов символов Юникод обеспечивает коды символов для полноширинных и полуширинных форм некоторых символов. Например, когда свойство ignoreCharacterWidth имеет значение true, метод compare("Ａｱ", "Aア") возвращает значение true.

Если свойство ignoreCharacterWidth имеет значение false, то полноширинные и полуширинные формы рассматриваются как разные.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является false.

Связанные элементы API

Когда это свойство имеет значение true, строки, в которых используются одинаковые базовые символы, но разные акценты или диакритические знаки, рассматриваются как одинаковые. Например, метод compare("coté", "côte") возвращает значение true, когда свойство ignoreDiacritics имеет значение true.

Когда свойство ignoreDiacritics имеет значение false, базовые символы с диакритическими знаками или акцентами будут рассматриваться как разные.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является false.

Связанные элементы API

Когда это свойство имеет значение true, строки, которые отличаются только типом используемого символа кана, рассматриваются как одинаковые. Например, compare("カナ", "��") возвращает значение true, когда свойство ignoreKanaType имеет значение true.

Если ignoreKanaType имеет значение false, символы хираганы и катаканы, обозначающие одинаковый слог, рассматриваются как разные.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является false.

Связанные элементы API

Когда это свойство имеет значение true, при сортировке или сравнении игнорируются символьные знаки, включая пробелы, символы валют, математическим символы и др. Например, строки «OBrian», «O'Brian» и «O Brian» рассматриваются как одинаковые, когда свойство ignoreSymbols имеет значение true.

Если свойство ignoreSymbols имеет значение false, при сравнении строк учитываются символьные знаки.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является false.

Связанные элементы API

Состояние самой последней операции, выполненной этим объектом Collator. Свойство lastOperationStatus задается каждый раз при вызове конструктора или метода этого класса или при задании значения для другого свойства. Другие возможные значения см. в описании соответствующего метода.

Связанные элементы API

Управляет обработкой числовых значений, включенных в строки, в ходе сравнения строк.

Когда свойство numericComparison имеет значение true, метод compare преобразует числа, включенные в строки, в числовые значения для сравнения.

Когда это свойство имеет значение false, в ходе сравнения эти числа рассматриваются как коды символов и сортируются в соответствии с правилами сортировки символов для указанной локали.

Например, когда это свойство имеет значение true для идентификатора локали en-US, строки «version1», «version10» и «version2» сортируются в следующем порядке: version1 < version2 < version10.

Когда это свойство имеет значение false для локали en-US, эти же строки сортируются по-другому: version1 < version10 < version2.

Когда этому свойству задано значение и отсутствуют ошибки или предупреждения, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Значением по умолчанию является false.

Связанные элементы API

Имя запрашиваемого идентификатора локали, переданного конструктору этого объекта Collator.

Если использовано значение LocaleID.DEFAULT, возвращается имя i-default. Локаль, использованная на самом деле, может отличаться от запрашиваемой, когда применяется резервная локаль. Имя фактической локали можно получить с помощью свойства actualLocaleIDName.

Связанные элементы API

Создает новый объект Collator для сравнения строк в соответствии с правилами заданной локали.

Если текущая операционная система не поддерживает идентификатор локали, переданный в параметре requestedLocaleIDName, определяется резервная локаль. Если используется резервный вариант, свойству lastOperationStatus задается значение, указывающее тип резервной локали.

Параметр initialMode задает различные параметры сравнения для распространенных случаев применения. Может иметь одно из следующих значений.

• CollatorMode.SORTING: задает параметры сравнения для обычной лингвистической сортировки, такой как сортировка списка текстовых строк, которые отображаются для конечного пользователя. В этом режиме при сравнении строк проводится различие между строчными и прописными буквами, символами с акцентом и без, а также учитываются другие отличия.
• CollatorMode.MATCHING: задает параметры сравнения для общего применения, такого как определение эквивалентности двух строк. В этом режиме сравнение выполняется без учета строчных и прописных букв, символов с акцентами и других отличий.

Ниже приводится пример сортированного списка, созданного объектом Collator для локали en-US (английская, США) с использованием режима CollatorMode.SORTING.

Как показано выше, все символы рассматриваются как разные значения, но перечислены в порядке лингвистической сортировки.

Ниже приводится пример сортированного списка, созданного объектом Collator для локали en-US (английская, США) с использованием режима CollatorMode.MATCHING.

Как показано выше, некоторые символы находятся в лингвистически правильном порядке и рассматриваются как имеющие одно и то же значение символа.

Для более точного управления порядком сортировки можно изменять значения свойств объекта Collator, таких как Collator.ignoreCase или Collator.ignoreDiacritics.

Для сравнения приводится соответствующий пример сортировки с помощью стандартного метода Array.sort(), который не учитывает локали.

Как видно, все символы сортируются просто по числовому значению Юникод. Его нельзя считать корректным с лингвистической точки зрения.

Чтобы использовать текущие пользовательские настройки операционной системы, необходимо передать статическое значение LocaleID.DEFAULT в параметре requestedLocaleIDName конструктора.

Для некоторых локалей предусмотрено несколько вариантов порядка сортировки. Например, в немецком языке для телефонных книг и словарей используются разный порядок сортировки. В китайском языке слова обычно поддерживаются путем транслитерации символов в систему пиньинь. Разные порядки сортировки можно выбирать путем добавления ключевого слова collation в строку, передаваемую в параметре requestedLocaleIDName конструктора.

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

Ниже перечислены возможные значения для строки сопоставления, в скобках перечислены затрагиваемые языки.

Если платформа хоста не поддерживает запрашиваемый тип сравнения, используется резервный вариант, и свойству lastOperationStatus задается значение, определяющее выбранный вариант. С помощью свойства actualLocaleIDName можно определить значение, которое было использовано в качестве резервного, как показано в следующем примере.

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

Когда конструктор успешно создает объект, свойству lastOperationStatus задается значение:

• LastOperationStatus.NO_ERROR

Когда запрашиваемый идентификатора локали недоступен, свойство lastOperationStatus получает одно из следующих значений:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Дополнительные сведения о перечисленных выше предупреждениях и других возможных значениях свойства lastOperationStatus см. в описании класса LastOperationStatus.

Связанные элементы API

Сравнивает две строки и возвращает целое число, указывающее на то, меньше, равна или больше первая строка второй. При сравнении используются правила сортировки для идентификатора локали, указанного в конструкторе Collator().

Когда этот метод вызывается и успешно выполняется, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Параметры

Связанные элементы API

Сравнивает две строки и возвращает логическое значение, указывающее на то, равны ли эти строки. При сравнении используются правила сортировки для идентификатора локали, указанного в конструкторе Collator().

Когда этот метод вызывается и успешно выполняется, свойство lastOperationStatus получает значение:

• LastOperationStatus.NO_ERROR

В противном случае в качестве значения свойства lastOperationStatus задается одна из констант, определенных в классе LastOperationStatus.

Параметры

Связанные элементы API

Перечисляет все имена идентификаторов локалей, поддерживаемые этим классом.

Если этот класс совсем не поддерживается текущей операционной системой, данный метод возвращает нулевое значение.

1. Перечисляется массив имен идентификаторов локали, включая идентификатор локали операционной системы по умолчанию (указанный в свойстве LocaleID.DEFAULT).
2. Создается объект Collator для каждого имени идентификатора локали с использованием режима сортировки (по умолчанию).
3. Отображаются имена запрошенных и фактически используемых идентификаторов локали и значение свойства lastOperationStatus, чтобы можно было проверить, не использована ли резервная локаль.
4. Массив данных сортируется с использованием каждого объекта Collator, затем отображаются результаты. В результате для каждой локали отображается разный порядок.

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. Создается объект Collator для пользовательской локали по умолчанию с использованием режима сравнения.
2. Свойству Collator.ignoreDiacritics поочередно задается значение false и true
3. Сравниваются наборы строк, содержащие диакритические знаки и символы верхнего и нижнего регистра.
4. Демонстрируется, как различаются результаты сравнения при использовании разных значений для свойств Collator.ignoreDiacritics и 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);
                }
            }
        }
    }
}