Collator  - AS3

El nombre del ID real de configuración regional utilizado por este objeto Collator.

Existen tres posibilidades para el valor del nombre, en función del sistema operativo y del valor del parámetro requestedLocaleIDName transferido al constructor Collator().

1. Si la configuración regional requerida no era LocaleID.DEFAULT y el sistema operativo admite la configuración regional requerida, el nombre devuelto es el mismo que la propiedad requestedLocaleIDName.
2. Si LocaleID.DEFAULT se ha utilizado como el valor del parámetro requestedLocaleIDName en el constructor, se utiliza el nombre de la configuración regional actual especificado por el sistema operativo del usuario. El valor de LocaleID.DEFAULT conserva la configuración personalizada del usuario en el sistema operativo. Transferir un valor explícito como el parámetro requestedLocaleIDName no necesariamente produce el mismo resultado que utilizar LocaleID.DEFAULT incluso si los dos ID de configuración regional son los mismos. El usuario podría haber personalizado los ajustes de la configuración regional de su equipo y, al solicitar un nombre ID de configuración regional explícito en lugar de utilizar LocaleID.DEFAULT, la aplicación no recuperaría dichos ajustes personalizados.
3. Si el sistema no admite el nombre de requestedLocaleIDName especificado en el constructor, se proporciona un nombre de ID de configuración regional de repuesto.

Elementos de API relacionados

Cuando esta propiedad se establece en true, las cadenas idénticas y las que difieren únicamente en la caja de las letras se evalúan como iguales. Por ejemplo, compare("ABC", "abc") devuelve true si la propiedad ignoreCase se establece en true.

La conversión de la caja de la cadena sigue las reglas de la configuración regional especificada.

Si la propiedad ignoreCase es false, los caracteres en mayúscula y minúscula no se consideran iguales entre sí.

Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

El valor predeterminado es true si el parámetro initialMode del constructor Collator() se establece en Collator.MATCHING. El valor predeterminado es false si el parámetro initialMode del constructor Collator() se establece en Collator.SORTING.

Elementos de API relacionados

Cuando la propiedad es true, las formas de ancho completo y de medio ancho de algunos caracteres chinos y japoneses se evalúan como iguales.

Para asegurar la compatibilidad con las normas existentes para los conjuntos de caracteres de chino y de japonés, Unicode proporciona códigos de caracteres tanto para ancho completo como para medio ancho en algunos caracteres. Por ejemplo, cuando la propiedad ignoreCharacterWidth se establece en true, compare("Ａｱ", "Aア") devuelve true.

Si la propiedad ignoreCharacterWidth se establece en false, las formas de ancho completo y de medio ancho no se consideran iguales entre sí.

Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

El valor predeterminado es false.

Elementos de API relacionados

Cuando esta propiedad se establece en true, las cadenas que utilizan los mismos caracteres base pero diferentes acentos u otras marcas diacríticas se evalúan como iguales. Por ejemplo, compare("coté", "côte") devuelve true si la propiedad ignoreDiacritics se establece en true.

Cuando ignoreDiacritics se establece en false, los caracteres base con marcas diacríticas o con acentos no se consideran iguales entre sí.

Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

El valor predeterminado es false.

Elementos de API relacionados

Cuando esta propiedad se establece en true, las cadenas que se van a utilizar y que difieren únicamente en el tipo de carácter kana se tratan como iguales. Por ejemplo, compare("カナ", "かな") devuelve true si la propiedad ignoreKanaType se establece en true.

Si ignoreKanaType se establece en false, los caracteres hiragana y katakana que hacen referencia a la misma sílaba no se consideran iguales entre sí.

Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

El valor predeterminado es false.

Elementos de API relacionados

Cuando esta propiedad se establece en true, los caracteres de símbolo como, por ejemplo, espacios, símbolos de divisa, símbolos matemáticos y otros tipos de símbolos, se omitirán en la ordenación. Por ejemplo, las cadenas "OBrian", "O'Brian" y "O Brian" se tratarán todas como iguales si la propiedad ignoreSymbols se establece en true.

Si la propiedad ignoreSymbols es false, los caracteres de símbolo se tienen en cuenta en las comparaciones de cadena.

Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

El valor predeterminado es false.

Elementos de API relacionados

El estado de la última operación que este objeto Collator ha realizado. lastOperationStatus se establece siempre que se llame al constructor o a un método de esta clase, o si se establece otra propiedad. Para conocer los valores posibles, consulte la descripción de cada método.

Elementos de API relacionados

Controla cómo se gestionan los valores numéricos incorporados en cadenas durante la comparación de cadenas.

Cuando la propiedad numericComparison se establece en true, el método compare convierte los números que aparecen en las cadenas en valores numéricos para la comparación.

Cuando esta propiedad se establece en false, la comparación trata los números como códigos de caracteres y los ordenará conforme a las reglas para la ordenación de caracteres de la configuración regional especificada.

Por ejemplo, cuando esta propiedad es "true" para el ID de configuración regional "en-US", las cadenas "version1", "version10" y "version2" se ordenan del modo siguiente: version1 < version2 < version10.

Si esta propiedad es false para "en-US", esas mismas cadenas se ordenan del modo siguiente: version1 < version10 < version2.

Cuando se asigna un valor a esta propiedad y no hay errores ni advertencias, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

El valor predeterminado es false.

Elementos de API relacionados

El nombre del ID de configuración regional requerido que se transfirió al constructor de este objeto Collator.

Si se ha utilizado el valor LocaleID.DEFAULT, el nombre devuelto es "i-default". La configuración regional real que se utiliza puede ser diferente de la configuración regional requerida cuando cuando se aplica una configuración regional de repuesto. El nombre de la configuración regional real se puede recuperar usando la propiedad actualLocaleIDName.

