Collection
La classe Collection gère les variables de type Collection.
Une collection est initialisée avec :
New collection {( ...value : any )} : Collection crée une nouvelle collection vide ou préremplie |
New shared collection {( ...value : any )} : Collection crée une nouvelle collection partagée vide ou pré-remplie |
Exemple
var $colVar : Collection //création d'une variable 4D de type collection
$colVar:=New collection ///initialisation de la collection et assignation à la variable 4D
Sommaire
.at( index : Integer ) : any renvoie l'élément à la position index, acceptant des nombres entiers positifs et négatifs |
.average( {propertyPath : Text } ) : Real retourne la moyenne arithmétique des valeurs définies dans la collection |
.clear() : Collection supprime tous les éléments de la collection et retourne une collection vide |
.combine( col2 : Collection {; index : Integer } ) : Collection insère les éléments de col2 à la fin ou à la position index de la collection et retourne la collection modifiée |
.concat( value : any { ;...valueN } ) : Collection retourne une nouvelle collection avec le contenu du paramètre value ajouté à la fin de la collection d'origine |
.copy() : Collection .copy( option : Integer ) : Collection .copy( option : Integer ; groupWithCol : Collection ) : Collection .copy( option : Integer ; groupWithObj : Object ) : Collection retourne une copie profonde (deep copy) de la collection |
.count( { propertyPath : Text } ) : Real retourne le nombre d'éléments non null dans la collection |
.countValues( value : any {; propertyPath : Text } ) : Real retourne le nombre d'occurrences de value dans la collection |
.distinct( {options : Integer} ) : Collection .distinct( propertyPath : Text {; options : Integer } ) : Collection renvoie une collection contenant uniquement les valeurs distinctes (différentes) dans la collection d'origine |
.equal( collection2 : Collection {; option : Integer } ) : Boolean compare la collection avec collection2 |
.every( { startFrom : Integer ; } formula : 4D.Function { ;...param : any } ) : Boolean .every( { startFrom : Integer ; } methodName : Text { ;...param : any } ) : Boolean retourne true si tous les éléments de la collection ont réussi avec succès un test implémenté dans l'objet formule fourni ou la méthode methodName |
.extract( propertyPath : Text { ; option : Integer } ) : Collection .extract( propertyPath : Text ; targetPath : Text { ;...propertyPathOrTargetPathN : Text } ) : Collection crée et retourne une nouvelle collection contenant les valeurs de propertyPath extraites depuis la collection d'objets d'origine |
.fill( value : any ) : Collection .fill( value : any ; startFrom : Integer { ; end : Integer } ) : Collection remplit les éléments de la collection avec value, optionnellement depuis l'élément startFrom et jusqu'à l'élément end (non inclus), et retourne la collection résultante |
.filter( formula : 4D.Function { ; ...param : any } ) : Collection .filter( methodName : Text { ; ...param : any } ) : Collection retourne une nouvelle collection contenant tous les éléments de la collection d'origine pour lesquels le résultat de formula ou methodName est true |
.find( { startFrom : Integer ; } formula : 4D.Function { ; ...param : any } ) : any .find( { startFrom : Integer ; } methodName : Text { ; ...param : any } ) : any retourne la première valeur dans la collection pour laquelle le résultat de formula ou methodName retourne true |
.findIndex( { startFrom : Integer ; } formula : 4D.Function { ; ...param : any } ) : Integer .findIndex( { startFrom : Integer ; } methodName : Text { ; ...param : any } ) : Integer retourne le numéro, dans la collection, du premier élément pour lequel formula ou methodName retourne true |
.first() : any renvoie le premier élément de la collection |
.flat( { depth : Integer } ) : Collection crée une nouvelle collection dans laquelle tous les éléments de sous-collections sont concaténés de manière récursive jusqu'à la profondeur depth spécifiée |
.flatMap( formula : 4D.Function { ; ...param : any } ) : Collection .flatMap( methodName : Text { ; ...param : any } ) : Collection crée une nouvelle collection basée sur le résultat de l'appel de la fonction 4D formula ou de la méthode methodName sur chaque élément de la collection originale et mise à plat sur une profondeur de 1 |
.includes( toSearch : expression { ; startFrom : Integer } ) : Boolean renvoie True si l'expression toSearch est trouvée parmi les éléments de la collection, sinon False |
.indexOf( toSearch : expression { ; startFrom : Integer } ) : Integer recherche l'expression toSearch parmi les éléments de la collection et retourne le numéro d'élément de la première occurrence trouvée, ou -1 si aucune occurrence n'a été trouvée |
.indices( queryString : Text { ; ...value : any } ) : Collection retourne les positions, dans la collection d'origine, des éléments répondant au(x) critère(s) de recherche de queryString |
.insert( index : Integer ; element : any ) : Collection insère les éléments de element à la position index de la collection et retourne la collection modifiée |
.join( delimiter : Text { ; option : Integer } ) : Text retourne une nouvelle collection avec le contenu du paramètre value ajouté à la fin de la collection d'origine |
.last() : any renvoie le dernier élément de la collection |
.lastIndexOf( toSearch : expression { ; startFrom : Integer } ) : Integer recherche l'expression toSearch parmi les éléments de la collection et retourne le numéro d'élément de la dernière occurrence trouvée |
.length : Integer retourne le nombre d'éléments dans la collection |
.map( formula : 4D.Function { ; ...param : any } ) : Collection .map( methodName : Text { ; ...param : any } ) : Collection crée une nouvelle collection basée sur le résultat de l'exécution de la fonction 4D formula ou de la méthode methodName sur chaque élément de la collection d'origine |
.max( { propertyPath : Text } ) : any retourne l'élément de la collection ayant la valeur la plus élevée |
.min( { propertyPath : Text } ) : any retourne l'élément de la collection ayant la valeur la plus petite |
.orderBy( ) : Collection .orderBy( pathStrings : Text ) : Collection .orderBy( pathObjects : Collection ) : Collection .orderBy( ascOrDesc : Integer ) : Collection retourne une nouvelle collection contenant tous les éléments de la collection d'origine triés selon les critères définis |
.orderByMethod( formula : 4D.Function { ; ...extraParam : expression } ) : Collection .orderByMethod( methodName : Text { ; ...extraParam : expression } ) : Collection retourne une nouvelle collection contenant tous les éléments de la collection d'origine triés selon les critères définis par la fonction 4D formula 4D function ou la méthode methodName |
.pop() : any supprime le dernier élément de la collection et le retourne comme résultat de fonction |
.push( element : any { ;...elementN } ) : Collection ajoute un ou plusieurs element(s) à la fin de la collection et retourne la collection modifiée |
.query( queryString : Text ; ...value : any ) : Collection .query( queryString : Text ; querySettings : Object ) : Collection retourne tous les éléments d'une collection d'objets qui correspondent aux critères de recherche |
.reduce( formula : 4D.Function { ; initValue : any { ; ...param : expression }} ) : any .reduce( methodName : Text { ; initValue : any { ; ...param : expression }} ) : any applique la callback formula ou methodName à un accumulateur et à chaque élément de la collection (de gauche à droite) pour le réduire à une valeur unique |
.reduceRight( formula : 4D.Function { ; initValue : any { ; ...param : expression }} ) : any .reduceRight( methodName : Text { ; initValue : any { ; ...param : expression }} ) : any applique la callback formula ou methodName à un accumulateur et à chaque élément de la collection (de droite à gauche) pour la réduire à une seule valeur |
.remove( index : Integer { ; howMany : Integer } ) : Collection supprime un ou plusieurs élément(s) dans la collection à partir de la position spécifiée par index et retourne la collection modifiée |
.resize( size : Integer { ; defaultValue : any } ) : Collection redimensionne la collection à la taille définie et retourne la collection redimensionnée |
.reverse( ) : Collection retourne une copie profonde (deep copy) de la collection avec tous ses éléments en ordre inverse |
.shift() : any supprime le premier élément de la collection et le retourne en résultat |
.slice( startFrom : Integer { ; end : Integer } ) : Collection retourne une partie de la collection dans une nouvelle collection |
.some( { startFrom : Integer ; } formula : 4D.Function { ; ...param : any } ) : Boolean .some( { startFrom : Integer ; } methodName : Text { ; ...param : any } ) : Boolean retourne vrai si au moins un des éléments de la collection a été évalué à vrai par le test implémenté dans l'objet formula ou la méthode methodName |
.sort() : Collection .sort( formula : 4D.Function { ; ...extraParam : any } ) : Collection .sort( methodName : Text { ; ...extraParam : any } ) : Collection trie les éléments de la collection d'origine et retourne également une référence vers cette collection triée |
.sum( { propertyPath : Text } ) : Real retourne la somme de toutes les valeurs numériques de la collection |
.unshift( value : any { ;...valueN : any } ) : Collection insère la ou les value(s) au début de la collection |
New collection
New collection {( ...value : any )} : Collection
Paramètres | Type | Description | |
---|---|---|---|
value | Number, Text, Date, Time, Boolean, Object, Collection, Picture, Pointer | -> | Valeur(s) de collection |
Résultat | Collection | <- | La nouvelle collection |
|
Description
La commande New collection
crée une nouvelle collection vide ou préremplie et retourne sa référence.
Si vous ne passez aucun paramètre, New collection
crée une collection vide et retourne sa référence.
Vous devez affecter la référence retournée à une variable 4D de type Collection.
N'oubliez pas que les instructions
var : Collection
ouC_COLLECTION
déclarent une variable du typeCollection
mais ne créent pas de collection.
En option, vous pouvez préremplir la nouvelle collection en utilisant une ou plusieurs valeur(s) (value(s)) en tant que paramètre(s).
Sinon, vous pouvez ajouter ou modifier des éléments ultérieurement par affectation. Par exemple :
myCol[10]:="My new element"
Si le nouvel indice de l'élément est au-delà du dernier élément existant de la collection, la collection est automatiquement redimensionnée et tous les nouveaux éléments intermédiaires prennent la valeur null.
Vous pouvez passer n'importe quel nombre de valeurs de n'importe quel type pris en charge (number, text, date, picture, pointer, object, collection...). Contrairement aux tableaux, les collections peuvent mélanger des données de différents types.
Vous devez prêter attention aux problèmes de conversion suivants :
- Si vous passez un pointeur, il est conservé "tel quel"; il est évalué à l'aide de la commande
JSON Stringify
- Les dates sont stockées sous la forme de date « aaaa-mm-jj » ou des chaînes au format « AAAA-MM-JJTHH: ss.SSSZ: mm » , selon la configuration actuelle « dates à l'intérieur des objets » de la base de données. Lors de la conversion de dates 4D en texte avant de les stocker dans la collection, par défaut le programme prend en compte le fuseau horaire local. Vous pouvez modifier ce comportement à l'aide du sélecteur
Dates inside objects
de la commandeSET DATABASE PARAMETER
. - Si vous passez une heure, elle est stockée sous la forme d'un nombre de millisecondes (Réel).
Exemple 1
Vous souhaitez créer une nouvelle collection vide et l'assigner à une variable collection 4D :
var $myCol : Collection
$myCol:=New collection
//$myCol=[]
Exemple 2
Vous souhaitez créer une collection pré-remplie :
var $filledColl : Collection
$filledColl:=New collection(33;"mike";"november";->myPtr;Current date)
//$filledColl=[33,"mike","november","->myPtr","2017-03-28T22:00:00.000Z"]
Exemple 3
Vous souhaitez créer une nouvelle collection puis ajouter un élément :
var $coll : Collection
$coll:=New collection("a";"b";"c")
//$coll=["a","b","c"]
$coll[9]:="z" //ajouter un 10e élément avec la valeur "z"
$vcolSize:=$coll.length //10
//$coll=["a","b","c",null,null,null,null,null,null,"z"]
New shared collection
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
New shared collection {( ...value : any )} : Collection
Paramètres | Type | Description | |
---|---|---|---|
value | Number, Text, Date, Time, Boolean, Shared object, Shared collection | -> | Valeur(s) de la collection partagée |
Résultat | Collection | <- | La nouvelle collection partagée |
|
Description
La commande New shared collection
crée une nouvelle collection partagée vide ou pré-remplie et retourne sa référence.
L'ajout d'un élément à cette collection à l'aide de l'opérateur d'assignation doit être entouré de la structure Use...End use
, sinon une erreur est générée (cela n'est pas nécessaire lors de l'ajout d'éléments à l'aide de fonctions telles que push()
ou map()
, car elles déclenchent automatiquement une structure interne Use...End use). La lecture d'un élément sans structure Use...End use est toutefois possible.
Pour plus d'informations sur les collections partagées, reportez-vous à la page Objets et collections partagés.
Si vous ne passez aucun paramètre, New shared collection
crée une collection vide et retourne sa référence.
Vous devez affecter la référence retournée à une variable 4D de type Collection.
N'oubliez pas que les instructions
var : Collection
ouC_COLLECTION
déclarent une variable du typeCollection
mais ne créent pas de collection.
En option, vous pouvez préremplir la nouvelle collection en utilisant une ou plusieurs valeur(s) (value(s)) en tant que paramètre(s). Sinon, vous pouvez ajouter ou modifier des éléments ultérieurement via l'assignation en notation objet (cf. exemple).
Si le nouvel indice de l'élément est au-delà du dernier élément existant de la collection partagée, la collection est automatiquement redimensionnée et tous les nouveaux éléments intermédiaires prennent la valeur null.
Vous pouvez passer tout nombre de valeurs de n'importe quel type pris en charge :
- nombre (réel, entier...). Les valeurs numériques sont toujours stockées sous forme de réels.
- text
- boolean
- date
- heure (stockée en nombre de milliseconds - réel)
- Null
- Si vous souhaitez que l'évaluation soit sensible à la casse ou pour différencier des caractères accentués, passez la constante
ck diacritical
dans le paramètre option. - $1.stop (booléen, optionnel) : true pour stopper le rétroappel de la méthode.
Contrairement aux collections standard (non partagées), les collections partagées ne prennent pas en charge les images, les pointeurs et les objets ou collections non partagés.
Exemple
$mySharedCol:=New shared collection("alpha";"omega")
Use($mySharedCol)
$mySharedCol[1]:="beta"
End use
.at()
Historique
Release | Modifications |
---|---|
20 | Ajout |
.at( index : Integer ) : any
Paramètres | Type | Description | |
---|---|---|---|
index | Integer | -> | Index de l'élément à renvoyer |
Résultat | any | <- | L'élément à cet index |
|
Description
La fonction .at()
renvoie l'élément à la position index, acceptant des nombres entiers positifs et négatifs.
Cette fonction ne modifie pas la collection d'origine.
Les nombres entiers négatifs déterminent la position à partir du dernier élément de la collection.
La fonction renvoie Undefined si l'index dépasse les limites de la collection.
Exemple
var $col : Collection
$col:=New collection(10; 20; 30; 40; 50)
$element:=$col.at(0) // 10
$element:=$col.at(1) // 20
$element:=$col.at(-1) // 50
$element:=$col.at(-2) // 40
$element:=$col.at(10) // undefined
.average()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.average( {propertyPath : Text } ) : Real
Paramètres | Type | Description | |
---|---|---|---|
propertyPath | Text | -> | Chemin de propriété d'objet à utiliser pour évaluer les valeurs |
Résultat | Real, Undefined | <- | Moyenne arithmétique des valeurs de la collection |
|
Description
La fonction .average()
retourne la moyenne arithmétique des valeurs définies dans la collection.
Seuls les éléments ayant une valeur numérique sont pris en compte pour le calcul (les autres types d'éléments sont ignorés).
Si la collection contient des objets, passez le paramètre propertyPath si vous souhaitez désigner la propriété dont vous voulez connaître la moyenne.
.average()
retourne undefined
si :
- la collection est vide,
- la collection ne contient pas d'éléments numériques,
- propertyPath n'est pas trouvé dans la collection.
Exemple 1
var $col : Collection
$col:=New collection(10;20;"Monday";True;6)
$vAvg:=$col.average() //12
Exemple 2
var $col : Collection
$col:=New collection
$col.push(New object("name";"Smith";"salary";10000))
$col.push(New object("name";"Wesson";"salary";50000))
$col.push(New object("name";"Gross";"salary";10500))
$vAvg:=$col.average("salary") //23500
.clear()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.clear() : Collection
Paramètres | Type | Description | |
---|---|---|---|
Résultat | Collection | <- | Collection d'origine dont tous les éléments ont été supprimés |
|
Description
La fonction .clear()
supprime tous les éléments de la collection et retourne une collection vide.
Cette fonction modifie la collection d'origine.
Exemple
var $col : Collection
$col:=New collection(1;2;5)
$col.clear()
$vSize:=$col.length //$vSize=0
.combine()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.combine( col2 : Collection {; index : Integer } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
col2 | Collection | -> | Collection à combiner |
index | Integer | -> | Emplacement où insérer les éléments à combiner (défaut=length+1) |
Résultat | Collection | <- | Collection d'origine incluant les éléments combinés |
|
Description
La fonction .combine()
insère les éléments de col2 à la fin ou à la position index de la collection et retourne la collection modifiée. A la différence de la fonction .insert()
, .combine()
ajoute chaque valeur de col2 dans la collection d'origine, et non en tant qu'élément unique de collection.
Cette fonction modifie la collection d'origine.
Par défaut, les éléments de col2 sont ajoutés à la fin de la collection d'origine. Vous pouvez passer dans index le numéro de l'élément après lequel vous souhaitez que les éléments de col2 soient insérés dans la collection.
Attention : N'oubliez pas que la numérotation des éléments de collection débute à 0.
- Si index > la longueur de la collection, l'index de départ réel sera fixé à la longueur de la collection.
- Si index < 0, il est recalculé comme index:=index+lenth (il est considéré comme le décalage par rapport à la fin de la collection).
- Si la valeur calculée est négative, index prend la valeur 0.
Exemple
var $c; $fruits : Collection
$c:=New collection(1;2;3;4;5;6)
$fruits:=New collection("Orange";"Banana";"Apple";"Grape")
$c.combine($fruits;3) //[1,2,3,"Orange","Banana","Apple","Grape",4,5,6]
.concat()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.concat( value : any { ;...valueN } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
value | Number, Text, Object, Collection, Date, Time, Boolean, Picture | -> | Valeur(s) à concaténer. Si value est une collection, tous les éléments de la collection sont ajoutés à la collection d'origine |
Résultat | Collection | <- | Nouvelle collection contenant les valeurs d'origine et les valeurs ajoutées |
|
Description
La fonction .concat()
retourne une nouvelle collection avec le contenu du paramètre value ajouté à la fin de la collection d'origine.
Cette fonction ne modifie pas la collection d'origine.
Si value est une collection, tous ses éléments sont ajoutés comme nouveaux éléments à la fin de la collection d'origine. Si value n'est pas une collection, son contenu est ajouté comme nouvel élément.
Exemple
var $c : Collection
$c:=New collection(1;2;3;4;5)
$fruits:=New collection("Orange";"Banana";"Apple";"Grape")
$fruits.push(New object("Intruder";"Tomato"))
$c2:=$c.concat($fruits) //[1,2,3,4,5,"Orange","Banana","Apple","Grape",{"Intruder":"Tomato"}]
$c2:=$c.concat(6;7;8) //[1,2,3,4,5,6,7,8]
.copy()
Historique
Release | Modifications |
---|---|
18 R3 | Nouvelle option ck shared. Nouveaux paramètres groupWith |
v16 R6 | Ajout |
.copy() : Collection
.copy( option : Integer ) : Collection
.copy( option : Integer ; groupWithCol : Collection ) : Collection
.copy( option : Integer ; groupWithObj : Object ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
option | Integer | -> | ck resolve pointers : résoudre les pointeurs avant la copie,ck shared : retourner une collection partagée |
groupWithCol | Collection | -> | Collection partagée à grouper avec la collection résultante |
groupWithObj | Object | -> | Objet partagé à grouper avec la collection résultante |
Résultat | Collection | <- | Copie de la collection d'origine (deep copy) |
|
Description
La fonction .copy()
retourne une copie profonde (deep copy) de la collection. Deep copy signifie que les objets ou les collections présents dans la collection d'origine sont dupliqués et ne partagent pas leur référence avec la collection qui est retournée.
Cette fonction ne modifie pas la collection d'origine.
S'il est passé, le paramètre option peut contenir l'une des constantes suivantes (ou les deux) :
option | Description |
---|---|
ck resolve pointers | Si la collection d'origine contient des valeurs de type pointeur, par défaut la copie contient également les pointeurs. Cependant, vous pouvez résoudre les pointeurs lors de la copie en passant la constante ck resolve pointers . Dans ce cas, chaque pointeur contenu dans la collection est évalué lors de la copie et sa valeur déréférencée est utilisée. |
ck shared | Par défaut, copy() retourne une collection standard (non partagée), même si la fonction s'applique à une collection partagée. Passez la constante ck shared pour créer une collection partagée. Dans ce cas, vous pouvez utiliser le paramètre groupWith pour associer la collection partagée à une autre collection ou à un autre objet (voir ci-dessous). |
Les paramètres groupWithCol ou groupWithObj vous permettent de désigner une collection ou un objet auquel/à laquelle la collection résultante sera associée.
Les objets Datastore, dataclass et entity ne sont pas copiables. Si .copy()
est appelé avec eux, des valeurs null
sont retournées.
Exemple 1
Nous souhaitons copier la collection standard (non partagée) $lastnames dans l'objet partagé $sharedObject. Pour ce faire, nous devons créer une copie partagée de la collection ($sharedLastnames).
var $sharedObject : Object
var $lastnames;$sharedLastnames : Collection
var $text : Text
$sharedObject:=New shared object
$text:=Document to text(Get 4D folder(Current resources folder)+"lastnames.txt")
$lastnames:=JSON Parse($text) //$lastnames est un collection standard
$sharedLastnames:=$lastnames.copy(ck shared) //$sharedLastnames est une collection partagée
//Nous pouvons désormais placer $sharedLastnames dans $sharedObject
Use($sharedObject)
$sharedObject.lastnames:=$sharedLastnames
End use
Exemple 2
Nous souhaitons combiner $sharedColl1 et $sharedColl2. Etant donné qu'ils appartiennent à différents groupes partagés, une combinaison directe pourrait générer une erreur. Nous devons effectuer une copie partagée de $sharedColl1 et désigner $sharedColl2 comme étant un groupe partagé pour la copie.
var $sharedColl1;$sharedColl2;$copyColl : Collection
$sharedColl1:=New shared collection(New shared object("lastname";"Smith"))
$sharedColl2:=New shared collection(New shared object("lastname";"Brown"))
//$copyColl appartient au nouveau groupe partagé comme $sharedColl2
$copyColl:=$sharedColl1.copy(ck shared;$sharedColl2)
Use($sharedColl2)
$sharedColl2.combine($copyColl)
End use
Exemple 3
Nous avons une collection standard ($lastnames) et nous souhaitons la placer dans le Storage de l'application. Pour ce faire, nous devons préalablement créer une copie partagée ($sharedLastnames).
var $lastnames;$sharedLastnames : Collection
var $text : Text
$text:=Document to text(Get 4D folder(Current resources folder)+"lastnames.txt")
$lastnames:=JSON Parse($text) //$lastnames est une collection standard
$sharedLastnames:=$lastnames.copy(ck shared) // copie partagée
Use(Storage)
Storage.lastnames:=$sharedLastnames
End use
Exemple 4
Cet exemple illustre l'utilisation de l'option ck resolve pointers
:
var $col : Collection
var $p : Pointer
$p:=->$what
$col:=New collection
$col.push(New object("alpha";"Hello";"num";1))
$col.push(New object("beta";"You";"what";$p))
$col2:=$col.copy()
$col2[1].beta:="World!"
ALERT($col[0].alpha+" "+$col2[1].beta) //affiche "Hello World!"
$what:="You!"
$col3:=$col2.copy(ck resolve pointers)
ALERT($col3[0].alpha+" "+$col3[1].what) //affiche "Hello You!"
.count()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.count( { propertyPath : Text } ) : Real
Paramètres | Type | Description | |
---|---|---|---|
propertyPath | Text | -> | Chemin de propriété d'objet à utiliser pour évaluer les valeurs |
Résultat | Real | <- | Nombre d'éléments dans la collection |
|
Description
La fonction .count()
retourne le nombre d'éléments non null dans la collection.
Si la collection contient des objets, vous pouvez passer le paramètre propertyPath. Dans ce cas, seuls les éléments qui contiennent le propertyPath sont comptabilisés.
Exemple
var $col : Collection
var $count1;$count2 : Real
$col:=New collection(20;30;Null;40)
$col.push(New object("name";"Smith";"salary";10000))
$col.push(New object("name";"Wesson";"salary";50000))
$col.push(New object("name";"Gross";"salary";10500))
$col.push(New object("lastName";"Henry";"salary";12000))
$count1:=$col.count() //$count1=7
$count2:=$col.count("name") //$count2=3
.countValues()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.countValues( value : any {; propertyPath : Text } ) : Real
Paramètres | Type | Description | |
---|---|---|---|
value | Text, Number, Boolean, Date, Object, Collection | -> | Valeur à compter |
propertyPath | Text | -> | Chemin de propriété d'objet à utiliser pour évaluer les valeurs |
Résultat | Real | <- | Nombre d'occurrences de la valeur |
|
Description
La fonction .countValues()
retourne le nombre d'occurrences de value dans la collection.
Vous pouvez passer dans value :
- une valeur scalaire (texte, numérique, booléen, date),
- une référence d'objet ou de collection.
Pour qu'un élément soit comptabilisé, le type de value doit être égal à celui de l'élément ; la fonction utilise l'opérateur d'égalité.
Le paramètre optionnel propertyPath vous permet de compter des valeurs à l'intérieur d'une collection d'objets : passez dans propertyPath le chemin de la propriété dont vous souhaitez comptabiliser le nombre de valeurs.
Cette fonction ne modifie pas la collection d'origine.
Exemple 1
var $col : Collection
var $vCount : Integer
$col:=New collection(1;2;5;5;5;3;6;4)
$vCount:=$col.countValues(5) // $vCount=3
Exemple 2
var $col : Collection
var $vCount : Integer
$col:=New collection
$col.push(New object("name";"Smith";"age";5))
$col.push(New object("name";"Wesson";"age";2))
$col.push(New object("name";"Jones";"age";3))
$col.push(New object("name";"Henry";"age";4))
$col.push(New object("name";"Gross";"age";5))
$vCount:=$col.countValues(5;"age") //$vCount=2
Exemple 3
var $numbers; $letters : Collection
var $vCount : Integer
$letters:=New collection("a";"b";"c")
$numbers:=New collection(1;2;$letters;3;4;5)
$vCount:=$numbers.countValues($letters) //$vCount=1
.distinct()
Historique
Release | Modifications |
---|---|
20 | Prise en charge de ck count values |
v16 R6 | Ajout |
.distinct( {options : Integer} ) : Collection
.distinct( propertyPath : Text {; options : Integer } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
propertyPath | Text | -> | Chemin de l'attribut dont vous souhaitez obtenir les valeurs distinctes |
options | Integer | -> | ck diacritical , ck count values |
Résultat | Collection | <- | Nouvelle collection contenant uniquement les valeurs distinctes |
|
Description
La fonction .distinct()
renvoie une collection contenant uniquement les valeurs distinctes (différentes) dans la collection d'origine.
Cette fonction ne modifie pas la collection d'origine.
La collection retournée est automatiquement triée. Les valeurs Null ne sont pas renvoyées.
Si la collection contient des objets, vous pouvez passer le paramètre propertyPath pour indiquer la propriété de l'objet dont vous souhaitez obtenir les valeurs distinctes.
Dans le paramètre options, vous pouvez passer une ou une combinaison des constantes suivantes :
Constante | Valeur | Commentaire |
---|---|---|
ck diacritical | 8 | L'évaluation est sensible à la casse et différencie les caractères accentués. Par défaut si omis, une évaluation non diacritique est effectuée |
ck count values | 32 | Renvoie le nombre d'éléments pour chaque valeur distincte. Lorsque cette option est activée, .distinct() renvoie une collection d'objets contenant une paire d'attributs {"value":*value* ; "count":*count*} . |
Exemples
var $c; $c2; $c3 : Collection
$c:=New collection
$c.push("a";"b";"c";"A";"B";"c";"b";"b")
$c.push(New object("size";1))
$c.push(New object("size";3))
$c.push(New object("size";1))
$c2:=$c.distinct() //$c2=["a","b","c",{"size":1},{"size":3},{"size":1}]
$c2:=$c.distinct(ck diacritical) //$c2=["a","A","b","B","c",{"size":1},{"size":3},{"size":1}]
$c2:=$c.distinct("size") //$c2=[1,3]
$c3:=$c.distinct("size";ck count values) //$c3=[{value:1,count:2},{value:3,count:1}]
.equal()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.equal( collection2 : Collection {; option : Integer } ) : Boolean
Paramètres | Type | Description | |
---|---|---|---|
collection2 | Collection | -> | Collection à comparer |
option | Integer | -> | ck diacritical : évaluation diacritique ("A" # "a" par exemple) |
Résultat | Boolean | <- | Vrai si les collections sont identiques, sinon faux |
|
Description
La fonction .equal()
compare la collection avec collection2 et retourne true si elles sont identiques (deep comparison).
- La fonction
.equal()
ne vérifie l'égalité que pour les éléments de type chaîne, booléen, nombre et null dans les collections. Elle ne vérifie pas l'égalité pour les objets natifs. - Les éléments avec des valeurs null ne sont pas égaux aux éléments Undefined.
Par défaut, une évaluation non diacritique est effectuée. Si vous souhaitez que l'évaluation soit sensible à la casse ou pour différencier des caractères accentués et non-accentués, passez la constante ck diacritical
dans le paramètre option.
Exemple
var $c; $c2 : Collection
var $b : Boolean
$c:=New collection(New object("a";1;"b";"orange");2;3)
$c2:=New collection(New object("a";1;"b";"orange");2;3;4)
$b:=$c.equal($c2) // false
$c:=New collection(New object("1";"a";"b";"orange");2;3)
$c2:=New collection(New object("a";1;"b";"orange");2;3)
$b:=$c.equal($c2) // false
$c:=New collection(New object("a";1;"b";"orange");2;3)
$c2:=New collection(New object("a";1;"b";"ORange");2;3)
$b:=$c.equal($c2) // true
$c:=New collection(New object("a";1;"b";"orange");2;3)
$c2:=New collection(New object("a";1;"b";"ORange");2;3)
$b:=$c.equal($c2;ck diacritical) //false
.every()
Historique
Release | Modifications |
---|---|
19 R6 | Prise en charge des formules |
v16 R6 | Ajout |
.every( { startFrom : Integer ; } formula : 4D.Function { ;...param : any } ) : Boolean
.every( { startFrom : Integer ; } methodName : Text { ;...param : any } ) : Boolean
Paramètres | Type | Description | |
---|---|---|---|
startFrom | Integer | -> | Elément à partir duquel débuter l'évaluation |
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
param | Mixed | -> | Paramètre(s) à passer à formula ou à methodName |
Résultat | Boolean | <- | Vrai si tous les éléments sont évalués à vrai |
|
Description
La fonction .every()
retourne true si tous les éléments de la collection ont réussi avec succès un test implémenté dans l'objet formule fourni ou la méthode methodName.
Vous désignez le code de rétroappel (callback) à exécuter pour évaluer les éléments de la collection en utilisant soit :
- formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
- methodName, le nom d'une méthode projet (texte).
La callback est appelée avec le(s) paramètre(s) passés dans param (facultatif). La callback peut effectuer n'importe quel test, avec ou sans le(s) paramètre(s) et doit retourner true pour chaque élément remplissant le test. Elle reçoit un objet
en premier paramètre ($1).
La callback reçoit les paramètres suivants :
- dans $1.value : valeur de l'élément à évaluer
- in $2: param
- in $N...: paramN...
Elle peut définir le(s) paramètre(s) suivant(s) :
- (obligatoire si vous avez utilisé une méthode) $1.result (booléen) : true si l'évaluation de la valeur de l'élément est à vrai, false sinon.
- $1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.
Dans tous les cas, lorsque la fonction .every()
rencontre le premier élément de collection évalué à false, elle cesse d'appeler la fonction de rétroappel et renvoie false.
Par défaut, .every()
évalue l'ensemble de la collection. Optionnellement, vous pouvez passer dans startFrom le numéro de l'élément auquel démarrer l'évaluation.
- Si startFrom >= la longueur de la collection, False est retourné, ce qui signifie que la collection n'est pas testée.
- Si startFrom < 0, la fin de la collection est considérée comme point de départ du calcul de la position( startFrom:=startFrom+length).
- Si startFrom = 0, l'ensemble de la collection est évalué (défaut).
Exemple 1
var $c : Collection
var $b : Boolean
var $f : 4D.Function
$f:=Formula($1.value>0)
$c:=New collection
$c.push(5;3;1;4;6;2)
$b:=$c.every($f) //retourne true
$c.push(-1)
$b:=$c.every($f) //retourne false
Exemple 2
Cet exemple vérifie que tous les éléments de la collection sont de type réel :
var $c : Collection
var $b : Boolean
var $f : 4D.Function
$f:=Formula(Value type($1.value)=$2
$c:=New collection
$c.push(5;3;1;4;6;2)
$b:=$c.every($f;Is real) //$b=true
$c:=$c.push(New object("name";"Cleveland";"zc";35049))
$c:=$c.push(New object("name";"Blountsville";"zc";35031))
$b:=$c.every($f;Is real) //$b=false
.extract()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.extract( propertyPath : Text { ; option : Integer } ) : Collection
.extract( propertyPath : Text ; targetPath : Text { ;...propertyPathOrTargetPathN : Text } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
propertyPath | Text | -> | Chemin de propriété d'objet dont les valeurs doivent être extraites dans la nouvelle collection |
targetpath | Text | -> | Chemin ou nom de propriété cible |
option | Integer | -> | ck keep null : inclure les propriétés null dans la collection retournée (ignorées par défaut). Paramètre ignoré si targetPath est passé. |
Résultat | Collection | <- | Nouvelle collection contenant les valeurs extraites |
|
Description
La fonction .extract()
crée et retourne une nouvelle collection contenant les valeurs de propertyPath extraites depuis la collection d'objets d'origine.
Cette fonction ne modifie pas la collection d'origine.
Le contenu de la collection retournée dépend du paramètre targetPath :
-
Si le paramètre targetPath est omis,
.extract()
remplit la nouvelle collection avec les valeurs de propertyPath de la collection d'origine.Par défaut, les éléments pour lesquels propertyPath est null ou undefined sont ignorés dans la collection résultante. Vous pouvez passer la constante
ck keep null
dans le paramètre option pour intégrer ces valeurs comme des éléments null dans la collection retournée. -
Si un ou plusieurs paramètres targetPath sont passés (correspondant à un ou plusieurs paramètres propertyPath ),
.extract()
remplit la nouvelle collection avec les propriétés propertyPath et chaque élément de la nouvelle collection est un objet avec des propriétés targetPath contenant les propriétés propertyPath correspondantes. Les valeurs null sont conservées (le paramètre option est ignoré avec cette syntaxe).
Exemple 1
var $c : Collection
$c:=New collection
$c.push(New object("name";"Cleveland"))
$c.push(New object("zip";5321))
$c.push(New object("name";"Blountsville"))
$c.push(42)
$c2:=$c.extract("name") // $c2=[Cleveland,Blountsville]
$c2:=$c.extract("name";ck keep null) //$c2=[Cleveland,null,Blountsville,null]
Exemple 2
var $c : Collection
$c:=New collection
$c.push(New object("zc";35060))
$c.push(New object("name";Null;"zc";35049))
$c.push(New object("name";"Cleveland";"zc";35049))
$c.push(New object("name";"Blountsville";"zc";35031))
$c.push(New object("name";"Adger";"zc";35006))
$c.push(New object("name";"Clanton";"zc";35046))
$c.push(New object("name";"Clanton";"zc";35045))
$c2:=$c.extract("name";"City") //$c2=[{City:null},{City:Cleveland},{City:Blountsville},{City:Adger},{City:Clanton},{City:Clanton}]
$c2:=$c.extract("name";"City";"zc";"Zip") //$c2=[{Zip:35060},{City:null,Zip:35049},{City:Cleveland,Zip:35049},{City:Blountsville,Zip:35031},{City:Adger,Zip:35006},{City:Clanton,Zip:35046},{City:Clanton,Zip:35045}]
.fill()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.fill( value : any ) : Collection
.fill( value : any ; startFrom : Integer { ; end : Integer } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
value | Number, Text, Object, Collection, Date, Boolean | -> | Valeur de remplissage |
startFrom | Integer | -> | Indice l'élément de départ (inclus) |
end | Integer | -> | Indice de fin (non inclus) |
Résultat | collection | <- | Collection d'origine avec valeurs de remplissage |
|
Description
La fonction .fill()
remplit les éléments de la collection avec value, optionnellement depuis l'élément startFrom et jusqu'à l'élément end (non inclus), et retourne la collection résultante.
Cette fonction modifie la collection d'origine.
- Si startFrom est omis, value est appliquée à tous les éléments de la collection (startFrom=0).
- Si startFrom est passé et end est omis, value est appliquée à tous les éléments de la collection à partir de startFrom jusqu'au dernier élément (end=length).
- Si les deux paramètres startFrom et end sont passés, value est appliquée aux éléments de la collection à partie de startFrom jusqu'à l'élément end.
En cas d'incohérence, les règles suivantes sont appliquées :
- Si startFrom < 0, le paramètre est recalculé comme startFrom:=startFrom+length (la fin de la collection est considérée comme point de départ du calcul de la position). Si la valeur recalculée est négative, startFrom prend la valeur 0.
- Si end < 0 , le paramètre est recalculé comme end:=end+length.
- Si end < startFrom (valeurs passées ou recalculées), la fonction ne fait rien.
Exemple
var $c : Collection
$c:=New collection(1;2;3;"Lemon";Null;"";4;5)
$c.fill("2") // $c:=[2,2,2,2,2,2,2,2]
$c.fill("Hello";5) // $c=[2,2,2,2,2,Hello,Hello,Hello]
$c.fill(0;1;5) // $c=[2,0,0,0,0,Hello,Hello,Hello]
$c.fill("world";1;-5) //-5+8=3 -> $c=[2,"world","world",0,0,Hello,Hello,Hello]
.filter()
Historique
Release | Modifications |
---|---|
19 R6 | Prise en charge des formules |
v16 R6 | Ajout |
.filter( formula : 4D.Function { ; ...param : any } ) : Collection
.filter( methodName : Text { ; ...param : any } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
param | any | -> | Paramètre(s) à passer à formula ou à methodName |
Résultat | Collection | <- | Nouvelle collection contenant les éléments filtrés (shallow copy) |
|
Description
La fonction .filter()
retourne une nouvelle collection contenant tous les éléments de la collection d'origine pour lesquels le résultat de formula ou methodName est true. Cette fonction retourne une shallow copy (copie superficielle), ce qui signifie que les objets ou les collections présents dans les deux collections partagent la même référence. Si la collection d'origine est une collection partagée, la collection retournée est également une collection partagée.
Cette fonction ne modifie pas la collection d'origine.
Vous désignez le code de rétroappel (callback) à exécuter pour filtrer les éléments de la collection en utilisant soit :
- formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
- methodName, le nom d'une méthode projet (texte).
Vous pouvez fournir des paramètres extraParam à la callback si nécessaire. Dans la callback, passez votre code qui compare deux valeurs et retourne true si la première valeur est inférieure à la seconde valeur.
La callback reçoit les paramètres suivants :
- dans $1.value : valeur de l'élément à évaluer
- in $2: param
- in $N...: paramN...
Elle peut définir le(s) paramètre(s) suivant(s) :
- $1.result (booléen) : true si l'élément doit être conservé car sa la valeur correspond à la condition du filtre, false sinon.
- $1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.
Lorsque vous utilisez methodName comme callback, et si la méthode ne renvoie aucune valeur, .filter()
recherchera la propriété $1.result que vous devez définir à true pour chaque élément remplissant la condition.
Exemple 1
Vous voulez obtenir la collection des éléments de type texte dont la longueur est inférieure à 6 :
var $col;$colNew : Collection
$col:=New collection("hello";"world";"red horse";66;"tim";"san jose";"miami")
$colNew:=$col.filter(Formula((Value type($1.value)=Is text) && (Length($1.value)<$2)); 6)
//$colNew=["hello","world","tim","miami"]
Exemple 2
Vous voulez filtrer les éléments de la collection en fonction de leur type :
var $c;$c2;$c3 : Collection
var $f : 4D.Function
$f:=Formula(OB Get type($1;"value")=$2)
$c:=New collection(5;3;1;4;6;2)
$c.push(New object("name";"Cleveland";"zc";35049))
$c.push(New object("name";"Blountsville";"zc";35031))
$c2:=$c.filter($f;Is real) // $c2=[5,3,1,4,6,2]
$c3:=$c.filter($f;Is object)
// $c3=[{name:Cleveland,zc:35049},{name:Blountsville,zc:35031}]
.find()
Historique
Release | Modifications |
---|---|
19 R6 | Prise en charge des formules |
v16 R6 | Ajout |
.find( { startFrom : Integer ; } formula : 4D.Function { ; ...param : any } ) : any
.find( { startFrom : Integer ; } methodName : Text { ; ...param : any } ) : any
Paramètres | Type | Description | |
---|---|---|---|
startFrom | Integer | -> | Elément à partir duquel débuter la recherche |
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
param | any | -> | Paramètre(s) à passer à formula ou à methodName |
Résultat | any | <- | Première valeur trouvée (Undefined si non trouvée) |
|
Description
La fonction find()
retourne la première valeur dans la collection pour laquelle le résultat de formula ou methodName retourne true.
Cette fonction ne modifie pas la collection d'origine.
Vous désignez le code de rétroappel (callback) à exécuter pour évaluer les éléments de la collection en utilisant soit :
- formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
- methodName, le nom d'une méthode projet (texte).
La callback est appelée avec le(s) paramètre(s) passés dans param (facultatif). La callback peut effectuer n'importe quel test, avec ou sans le(s) paramètre(s) et doit retourner true pour le premier élément remplissant le test. Elle reçoit un objet
en premier paramètre ($1).
La callback reçoit les paramètres suivants :
- dans $1.value : valeur de l'élément à évaluer
- in $2: param
- in $N...: paramN...
Elle peut définir le(s) paramètre(s) suivant(s) :
- (obligatoire si vous avez utilisé une méthode) $1.result (booléen) : true si la valeur de l'élément correspond à la condition de recherche, false sinon.
- $1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.
Par défaut, .find()
effectue une recherche dans la totalité de la collection. Optionnellement, vous pouvez passer dans startFrom le numéro de l'élément auquel démarrer la recherche.
- Si startFrom >= la longueur de la collection, -1 est retourné, ce qui signifie que la recherche n'est pas effectuée.
- Si startFrom < 0, la fin de la collection est considérée comme point de départ du calcul de la position (startFrom:=startFrom+length). Note : Même si startFrom est négatif, la recherche est effectuée de la gauche vers la droite.
- Si startFrom = 0, l'ensemble de la collection est évalué (défaut).
Exemple 1
Vous souhaitez obtenir le premier élément de texte dont la taille est inférieure à 5 caractères :
var $col : Collection
$col:=New collection("hello";"world";4;"red horse";"tim";"san jose")
$value:=$col.find(Formula((Value type($1.value)=Is text) && (Length($1.value)<$2)); 5) //$value="tim"
Exemple 2
Vous souhaitez trouver un nom de ville dans une collection :
var $c : Collection
var $c2 : Object
$c:=New collection
$c.push(New object("name"; "Cleveland"; "zc"; 35049))
$c.push(New object("name"; "Blountsville"; "zc"; 35031))
$c.push(New object("name"; "Adger"; "zc"; 35006))
$c.push(New object("name"; "Clanton"; "zc"; 35046))
$c.push(New object("name"; "Clanton"; "zc"; 35045))
$c2:=$c.find(Formula($1.value.name=$2); "Clanton") //$c2={name:Clanton,zc:35046}
.findIndex()
Historique
Release | Modifications |
---|---|
19 R6 | Prise en charge des formules |
v16 R6 | Ajout |
.findIndex( { startFrom : Integer ; } formula : 4D.Function { ; ...param : any } ) : Integer
.findIndex( { startFrom : Integer ; } methodName : Text { ; ...param : any } ) : Integer
Paramètres | Type | Description | |
---|---|---|---|
startFrom | Integer | -> | Elément à partir duquel débuter la recherche |
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
param | any | -> | Paramètre(s) à passer à formula ou à methodName |
Résultat | Integer | <- | Numéro du premier élément trouvé (-1 si non trouvé) |
|
Description
La fonction .findIndex()
retourne le numéro, dans la collection, du premier élément pour lequel formula ou methodName retourne true.
Cette fonction ne modifie pas la collection d'origine.
Vous désignez le code de rétroappel (callback) à exécuter pour évaluer les éléments de la collection en utilisant soit :
- formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
- methodName, le nom d'une méthode projet (texte).
La callback est appelée avec le(s) paramètre(s) passés dans param (facultatif). La callback peut effectuer n'importe quel test, avec ou sans le(s) paramètre(s) et doit retourner true pour le premier élément remplissant le test. Elle reçoit un objet
en premier paramètre ($1).
La callback reçoit les paramètres suivants :
- dans $1.value : valeur de l'élément à évaluer
- in $2: param
- in $N...: paramN...
Elle peut définir le(s) paramètre(s) suivant(s) :
- (obligatoire si vous avez utilisé une méthode) $1.result (booléen) : true si la valeur de l'élément correspond à la condition de recherche, false sinon.
- $1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.
Par défaut, .findIndex()
effectue une recherche dans la totalité de la collection. Optionnellement, vous pouvez passer dans startFrom le numéro de l'élément auquel démarrer la recherche.
- Si startFrom >= la longueur de la collection, -1 est retourné, ce qui signifie que la recherche n'est pas effectuée.
- Si startFrom < 0, la fin de la collection est considérée comme point de départ du calcul de la position (startFrom:=startFrom+length). Note : Même si startFrom est négatif, la recherche est effectuée de la gauche vers la droite.
- Si startFrom = 0, l'ensemble de la collection est évalué (défaut).
Exemple
Vous souhaitez trouver la position du premier nom de ville dans la collection :
var $c : Collection
var $val2;$val3 : Integer
$c:=New collection
$c.push(New object("name";"Cleveland";"zc";35049))
$c.push(New object("name";"Blountsville";"zc";35031))
$c.push(New object("name";"Adger";"zc";35006))
$c.push(New object("name";"Clanton";"zc";35046))
$c.push(New object("name";"Clanton";"zc";35045))
$val2:=$c.findIndex(Formula($1.value.name=$2);"Clanton") // $val2=3
$val3:=$c.findIndex($val2+1;Formula($1.value.name=$2);"Clanton") //$val3=4
.first()
Historique
Release | Modifications |
---|---|
20 | Ajout |
.first() : any
Paramètres | Type | Description | |
---|---|---|---|
Résultat | any | <- | Premier élément de collection |
|
Description
La fonction .first()
renvoie le premier élément de la collection.
Cette fonction ne modifie pas la collection d'origine.
La fonction renvoie Undefined si la collection est vide.
Exemple
var $col; $emptyCol : Collection
var $first : Variant
$col:=New collection(10; 20; 30; "hello"; 50)
$first:=$col.first() // 10
$emptyCol:=New collection() //vide
// $first:=$emptyCol[0] //retournerait une erreur
$first:=$emptyCol.first() // retourne Undefined
.flat()
Historique
Release | Modifications |
---|---|
20 | Ajout |
.flat( { depth : Integer } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
depth | Integer | -> | La profondeur à laquelle une structure de collection imbriquée doit être mise à plat. Par défaut=1 |
Résultat | Collection | <- | Collection mise à plat |
|
Description
La fonction .flat()
crée une nouvelle collection dans laquelle tous les éléments de sous-collections sont concaténés de manière récursive jusqu'à la profondeur depth spécifiée.
Par défaut, si le paramètre depth est omis, seul le premier niveau de la structure de la collection imbriquée sera mis à plat.
Cette fonction ne modifie pas la collection d'origine.
Exemple
$col:=New collection(1; 2; New collection(3; 4))
$col.flat()
// [1, 2, 3, 4]
$col:=New collection(1; 2; New collection(3; 4; New collection(5; 6)))
$col.flat()
// [1, 2, 3, 4, [5, 6]]
$col:=New collection(1; 2; New collection(3; 4; New collection(5; 6)))
$col.flat(2)
// [1, 2, 3, 4, 5, 6]
$col:=New collection(1; 2; New collection(3; 4; 5; 6; New collection(7; 8; New collection(9; 10))))
$col.flat(MAXLONG)
// [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
.flatMap()
Historique
Release | Modifications |
---|---|
20 | Ajout |
.flatMap( formula : 4D.Function { ; ...param : any } ) : Collection
.flatMap( methodName : Text { ; ...param : any } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
param | any | -> | Paramètre(s) à passer à formula ou à methodName |
Résultat | Collection | <- | Collection de valeurs transformées et mises à plat sur une profondeur de 1 |
|
Description
La fonction .flatMap()
crée une nouvelle collection basée sur le résultat de l'appel de la fonction 4D formula ou de la méthode methodName sur chaque élément de la collection originale et mise à plat sur une profondeur de 1. Optionnellement, vous pouvez passer un ou plusieurs paramètre(s) à formula ou methodName via le paramètre param.
Cette fonction est identique à un appel à map()
suivi d'un appel à flat()
de profondeur 1.
Cette fonction ne modifie pas la collection d'origine.
Vous désignez le code de rétroappel (callback) à exécuter pour évaluer les éléments de la collection en utilisant soit :
- formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
- methodName, le nom d'une méthode projet (texte).
La callback est appelée avec le(s) paramètre(s) passés dans param (facultatif). La callback peut effectuer n'importe quelle opération, avec ou sans le(s) paramètre(s), et doit renvoyer une nouvelle valeur transformée à ajouter à la collection résultante. Elle reçoit un objet
en premier paramètre ($1).
La callback reçoit les paramètres suivants :
- dans $1.value : valeur de l'élément à évaluer
- in $2: param
- in $N...: paramN...
Elle peut définir le(s) paramètre(s) suivant(s) :
- (obligatoire si vous avez utilisé une méthode) $1.result (n'importe quel type) : nouvelle valeur transformée à ajouter à la collection résultante
- $1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.
Exemple 1
var $col ; $result : Collection
$col:=New collection(1; 2; 3; 4)
$result:=$col.map(Formula(New collection($1.value*2))
// [[2],[4],[6],[8]]
$result:=$col.flatMap(Formula(New collection($1.value*2))
// [2,4,6,8]
Exemple 2
var $col; $result : Collection
$col:=New collection("Hello how"; ""; "are you ?")
$result:=$col.map(Formula(Split string($1.value; " ")))
// [["Hello", "how"], [], ["are", "you", "?"]]
$result:=$col.flatMap(Formula(Split string($1.value; " ")))
// ["Hello", "how", "are", "you", "?"]
Exemple 3
Vous souhaitez calculer le pourcentage de chaque valeur de la collection par rapport au total :
var $c; $c2 : Collection
var $f : 4D.Function
$c:=New collection(1; 4; 9; 10; 20)
$f:=Formula(New collection($1.value;Round(($1.value/$2)*100; 2)))
$c2:=$c.flatMap($f; $c.sum())
//$c2=[1, 2.27, 4, 9.09,9, 20.45,10, 22.73, 20, 45.45]
.includes()
Historique
Release | Modifications |
---|---|
20 | Ajout |
.includes( toSearch : expression { ; startFrom : Integer } ) : Boolean
Paramètres | Type | Description | |
---|---|---|---|
toSearch | expression | -> | Expression à rechercher dans la collection |
startFrom | Integer | -> | Elément à partir duquel débuter la recherche |
Résultat | Boolean | <- | True si toSearch est trouvé dans la collection |
|
Description
La fonction .includes()
renvoie True si l'expression toSearch est trouvée parmi les éléments de la collection, sinon False.
Cette fonction ne modifie pas la collection d'origine.
Dans toSearch, passez l'expression à rechercher dans la collection. Vous pouvez passer :
- une valeur scalaire (texte, numérique, booléen, date),
- la valeur null,
- une référence d'objet ou de collection.
toSearch doit correspondre exactement à l'élément recherché (les mêmes règles que pour l'opérateur d'égalité sont appliquées).
Optionnellement, vous pouvez passer le numéro de l'élément auquel démarrer la recherche dans startFrom.
- Si startFrom >= la longueur de la collection, False est retourné, ce qui signifie que la collection n'est pas testée.
- Si startFrom < 0, la fin de la collection est considérée comme point de départ du calcul de la position (startFrom:=startFrom+length). Notez que même si startFrom est négatif, la recherche est effectuée de la gauche vers la droite.
- Si startFrom = 0, l'ensemble de la collection est évalué (défaut).
Exemple
var $col : Collection
var $in : Boolean
var $obj : Object
$obj:=New object("value"; 10)
$col:=New collection(1;2;"Henry";5;3;"Albert";6;4;"Alan";5;$obj)
$in:=$col.includes(3) //True
$in:=$col.includes(5;6) //True
$in:=$col.includes("al@") //True
$in:=$col.includes("Hello") //False
$in:=$col.includes($obj) //True
$in:=$col.includes(New object("value"; 10)) //False
.indexOf()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.indexOf( toSearch : expression { ; startFrom : Integer } ) : Integer
Paramètres | Type | Description | |
---|---|---|---|
toSearch | expression | -> | Expression à rechercher dans la collection |
startFrom | Integer | -> | Elément à partir duquel débuter la recherche |
Résultat | Integer | <- | Numéro de la première occurrence de toSearch dans la collection, -1 si non trouvée |
|
Description
La fonction .indexOf()
recherche l'expression toSearch parmi les éléments de la collection et retourne le numéro d'élément de la première occurrence trouvée, ou -1 si aucune occurrence n'a été trouvée.
Cette fonction ne modifie pas la collection d'origine.
Dans toSearch, passez l'expression à rechercher dans la collection. Vous pouvez passer :
- une valeur scalaire (texte, numérique, booléen, date),
- la valeur null,
- une référence d'objet ou de collection.
toSearch doit correspondre exactement à l'élément recherché (les mêmes règles que pour l'opérateur d'égalité sont appliquées).
Optionnellement, vous pouvez passer le numéro de l'élément auquel démarrer la recherche dans startFrom.
- Si startFrom >= la longueur de la collection, -1 est retourné, ce qui signifie que la recherche n'est pas effectuée.
- Si startFrom < 0, la fin de la collection est considérée comme point de départ du calcul de la position (startFrom:=startFrom+length). Note : Même si startFrom est négatif, la recherche est effectuée de la gauche vers la droite.
- Si startFrom = 0, l'ensemble de la collection est évalué (défaut).
Exemple
var $col : Collection
var $i : Integer
$col:=New collection(1;2;"Henry";5;3;"Albert";6;4;"Alan";5)
$i:=$col.indexOf(3) //$i=4
$i:=$col.indexOf(5;5) //$i=9
$i:=$col.indexOf("al@") //$i=5
$i:=$col.indexOf("Hello") //$i=-1
.indices()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.indices( queryString : Text { ; ...value : any } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
queryString | Text | -> | Critère(s) de recherche |
value | any | -> | Valeur(s) à comparer lors de l'utilisation de paramètre(s) dans la chaîne |
Résultat | Collection | <- | Numéro(s) d'élément(s) de la collection répondant au(x) critère(s) de recherche |
|
Description
La fonction .indices()
fonctionne exactement comme .query()
mais retourne les positions, dans la collection d'origine, des éléments répondant au(x) critère(s) de recherche de queryString, et non les éléments eux-mêmes. Les positions sont retournées dans un ordre croissant.
Cette fonction ne modifie pas la collection d'origine.
Le paramètre queryString doit respecter la syntaxe suivante :
propertyPath comparator value {logicalOperator propertyPath comparator value}
Pour une description détaillée de la construction de recherches à l'aide des paramètres queryString et value veuillez vous reporter à la description de la fonction dataclass.query()
.
Exemple
var $c; $icol : Collection
$c:=New collection
$c.push(New object("name";"Cleveland";"zc";35049))
$c.push(New object("name";"Blountsville";"zc";35031))
$c.push(New object("name";"Adger";"zc";35006))
$c.push(New object("name";"Clanton";"zc";35046))
$c.push(New object("name";"Clanton";"zc";35045))
$icol:=$c.indices("name = :1";"Cleveland") // $icol=[0]
$icol:=$c.indices("zc > 35040") // $icol=[0,3,4]
.insert()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.insert( index : Integer ; element : any ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
index | Integer | -> | Où insérer l'élément |
element | any | -> | Elément à insérer dans la collection |
Résultat | Collection | <- | Collection d'origine incluant l'élément inséré |
|
Description
La fonction .insert()
insère les éléments de element à la position index de la collection et retourne la collection modifiée.
Cette fonction modifie la collection d'origine.
Dans index, passez le numéro de l'élément après lequel vous souhaitez que le paramètre element soit inséré.
Attention : N'oubliez pas que la numérotation des éléments de collection débute à 0.
- Si index > la longueur de la collection, l'index de départ réel sera fixé à la longueur de la collection.
- Si index < 0, il est recalculé comme index:=index+length (la fin de la collection est considérée comme point de départ du calcul de la position).
- Si la valeur recalculée est négative, index prend la valeur 0.
Vous pouvez passer tout type d'élément accepté par les collections, y compris une autre collection.
Exemple
var $col : Collection
$col:=New collection("a";"b";"c";"d") //$col=["a","b","c","d"]
$col.insert(2;"X") //$col=["a","b","X","c","d"]
$col.insert(-2;"Y") //$col=["a","b","X","Y","c","d"]
$col.insert(-10;"Hi") //$col=["Hi","a","b","X","Y","c","d"]
.join()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.join( delimiter : Text { ; option : Integer } ) : Text
Paramètres | Type | Description | |
---|---|---|---|
delimiter | Text | -> | Séparateur à utiliser entre les éléments |
option | Integer | -> | ck ignore null or empty : ignorer les chaînes null ou vides dans le résultat |
Résultat | Text | <- | Chaîne contenant tous les éléments de la collection, séparés par delimiter |
|
Description
La fonction .concat()
retourne une nouvelle collection avec le contenu du paramètre value ajouté à la fin de la collection d'origine. La fonction retourne la chaîne résultante.
Cette fonction ne modifie pas la collection d'origine.
Par défaut, les éléments null ou vides de la collection sont inclus dans la chaîne résultante. Passez la constante ck ignore null or empty
dans le paramètre option si vous souhaitez les exclure de la chaîne résultante.
Exemple
var $c : Collection
var $t1;$t2 : Text
$c:=New collection(1;2;3;"Paris";Null;"";4;5)
$t1:=$c.join("|") //1|2|3|Paris|null||4|5
$t2:=$c.join("|";ck ignore null or empty) //1|2|3|Paris|4|5
.last()
Historique
Release | Modifications |
---|---|
20 | Ajout |
.last() : any
Paramètres | Type | Description | |
---|---|---|---|
Résultat | any | <- | Dernier élément de collection |
|
Description
La fonction .last()
renvoie le dernier élément de la collection.
Cette fonction ne modifie pas la collection d'origine.
La fonction renvoie Undefined si la collection est vide.
Exemple
var $col; $emptyCol : Collection
var $last : Variant
$col:=New collection(10; 20; 30; "hello"; 50)
$last:=$col.last() // 50
$emptyCol:=New collection() //vide
// $last:=$emptyCol[$emptyCol.length-1] //retournerait une erreur
$last:=$emptyCol.last() // retourne Undefined
.lastIndexOf()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.lastIndexOf( toSearch : expression { ; startFrom : Integer } ) : Integer
Paramètres | Type | Description | |
---|---|---|---|
toSearch | expression | -> | Elément à chercher dans la collection |
startFrom | Integer | -> | Elément à partir duquel débuter la recherche |
Résultat | Integer | <- | Numéro de la dernière occurrence de toSearch dans la collection, -1 si non trouvé |
|
Description
La fonction .lastIndexOf()
recherche l'expression toSearch parmi les éléments de la collection et retourne le numéro d'élément de la dernière occurrence trouvée, ou -1 si aucune occurrence n'a été trouvée.
Cette fonction ne modifie pas la collection d'origine.
Dans toSearch, passez l'expression à rechercher dans la collection. Vous pouvez passer :
- une valeur scalaire (texte, numérique, booléen, date),
- la valeur null,
- une référence d'objet ou de collection.
toSearch doit correspondre exactement à l'élément recherché (les mêmes règles que pour l'opérateur d'égalité sont appliquées).
Optionnellement, vous pouvez passer le numéro de l'élément auquel démarrer la recherche inversée dans startFrom.
- Si startFrom >= taille de la collection (coll.length-1), l'ensemble de la collection est évalué (défaut).
- Si startFrom < 0, le paramètre est recalculé comme startFrom:=startFrom+length (la fin de la collection est considérée comme point de départ du calcul de la position). Si la position calculée est négative, -1 est retourné (la collection n'est pas évaluée). Note : Même si startFrom est négatif, la recherche est effectuée de la droite vers la gauche.
- Si startFrom = 0, -1 est retourné, ce qui signifie que la recherche n'est pas effectuée.
Exemple
var $col : Collection
var $pos1;$pos2;$pos3;$pos4;$pos5 : Integer
$col:=Split string("a,b,c,d,e,f,g,h,i,j,e,k,e";",") //$col.length=13
$pos1:=$col.lastIndexOf("e") //retourne 12
$pos2:=$col.lastIndexOf("e";6) //retourne 4
$pos3:=$col.lastIndexOf("e";15) //retourne 12
$pos4:=$col.lastIndexOf("e";-2) //retourne 10
$pos5:=$col.lastIndexOf("x") //retourne -1
.length
Historique
Release | Modifications |
---|---|
v16 R5 | Ajout |
.length : Integer
Description
La propriété .length
retourne le nombre d'éléments dans la collection.
La propriété .length
est initialisée à la création de la collection. Elle est automatiquement mise à jour en cas d'ajout ou de suppression d'éléments. Cette propriété est en lecture seulement (vous ne pouvez pas l'utiliser pour modifier la taille de la collection).
Exemple
var $col : Collection //$col.length est initialisée à 0
$col:=New collection("one";"two";"three") //$col.length est mise à jour et vaut 3
$col[4]:="five" //$col.length vaut 5
$vSize:=$col.remove(0;3).length //$vSize=2
.map()
Historique
Release | Modifications |
---|---|
19 R6 | Prise en charge des formules |
v16 R6 | Ajout |
.map( formula : 4D.Function { ; ...param : any } ) : Collection
.map( methodName : Text { ; ...param : any } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
param | any | -> | Paramètre(s) à passer à formula ou à methodName |
Résultat | Collection | <- | Collection de valeurs transformées |
|
Description
La fonction .map()
crée une nouvelle collection basée sur le résultat de l'exécution de la fonction 4D formula ou de la méthode methodName sur chaque élément de la collection d'origine. Optionnellement, vous pouvez passer un ou plusieurs paramètre(s) à formula ou methodName via le paramètre param. .map()
renvoie toujours une collection de la même taille que la collection originale, sauf si $1.stop a été utilisé (voir ci-dessous).
Cette fonction ne modifie pas la collection d'origine.
Vous désignez le code de rétroappel (callback) à exécuter pour évaluer les éléments de la collection en utilisant soit :
- formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
- methodName, le nom d'une méthode projet (texte).
La callback est appelée avec le(s) paramètre(s) passés dans param (facultatif). La callback peut effectuer n'importe quelle opération, avec ou sans le(s) paramètre(s), et doit renvoyer une nouvelle valeur transformée à ajouter à la collection résultante. Elle reçoit un objet
en premier paramètre ($1).
La callback reçoit les paramètres suivants :
- dans $1.value : valeur de l'élément à évaluer
- in $2: param
- in $N...: paramN...
Elle peut définir le(s) paramètre(s) suivant(s) :
- (obligatoire si vous avez utilisé une méthode) $1.result (n'importe quel type) : nouvelle valeur transformée à ajouter à la collection résultante
- $1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.
Exemple
var $c; $c2 : Collection
$c:=New collection(1; 4; 9; 10; 20)
$c2:=$c.map(Formula(Round(($1.value/$2)*100; 2)); $c.sum())
//$c2=[2.27,9.09,20.45,22.73,45.45]
.max()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.max( { propertyPath : Text } ) : any
Paramètres | Type | Description | |
---|---|---|---|
propertyPath | Text | -> | Chemin de propriété d'objet à utiliser pour évaluer les valeurs |
Résultat | Boolean, Text, Number, Collection, Object, Date | <- | Valeur maximum de la collection |
|
Description
La fonction .max()
retourne l'élément de la collection ayant la valeur la plus élevée (le dernier élément de la collection si était triée par ordre croissant à l'aide de la fonction .sort()
).
Cette fonction ne modifie pas la collection d'origine.
Si la collection contient différents types de valeurs, la fonction .max()
retournera la plus grande valeur du dernier type d'élément dans l'ordre de la liste de types (cf. description de .sort()
).
Si la collection contient des objets, passez le paramètre propertyPath pour indiquer la propriété d'objet dont vous souhaitez obtenir la valeur maximale.
Si la collection est vide, .max()
retourne Undefined.
Exemple
var $col : Collection
$col:=New collection(200;150;55)
$col.push(New object("name";"Smith";"salary";10000))
$col.push(New object("name";"Wesson";"salary";50000))
$col.push(New object("name";"Alabama";"salary";10500))
$max:=$col.max() //{name:Alabama,salary:10500}
$maxSal:=$col.max("salary") //50000
$maxName:=$col.max("name") //"Wesson"
.min()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.min( { propertyPath : Text } ) : any
Paramètres | Type | Description | |
---|---|---|---|
propertyPath | Text | -> | Chemin de propriété d'objet à utiliser pour évaluer les valeurs |
Résultat | Boolean, Text, Number, Collection, Object, Date | <- | Valeur minimum de la collection |
|
Description
La fonction min()
retourne l'élément de la collection ayant la valeur la plus petite (le premier élément de la collection si était triée par ordre croissant à l'aide de la fonction .sort()
).
Cette fonction ne modifie pas la collection d'origine.
Si la collection contient différents types de valeurs, la fonction .min()
retournera la plus petite valeur du premier type d'élément dans l'ordre de la liste de types (cf. description de .sort()
).
Si la collection contient des objets, passez le paramètre propertyPath pour indiquer la propriété d'objet dont vous souhaitez obtenir la valeur minimum.
Si la collection est vide, .min()
retourne Undefined.
Exemple
var $col : Collection
$col:=New collection(200;150;55)
$col.push(New object("name";"Smith";"salary";10000))
$col.push(New object("name";"Wesson";"salary";50000))
$col.push(New object("name";"Alabama";"salary";10500))
$min:=$col.min() //55
$minSal:=$col.min("salary") //10000
$minName:=$col.min("name") //"Alabama"
.orderBy()
Historique
Release | Modifications |
---|---|
v16 R6 | Ajout |
.orderBy( ) : Collection
.orderBy( pathStrings : Text ) : Collection
.orderBy( pathObjects : Collection ) : Collection
.orderBy( ascOrDesc : Integer ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
pathStrings | Text | -> | Chemin(s) de propriété(s) à utiliser pour trier la collection |
pathObjects | Collection | -> | Collection d'objets critère |
ascOrDesc | Integer | -> | ck ascending ou ck descending (valeurs scalaires) |
Résultat | Collection | <- | Copiée triée de la collection (shallow copy) |
|
Description
La fonction .orderBy()
retourne une nouvelle collection contenant tous les éléments de la collection d'origine triés selon les critères définis.
Cette fonction retourne uneshallow copy (copie superficielle), ce qui signifie que les objets ou les collections présents dans les deux collections partagent la même référence. Si la collection d'origine est une collection partagée, la collection retournée est également une collection partagée.
Cette fonction ne modifie pas la collection d'origine.
Si vous ne passez aucun paramètre, la fonction classe les valeurs scalaires de la collection dans un ordre croissant (les autres types d'éléments tels que les objets ou les collections sont renvoyés avec un ordre interne). Vous pouvez modifier ce tri automatique par défaut en passant la constante ck ascending
ou ck descending
dans le paramètre ascOrDesc (voir ci-dessous).
Vous pouvez également passer des critères afin de configurer le tri des éléments de la collection. Trois syntaxes sont prises en charge pour ce paramètre :
-
pathStrings : Texte (formule). Syntaxe :
propertyPath1 {desc ou asc}, propertyPath2 {desc ou asc},...
(défaut : asc). pathStrings contient une formule constituée de 1 à N chemin(s) de propriété(s) et (optionnellement) ordres de tri, séparés par des virgules. L'ordre dans lequel les propriétés sont passées détermine la priorité de tri des éléments de la collection. Par défaut, les propriétés sont triées pas ordre croissant. Vous pouvez définir l'ordre de tri de chaque propriété dans la formule de critère, séparée du chemin de propriété par un simple espace : passez "asc" pour trier par ordre croissant ou "desc" pour un ordre décroissant. -
pathObjects : Collection. Vous pouvez ajouter autant d'objets dans la collection pathObjects que nécessaire. Par défaut, les propriétés sont triées par ordre croissant ("descending" est faux). Chaque élément de la collection contient un objet structuré de la manière suivante :
{
"propertyPath": string,
"descending": boolean
}
-
ascOrDesc : Integer. Passez une des constantes suivantes du thème Objets et collections :
Constante Type Valeur Commentaire ck ascending Longint 0 Les éléments sont triés par ordre croissant (défaut) ck descending Longint 1 Les éléments sont triés par ordre décroissant Cette syntaxe trie uniquement les valeurs scalaires de la collection (les autres types d'éléments comme les objets ou les collections sont retournés non triés).
Si la collection contient des éléments de différents types, ils sont d'abord groupés par type et triés par la suite. Les types sont renvoyés dans l'ordre suivant :
- Null
- booléens
- chaînes
- nombres
- objets
- collections
- dates
Exemple 1
Tri d'une collection de nombres par ordre croissant ou décroissant :
var $c; $c2; $c3 : Collection
$c:=New collection
For($vCounter;1;10)
$c.push(Random)
End for
$c2:=$c.orderBy(ck ascending)
$c3:=$c.orderBy(ck descending)
Exemple 2
Tri d'une collection d'objets basé sur une formule de texte avec noms de propriétés :
var $c; $c2 : Collection
$c:=New collection
For($vCounter;1;10)
$c.push(New object("id";$vCounter;"value";Random))
End for
$c2:=$c.orderBy("value desc")
$c2:=$c.orderBy("value desc, id")
$c2:=$c.orderBy("value desc, id asc")
Tri d'une collection d'objets sur des propriétés :
var $c; $c2 : Collection
$c:=New collection
$c.push(New object("name";"Cleveland";"phones";New object("p1";"01";"p2";"02")))
$c.push(New object("name";"Blountsville";"phones";New object("p1";"00";"p2";"03")))
$c2:=$c.orderBy("phones.p1 asc")
Exemple 3
Tri d'une collection d'objets via une collection d'objets critères :
var $crit; $c; $c2 : COllection
$crit:=New collection
$c:=New collection
For($vCounter;1;10)
$c.push(New object("id";$vCounter;"value";Random))
End for
$crit.push(New object("propertyPath";"value";"descending";True))
$crit.push(New object("propertyPath";"id";"descending";False))
$c2:=$c.orderBy($crit)
Tri avec un chemin de propriété :
var $crit; $c; $c2 : Collection
$c:=New collection
$c.push(New object("name";"Cleveland";"phones";New object("p1";"01";"p2";"02")))
$c.push(New object("name";"Blountsville";"phones";New object("p1";"00";"p2";"03")))
$crit:=New collection(New object("propertyPath";"phones.p2";"descending";True))
$c2:=$c.orderBy($crit)
.orderByMethod()
Historique
Release | Modifications |
---|---|
19 R6 | Prise en charge des formules |
v16 R6 | Ajout |
.orderByMethod( formula : 4D.Function { ; ...extraParam : expression } ) : Collection
.orderByMethod( methodName : Text { ; ...extraParam : expression } ) : Collection
Paramètres | Type | Description | |
---|---|---|---|
formula | 4D.Function | -> | Objet formule |
methodName | Text | -> | Nom de méthode |
extraParam | any | -> | Paramètre(s) à passer |
Résultat | Collection | <- | Copie triée de la collection (shallow copy) |
|
Description
La fonction .orderByMethod()
retourne une nouvelle collection contenant tous les éléments de la collection d'origine triés selon les critères définis par la fonction 4D formula 4D function ou la méthode methodName.
Cette fonction retourne uneshallow copy (copie superficielle), ce qui signifie que les objets ou les collections présents dans les deux collections partagent la même référence. Si la collection d'origine est une collection partagée, la collection retournée est également une collection partagée.
Cette fonction ne modifie pas la collection d'origine.
Vous désignez le code de rétroappel (callback) à exécuter pour évaluer les éléments de la collection en utilisant soit :
-
formula (syntaxe recommandée), un objet formule qui peut encapsuler toute expression exécutable, y compris des fonctions et des méthodes projet ;
-
methodName, le nom d'une méthode projet (texte).
Dans la callback, passez votre code qui compare deux valeurs et retourne true si la première valeur est inférieure à la seconde valeur. Vous pouvez fournir des paramètres extraParam à la callback si nécessaire.
La callback reçoit les paramètres suivants :
- $1 (object), où :
- $1.value (tout type) : valeur du premier élément à comparer
- $1.value2 (tout type) : valeur du second élément à comparer
- $2...$N (tout type) : paramètres supplémentaires (extraParam)
Si vous avez utilisé une méthode, elle doit définir le paramètre suivant :
- $1.result (booléen): true si $1.value < $1.value2, false sinon