Cette fonction retourne une séquence résultat du tri d'une séquence de valeurs de type scalaire (Boolean, Number, String, Date, Time ou Date-time).
Le tri peut être ascendant ou descendant. La séquence doit contenir des valeurs de même type.
Lorsque les valeurs de la séquence sont de type String, le tri appliqué est un tri basé sur une locale.
Contrairement au tri lexicographique qui compare la valeur de codage de chaque caractère, ce tri utilise une collation qui permet de comparer deux chaînes de caractères en fonction d'une langue donnée.
Remarque :
Quelques différences par rapport à la fonction "built-in" Freemarker "sort" (cliquez ici pour plus de détails) appliquée à une séquence ([...]?sort) et à la fonction "lexicographicSort" :
- Le résultat obtenu des trois fonctions "sort", "lexicographicSort" et "localeBasedSort" est identique pour les types Boolean / Number / Date / Time / Date-time. Pour le type String, la fonction Freemarker "sort" applique un tri utilisant une collation (donc un résultat identique à "localBasedSort", mais différent de "lexicographicSort"),
- La fonction "sort" ne permet pas de trier en descendant. La seule solution est d'utiliser la fonction Freemarker "reverse" ([...]?sort?reverse), mais l'ordre original des valeurs qui sont égales n'est pas respecté.
Paramètres
Sequence de Boolean / Number / String / Date / Time / Date-time |
seqValues |
Séquence de valeurs à trier |
Obligatoire |
Boolean |
ascendingOrder |
"true" pour un tri ascendant, "false" pour un tri descendant |
Optionnel. La valeur par défaut est "true" |
Hash |
collatorInfos |
Définition des informations de la collation. Cet objet peut avoir les attributs suivants :
|
Optionnel. Si cet objet n'est pas fourni, la locale prise pour le tri est celle renseignée pour l'exécution du template (les attributs "strength" et "decomposition" auront une valeur par défaut qui dépend de la locale). |
Par exemple
<#assign elegance = [ "Élégance", "Elegance", "elegance", "élégance", "elegANCE", "elègance" ]> <#-- Ascending sort --> <#list hardisCode.localeBasedSort(elegance, {'locale': 'fr_FR', 'strength':'primary'}) as aVal> - ${aVal} </#list>
La sortie est :
- Élégance
- Elegance
- elegance
- élégance
- elegANCE
- elègance ↑ Haut de page