Elementos de API relacionados

Construye un nuevo objeto Collator para proporcionar comparaciones según las convenciones de una configuración regional específica.

Si el sistema operativo actual no admite el ID de configuración regional transferido en el parámetro requestedLocaleIDName, se determina una configuración regional del repuesto. Si se utiliza un repuesto, la propiedad lastOperationStatus se establece para indicar el tipo de repuesto.

El parámetro initialMode establece diversas opciones para usos generales. Se puede establecer en cualquiera de los valores siguientes:

• CollatorMode.SORTING: establece opciones de recopilación para usos generales de ordenación lingüística, como ordenar una lista de cadenas de texto que se muestre al usuario final. En este modo, las diferencias entre mayúsculas y minúsculas, caracteres acentuados y otras diferencias específicas de la configuración regional se tienen en cuenta al llevar a cabo comparaciones de cadena.
• CollatorMode.MATCHING: establece opciones de recopilación para usos generales, como determinar si dos cadenas son equivalentes. En este modo, las diferencias entre mayúsculas y minúsculas, caracteres acentuados, etc., se omiten cuando lleve a cabo comparaciones de cadena.

A continuación, se muestra un ejemplo de lista ordenada creada mediante un objeto Collator con el ID de configuración regional "en-US" (inglés de Estados Unidos) y la opción CollatorMode.SORTING:

Tal y como se muestra arriba, todos los caracteres se tratan como si tuvieran valores distintos, pero en orden lingüístico.

A continuación, se muestra un ejemplo de lista ordenada creada mediante un objeto Collator con el ID de configuración regional "en-US" (inglés de Estados Unidos) y la opción CollatorMode.MATCHING:

Tal y como se puede ver arriba, algunos caracteres están en orden lingüístico y se tratan como si tuvieran el mismo valor de carácter.

Para obtener un control mayor de ordenación, puede cambiar propiedades collator como Collator.ignoreCase o Collator.ignoreDiacritics.

A modo de referencia, a continuación se incluye un ejemplo de ordenación correspondiente con el método estándar Array.sort(), que no detecta la configuración regional:

Como puede ver arriba, todos los caracteres se ordenan simplemente según el valor numérico Unicode. No tiene mucho sentido desde un punto de vista lingüístico.

Para utilizar las preferencias del sistema operativo actuales del usuario, transfiera el valor estático LocaleID.DEFAULT del parámetro requestedLocaleIDName al constructor.

Algunas configuraciones regionales tienen variantes de orden de clasificación. Por ejemplo, en alemán se utiliza un orden de clasificación para agendas de teléfonos y otro orden para diccionarios. En chino, las palabras suelen admitirse por transliteración de los caracteres en el pinyin. Estos órdenes de clasificación distintos se pueden seleccionar incluyendo la palabra clave "collation" de la cadena que se transfiere en el parámetro requestedLocaleIDName al constructor.

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

Los valores posibles de la cadena Collation son los siguientes, con los idiomas afectados entre paréntesis:

Si la plataforma host no admite el tipo de recopilación requerido, se utiliza una de repuesto y la propiedad lastOperationStatus se establece para indicar que se ha seleccionado una recopilación de repuesto. Puede utilizar la propiedad actualLocaleIDName para determinar el valor que se utilizó como repuesto, tal y como se muestra en el siguiente ejemplo:

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

Cuando el constructor se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

Cuando nombre del ID de la configuración regional requerida no está disponible, la propiedad lastOperationStatus se establece en uno de los valores siguientes:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Para obtener información detallada sobre las advertencias que aparecen en la lista anterior y sobre otros valores posibles de lastOperationStatus, consulte las descripciones de la clase LastOperationStatus.

Elementos de API relacionados

Compara dos cadenas y devuelve un valor entero que indica si la primera cadena es menor, igual o mayor que la segunda cadena. La comparación utiliza las reglas de orden de clasificación para el ID de configuración regional especificado en el constructor Collator().

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Compara dos cadenas y devuelve un valor booleano que indica si las cadenas son iguales. La comparación utiliza las reglas de orden de clasificación para el ID de configuración regional especificado en el constructor Collator().

Cuando se llama a este método y se completa correctamente, la propiedad lastOperationStatus se establece en:

• LastOperationStatus.NO_ERROR

En caso contrario, la propiedad lastOperationStatus se establece en una de las constantes definidas en la clase LastOperationStatus.

Parámetros

Elementos de API relacionados

Muestra una lista de todos los nombres de ID de configuración regional admitidos por esta clase.

Si esta clase no se admite en el sistema operativo actual, este método devuelve un valor null.

1. Itera por un conjunto de nombres de ID de configuración regional, incluido el ID de configuración regional predeterminada para el sistema operativo (como se especifica en LocaleID.DEFAULT)
2. Crea un objeto Collator para cada nombre de ID de configuración regional utilizando el modo de "ordenación" (configuración predeterminada).
3. Muestra la configuración regional real y solicitada y los nombres de ID y el valor de la propiedad lastOperationStatus para que pueda ver si una se ha utilizado una configuración regional de repuesto.
4. Ordena un conjunto de datos con dada objeto Collator y muestra los resultados. El orden resultante es diferente para cada configuración regional.

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. Crea un objeto Collator para la configuración regional predeterminada del usuario utilizando el modo "coincidente".
2. También establece la propiedad Collator.ignoreDiacritics en false y true
3. Compara conjuntos de cadenas que contienen signos diacríticos y caracteres en mayúscula y minúscula.
4. Muestra cómo las comparaciones cambian cuando cambian las propiedades Collator.ignoreDiacritics y 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);
                }
            }
        }
    }
}