Version: 19

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


.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( {option : Integer} ) : Collection .distinct( propertyPath : Text {; option : 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( methodName : Text { ;...param : any } ) : Boolean .every( startFrom : Integer ; methodName : Text { ;...param : any } ) : Boolean renvoie true si tous les éléments de la collection ont passé avec succès un test mis en œuvre dans la méthode methodName fournie
.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( methodName : Text { ; ...param : any } ) : Collection The `.filter()` function
.find( methodName : Text { ; ...param : any } ) : any .find( startFrom : Integer ; methodName : Text { ; ...param : any } ) : any renvoie la première valeur de la collection pour laquelle methodName, appliquée à chaque élément, renvoie true
.findIndex( methodName : Text { ; ...param : any } ) : Integer .findIndex( startFrom : Integer ; methodName : Text { ; ...param : any } ) : Integer renvoie l'index, dans la collection, de la première valeur pour laquelle methodName, appliquée à chaque élément, renvoie true
.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
.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( methodName : Text { ; ...param : any } ) : Collection creates a new collection based upon the result of the call of the methodName method on each element of the original collection
.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( methodName : Text { ; ...extraParam : expression } ) : Collection renvoie une nouvelle collection contenant tous les éléments de la collection dans l'ordre défini par 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( methodName : Text ) : any .reduce( methodName : Text ; initValue : any { ; ...param : expression } ) : any applique la méthode callback methodName à un accumulateur et à chaque élément de la collection (de gauche à droite) pour les 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( methodName : Text { ; ...param : any } ) : Boolean .some( startFrom : Integer ; methodName : Text { ; ...param : any } ) : Boolean returns true if at least one element in the collection successfully passed a test
.sort() : Collection .sort( methodName : Text { ; ...extraParam : any } ) : Collection sorts the elements of the original collection
.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.

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 commande SET 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.

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.

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.

Exemple

 $mySharedCol:=New shared collection("alpha";"omega")
 Use($mySharedCol)
    $mySharedCol[1]:="beta"
 End use

.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.

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.

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.

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.

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.

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.

note

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.

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
v16 R6	Ajout

.distinct( {option : Integer} ) : Collection
.distinct( propertyPath : Text {; option : Integer } ) : Collection

Paramètres	Type		Description
option	Integer	->	`ck diacritical` : évaluation diacritique ("A" # "a" par exemple)
propertyPath	Text	->	Chemin de l'attribut dont vous souhaitez obtenir les valeurs distinctes
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.

La collection retournée est automatiquement triée. Les valeurs Null ne sont pas renvoyées.

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.

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.

Exemple

 var $c; $c2 : 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]

.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).

Notes

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.

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
v16 R6	Ajout

.every( methodName : Text { ;...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
methodName	Text	->	Nom de la méthode à appeler pour l'évaluation
param	Mixed	->	Paramètre(s) à passer à nomMéthode
Résultat	Boolean	<-	Vrai si tous les éléments sont évalués à vrai

Description

La fonction .every() renvoie true si tous les éléments de la collection ont passé avec succès un test mis en œuvre dans la méthode methodName fournie.

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètre(s) dans param (optionnel). methodName peut effectuer tout test, avec ou sans paramètres. La méthode reçoit un paramètre de type Object dans $1 et doit passer true dans $1.result pour chaque élément ayant satisfait aux conditions du test.

methodName reçoit les paramètres suivants :

dans $1.value : valeur de l'élément à évaluer
in $2: param
in $N...: paramN...

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.result (booléen) : true si l'évaluation de la valeur de l'élément est réussie, sinon false.
$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, au premier élément retournant false dans $1.result, la fonction .every() cesse d'appeler methodName et retourne 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
$c:=New collection
$c.push(5;3;1;4;6;2)
$b:=$c.every("NumberGreaterThan0") //retourne true
$c.push(-1)
$b:=$c.every("NumberGreaterThan0") //retourne false

Avec la méthode NumberGreaterThan0 suivante :

$1.result:=$1.value>0

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
$c:=New collection
$c.push(5;3;1;4;6;2)
$b:=$c.every("TypeLookUp";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("TypeLookUp";Is real) //$b=false

Avec la méthode TypeLookUp suivante :

#DECLARE ($toEval : Object ; $param : Integer) //$1; $2
If(Value type($toEval.value)=$param)
    $toEval.result:=True
End if

.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.

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.

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
v16 R6	Ajout

.filter( methodName : Text { ; ...param : any } ) : Collection

Paramètres	Type		Description
methodName	Text	->	Nom de la méthode à appeler pour filtrer la collection
param	Mixed	->	Paramètre(s) à passer à methodName
Résultat	Collection	<-	Nouvelle collection contenant les éléments filtrés (shallow copy)

Description

La fonction .filter() The .filter() function. 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.

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètre(s) dans param (optionnel). methodName peut effectuer tout test, avec ou sans paramètres. In methodName, pass the name of the method to use to evaluate collection elements, along with its parameter(s) in param (optional).

methodName reçoit les paramètres suivants :

dans $1.value : valeur de l'élément à évaluer
dans $2 : param
dans $N... : param2...paramN

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.result (booléen) : true si l'élément satisfait à la condition de filtrage et doit être conservé.
$1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.

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("LengthLessThan";6)
  //$colNew=["hello","world","tim","miami"]

Le code de la méthode LengthLessThan est le suivant :

 C_OBJECT($1)
 C_LONGINT($2)
 If(Value type($1.value)=Is text)
    $1.result:=(Length($1.value))<$2
 End if

Exemple 2

Vous voulez filtrer les éléments de la collection en fonction de leur type :

 var $c;$c2;$c3 : Collection
 $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("TypeLookUp";Is real) // $c2=[5,3,1,4,6,2]
 $c3:=$c.filter("TypeLookUp";Is object)
  // $c3=[{name:Cleveland,zc:35049},{name:Blountsville,zc:35031}]

Le code de TypeLookUp est :

 C_OBJECT($1)
 C_LONGINT($2)
 If(OB Get type($1;"value")=$2)


    $1.result:=True
 End if

.find()

Historique

Release	Modifications
v16 R6	Ajout

.find( methodName : Text { ; ...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
methodName	Text	->	Nom de la méthode à appeler pour la recherche
param	any	->	Paramètre(s) à passer à methodName
Résultat	any	<-	Première valeur trouvée (Undefined si non trouvée)

Description

La fonction find() renvoie la première valeur de la collection pour laquelle methodName, appliquée à chaque élément, renvoie true.

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètre(s) dans param (optionnel). methodName peut effectuer tout test, avec ou sans paramètres. In methodName, pass the name of the method to use to evaluate collection elements, along with its parameter(s) in param (optional).

methodName reçoit les paramètres suivants :

dans $1.value : valeur de l'élément à évaluer
dans $2 : param
dans $N... : param2...paramN

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.result (booléen) : true si l'élément satisfait à la condition de recherche et doit être conservé.
$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 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("LengthLessThan";5) //$value="tim"

Le code de la méthode LengthLessThan est le suivant :

 var $1 : Object
 var $2 : Integer
 If(Value type($1.value)=Is text)
    $1.result:=(Length($1.value))<$2
 End if

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("FindCity";"Clanton") //$c2={name:Clanton,zc:35046}

Le code de la méthode FindCity est :

 var $1 : Object
 var $2 : Text
 $1.result:=$1.value.name=$2 //name est un nom de propriété d'objets dans la collection

.findIndex()

Historique

Release	Modifications
v16 R6	Ajout

.findIndex( methodName : Text { ; ...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
methodName	Text	->	Nom de la méthode à appeler pour la recherche
param	any	->	Paramètre(s) à passer à methodName
Résultat	Integer	<-	Numéro du premier élément trouvé (-1 si non trouvé)

Description

La fonction .findIndex() renvoie l'index, dans la collection, de la première valeur pour laquelle methodName, appliquée à chaque élément, renvoie true.

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètre(s) dans param (optionnel). methodName peut effectuer n'importe quel test, en utilisant ou non le(s) paramètre(s). Cette méthode reçoit un objet comme premier paramètre ($1) et doit définir $1.result à true pour le premier élément remplissant la condition.

methodName reçoit les paramètres suivants :

dans $1.value : valeur de l'élément à évaluer
dans $2 : param
dans $N... : param2...paramN

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.result (booléen) : true si l'élément satisfait à la condition de recherche et doit être conservé.
$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("FindCity";"Clanton") // $val2=3
 $val3:=$c.findIndex($val2+1;"FindCity";"Clanton") //$val3=4

Le code de la méthode FindCity est :

 var $1 : Object
 var $2 : Text
 $1.result:=$1.value.name=$2

.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.

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.

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.

Dans index, passez le numéro de l'élément après lequel vous souhaitez que le paramètre element soit inséré.

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.

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

.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.

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
v16 R6	Ajout

.map( methodName : Text { ; ...param : any } ) : Collection

Paramètres	Type		Description
methodName	Text	->	Nom de la méthode à appeler pour transformer les éléments de la collection
param	any	->	Paramètre(s) à passer à la méthode
Résultat	Collection	<-	Collection de valeurs transformées

Description

La fonction .map() creates a new collection based upon the result of the call of the methodName method on each element of the original collection. Optionnellement, vous pouvez passer des paramètres à 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).

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètre(s) dans param (optionnel). In methodName, pass the name of the method to use to evaluate collection elements, along with its parameter(s) in param (optional).

methodName reçoit les paramètres suivants :

dans $1.value (tout type) : valeur de l'élément à évaluer
dans $2 (tout type) : param
dans $N... (tout type) : paramN...

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.result (tout type) : nouvelle valeur transformée à ajouter à la collection résultante
$1.stop (booléen, optionnel) : true pour stopper le rétroappel de méthode. 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("Percentage";$c.sum())
  //$c2=[2.27,9.09,20.45,22.73,45.45]

Voici la méthode Percentage :

 var $1 : Object
 var $2 : Real
 $1.result:=Round(($1.value/$2)*100;2)

.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()).

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()).

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.

Si vous ne passez aucun paramètre, la fonction trie les valeurs scalaires de la collection par ordre croissant (les autres types d'éléments tels que les objets ou les collections sont retournés sans être triés). 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	Integer	0	Les éléments sont triés par ordre croissant (défaut)
ck descending	Integer	1	Les éléments sont triés par ordre décroissant

This syntax orders scalar values in the collection only (other element types such as objects or collections are returned with an internal order).

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; $3 : 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
v16 R6	Ajout

.orderByMethod( methodName : Text { ; ...extraParam : expression } ) : Collection

Paramètres	Type		Description
methodName	Text	->	Nom de la méthode utilisée pour trier la collection
extraParam	expression	->	Paramètre(s) à passer à la méthode
Résultat	Collection	<-	Copie triée de la collection (shallow copy)

Description

La fonction .orderByMethod() renvoie une nouvelle collection contenant tous les éléments de la collection dans l'ordre défini par la méthode methodName.

Dans methodName, passez le nom d'une méthode qui compare deux valeurs et retourne true dans $1.result si la première valeur est inférieure à la seconde valeur. Si nécessaire, vous pouvez passer des paramètres supplémentaires à la méthode via extraParam.

methodName 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)
methodName doit fixer le paramètre suivant :
- $1.result (booléen): true si $1.value < $1.value2, false sinon

Exemple 1

Vous souhaitez trier une collection de chaînes contenant des nombres par valeur plutôt que par ordre alphabétique :

 var $c; $c2; $c3 : Collection
 $c:=New collection
 $c.push("33";"4";"1111";"222")
 $c2:=$c.orderBy() //$c2=["1111","222","33","4"], alphabetical order
 $c3:=$c.orderByMethod("NumAscending") // $c3=["4","33","222","1111"]

Voici le code de la méthode NumAscending :

 $1.result:=Num($1.value)<Num($1.value2)

Exemple 2

Vous souhaitez trier une collection de chaînes de caractères en fonction de leur longueur :

 var $fruits; $c2 : Collection
 $fruits:=New collection("Orange";"Apple";"Grape";"pear";"Banana";"fig";"Blackberry";"Passion fruit")
 $c2:=$fruits.orderByMethod("WordLength")
  //$c2=[Passion fruit,Blackberry,Orange,Banana,Apple,Grape,pear,fig]

Vous souhaitez trier une collection par code de caractère ou par langage :

 $1.result:=Length(String($1.value))>Length(String($1.value2))

Exemple 3

Vous souhaitez trier une collection par code de caractère ou par langage :

var $strings1; $strings2 : Collection
$strings1:=New collection("Alpha";"Charlie";"alpha";"bravo";"Bravo";"charlie")

//using the character code:
$strings2:=$strings1.orderByMethod("sortCollection";sk character codes)
// result : ["Alpha","Bravo","Charlie","alpha","bravo","charlie"]

//using the language:
$strings2:=$strings1.orderByMethod("sortCollection";sk strict)
// result : ["alpha","Alpha","bravo","Bravo","charlie","Charlie"]

La méthode sortCollection :

var$1Object
var$2Integer // option de tri

$1.result:=(Compare strings($1.value;$1.value2;$2)<0)

.pop()

Historique

Release	Modifications
v16 R6	Ajout

.pop() : any

Paramètres	Type		Description
Résultat	any	<-	Dernier élément de collection

Description

La fonction .pop() supprime le dernier élément de la collection et le retourne comme résultat de fonction.

Lorsqu'elle est appliquée à une collection vide, .pop() retourne undefined.

Exemple

.pop(), combinée à push(), peut être utilisée pour implémenter une fonctionnalité first-in last-out de traitement de données empilées :

 var $stack : Collection
 $stack:=New collection //$stack=[]
 $stack.push(1;2) //$stack=[1,2]
 $stack.pop() //$stack=[1]  retourne 2
 $stack.push(New collection(4;5)) //$stack=[[1,[4,5]]
 $stack.pop() //$stack=[1]  retourne [4,5]
 $stack.pop() //$stack=[]  retourne 1

.push()

Historique

Release	Modifications
v16 R6	Ajout

.push( element : any { ;...elementN } ) : Collection

Paramètres	Type		Description
element	Mixed	->	Élément(s) à ajouter à la collection
Résultat	Collection	<-	Collection originale contenant des éléments ajoutés

Description

La fonction .push() ajoute un ou plusieurs element(s) à la fin de la collection et retourne la collection modifiée.

Exemple 1

 var $col : Collection
 $col:=New collection(1;2) //$col=[1,2]
 $col.push(3) //$col=[1,2,3]
 $col.push(6;New object("firstname";"John";"lastname";"Smith"))
  //$col=[1,2,3,6,{firstname:John,lastname:Smith}

Exemple 2

Vous souhaitez trier la collection résultante :

 var $col; $sortedCol : Collection
 $col:=New collection(5;3;9) //$col=[5,3,9]
 $sortedCol:=$col.push(7;50).sort()
  //$col=[5,3,9,7,50]
  //$sortedCol=[3,5,7,9,50]

.query()

Historique

Release	Modifications
17 R5	Prise en charge de querySettings
v16 R6	Ajout

.query( queryString : Text ; ...value : any ) : Collection
.query( queryString : Text ; querySettings : Object ) : Collection

Paramètres	Type		Description
queryString	Text	->	Critère(s) de recherche
value	Mixed	->	Valeur(s) à comparer lors de l'utilisation de paramètre(s) dans la chaîne
querySettings	Object	->	Options de requête : paramètres, attributs
Résultat	Collection	<-	Élément(s) correspondant à queryString dans la collection

Description

La fonction .query() retourne tous les éléments d'une collection d'objets qui correspondent aux critères de recherche définis par queryString et (optionnellement) value ou querySettings. Si la collection d'origine est une collection partagée, la collection retournée est également une collection partagée.

Le paramètre queryString doit respecter la syntaxe suivante :

propertyPath comparator value {logicalOperator propertyPath comparator value}

Pour plus d'informations sur la génération d'une requête à l'aide des paramètres queryString, value et querySettings, reportez-vous à la description de la fonction de dataclass .query().

Exemple 1

 var $c; $c2; $c3 : 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))
 $c2:=$c.query("name = :1";"Cleveland") //$c2=[{name:Cleveland,zc:35049}]
 $c3:=$c.query("zc > 35040") //$c3=[{name:Cleveland,zc:35049},{name:Clanton,zc:35046},{name:Clanton,zc:35045}]

Exemple 2

 var $c : Collection
 $c:=New collection
 $c.push(New object("name";"Smith";"dateHired";!22-05-2002!;"age";45))
 $c.push(New object("name";"Wesson";"dateHired";!30-11-2017!))
 $c.push(New object("name";"Winch";"dateHired";!16-05-2018!;"age";36))

 $c.push(New object("name";"Sterling";"dateHired";!10-5-1999!;"age";Null))
 $c.push(New object("name";"Mark";"dateHired";!01-01-2002!))

Cet exemple renvoie les personnes dont le nom contient "in" :

 $col:=$c.query("name = :1";"@in@")
  //$col=[{name:Winch...},{name:Sterling...}]

Cet exemple retourne des personnes dont le nom ne commence pas par une chaine dont la valeur provient d'une variable (saisie par l'utilisateur, par exemple) :

 $col:=$c.query("name # :1";$aString+"@")
  //if $astring="W"
  //$col=[{name:Smith...},{name:Sterling...},{name:Mark...}]

Cet exemple retourne des personnes dont l'âge n'est pas connu (propriété définie sur null ou indéfinie) :

 $col:=$c.query("age=null") //placeholders not allowed with "null"
  //$col=[{name:Wesson...},{name:Sterling...},{name:Mark...}]

Cet exemple retourne des personnes embauchées il y a plus de 90 jours :

 $col:=$c.query("dateHired < :1";(Current date-90))
  //$col=[{name:Smith...},{name:Sterling...},{name:Mark...}] si la date du jour est 01/10/2018

Exemple 3

Vous trouverez plus d'exemples de requêtes dans la page dataClass.query().

.reduce()

Historique

Release	Modifications
v16 R6	Ajout

.reduce( methodName : Text ) : any
.reduce( methodName : Text ; initValue : any { ; ...param : expression } ) : any

Paramètres	Type		Description
methodName	Text	->	Nom de la fonction à appeler pour traiter les éléments de collection
initValue	Text, Number, Object, Collection, Date, Boolean	->	Valeur à utiliser comme premier argument du premier appel de methodName
param	expression	->	Paramètre(s) à passer à methodName
Résultat	Text, Number, Object, Collection, Date, Boolean	<-	Résultat de la valeur de l'accumulateur

Description

La fonction .reduce() applique la méthode callback methodName à un accumulateur et à chaque élément de la collection (de gauche à droite) pour les réduire à une seule valeur.

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètres dans param (facultatif). methodName prend chaque élément de la collection et effectue toutes les opérations souhaitées pour accumuler le résultat dans $1.accumulator, qui est retourné dans $1.value.

Vous pouvez passer la valeur pour initialiser l'accumulateur dans initValue. S'il est omis, $1.accumulator commence par Undefined.

methodName reçoit les paramètres suivants :

dans $1.value : valeur de l'élément à évaluer
dans $2 : param
dans $N... : paramN...

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.accumulator: valeur à modifier par la fonction et qui est initialisée par initValue.
$1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.

Exemple 1

 C_COLLECTION($c)
 $c:=New collection(5;3;5;1;3;4;4;6;2;2)
 $r:=$c.reduce("Multiply";1) //retourne 86400

Cet exemple permet de réduire plusieurs éléments de collection en un seul élément :

 If(Value type($1.value)=Is real)
    $1.accumulator:=$1.accumulator*$1.value
 End if

Exemple 2

Cet exemple permet de réduire plusieurs éléments de collection à un seul :

 var $c;$r : Collection
 $c:=New collection
 $c.push(New collection(0;1))
 $c.push(New collection(2;3))
 $c.push(New collection(4;5))
 $c.push(New collection(6;7))
 $r:=$c.reduce("Flatten") //$r=[0,1,2,3,4,5,6,7]

Avec la méthode Flatten suivante :

 If($1.accumulator=Null)
    $1.accumulator:=New collection
 End if
 $1.accumulator.combine($1.value)

.remove()

Historique

Release	Modifications
v16 R6	Ajout

.remove( index : Integer { ; howMany : Integer } ) : Collection

Paramètres	Type		Description
index	Integer	->	Élément à partir duquel la suppression peut commencer
howMany	Integer	->	Nombre d'éléments à supprimer, ou 1 élément si omis
Résultat	Collection	<-	Collection d'origine sans élément(s) supprimé(s)

Description

La fonction .remove() 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.

Dans index, passez le numéro de l'élément à partir duquel la suppression doit débuter dans 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 recalculée est négative, index prend la valeur 0.
Si valeur recalculée > longueur de la collection, index prend comme valeur la taille de la collection.

Dans howMany, passez le nombre d'éléments à supprimer à partir de l'index. Si howMany n'est pas spécifié, un élément est supprimé.

Si vous essayez de supprimer un élément d'une collection vide, la méthode ne fait rien (aucune erreur n'est générée).

Exemple

 var $col : Collection
 $col:=New collection("a";"b";"c";"d";"e";"f";"g";"h")
 $col.remove(3) // $col=["a","b","c","e","f","g","h"]
 $col.remove(3;2) // $col=["a","b","c","g","h"]
 $col.remove(-8;1) // $col=["b","c","g","h"]
 $col.remove(-3;1) // $col=["b","g","h"]

.resize()

Historique

Release	Modifications
v16 R6	Ajout

.resize( size : Integer { ; defaultValue : any } ) : Collection

Paramètres	Type		Description
size	Integer	->	Nouvelle taille de la collection
defaultValue	Number, Text, Object, Collection, Date, Boolean	->	Valeur par défaut pour remplir de nouveaux éléments
Résultat	Collection	<-	Collection d'origine redimensionnée

Description

La fonction .resize() redimensionne la collection à la taille définie et retourne la collection redimensionnée.

Si size est inférieure à la longueur de la collection, les éléments excédentaires sont retirés de la collection.
Si size > longueur de la collection, size est la nouvelle longueur de la collection.

Par défaut, les nouveaux éléments sont remplis par des valeurs null. Vous pouvez indiquer la valeur à remplir dans les éléments ajoutés à l'aide du paramètre defaultValue.

Exemple

 var $c : Collection
 $c:=New collection
 $c.resize(10) // $c=[null,null,null,null,null,null,null,null,null,null]

 $c:=New collection
 $c.resize(10;0) // $c=[0,0,0,0,0,0,0,0,0,0]

 $c:=New collection(1;2;3;4;5)
 $c.resize(10;New object("name";"X")) //$c=[1,2,3,4,5,{name:X},{name:X},{name:X},{name:X},{name:X}]

 $c:=New collection(1;2;3;4;5)
 $c.resize(2) //$c=[1,2]

.reverse()

Historique

Release	Modifications
v16 R6	Ajout

.reverse( ) : Collection

Paramètres	Type		Description
Résultat	Collection	<-	Copie inversée de la collection

Description

La fonction .reverse() retourne une copie profonde (deep copy) de la collection avec tous ses éléments en ordre inverse. Si la collection d'origine est une collection partagée, la collection retournée est également une collection partagée.

Exemple

 var $c; $c2 : Collection
 $c:=New collection(1;3;5;2;4;6)
 $c2:=$c.reverse() //$c2=[6,4,2,5,3,1]

.shift()

Historique

Release	Modifications
v16 R6	Ajout

.shift() : any

Paramètres	Type		Description
Résultat	any	<-	Premier élément de collection

Description

La fonction shift() supprime le premier élément de la collection et le retourne en résultat.

Si la collection est vide, cette méthode ne fait rien.

Exemple

 var $c : Collection
 var $val : Variant
 $c:=New collection(1;2;4;5;6;7;8)
 $val:=$c.shift()
  // $val=1
  // $c=[2,4,5,6,7,8]

.slice()

Historique

Release	Modifications
v16 R6	Ajout

.slice( startFrom : Integer { ; end : Integer } ) : Collection

Paramètres	Type		Description
startFrom	Integer	->	Indice l'élément de départ (inclus)
end	Integer	->	Indice de fin (non inclus)
Résultat	Collection	<-	Nouvelle collection contenant des éléments scindés (copie superficielle)

Description

La fonction slice() retourne une partie de la collection dans une nouvelle collection, sélectionné à partir de l'indice startFrom jusqu'à l'indice end (end n'est pas inclus). Cette fonction retourne une copie superficielle de la collection. Si la collection d'origine est une collection partagée, la collection retournée est également une collection partagée.

La collection retournée contient l'élément spécifié par startFrom et tous les éléments suivants jusqu'à l'élément spécifié par end (mais non compris). Si seul le paramètre startFrom est spécifié, la collection retournée contient tous les éléments de startFrom au dernier élément de la collection d'origine.

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 calculé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; $nc : Collection
 $c:=New collection(1;2;3;4;5)
 $nc:=$c.slice(0;3) //$nc=[1,2,3]
 $nc:=$c.slice(3) //$nc=[4,5]
 $nc:=$c.slice(1;-1) //$nc=[2,3,4]
 $nc:=$c.slice(-3;-2) //$nc=[3]

.some()

Historique

Release	Modifications
v16 R6	Ajout

.some( methodName : Text { ; ...param : any } ) : Boolean
.some( startFrom : Integer ; methodName : Text { ; ...param : any } ) : Boolean

Paramètres	Type		Description
startFrom	Integer	->	Elément à partir duquel débuter l'évaluation
methodName	Text	->	Nom de la méthode à appeler pour l'évaluation
param	Mixed	->	Paramètre(s) à passer à methodName
Résultat	Boolean	<-	Vrai si au moins un élément a réussi le test

Description

La fonction some() returns true if at least one element in the collection successfully passed a test implemented in the provided methodName method.

Dans methodName, passez le nom de la méthode à utiliser pour évaluer les éléments de la collection, ainsi que son ou ses paramètre(s) dans param (optionnel). methodName peut effectuer tout test, avec ou sans paramètres. In methodName, pass the name of the method to use to evaluate collection elements, along with its parameter(s) in param (optional).

methodName reçoit les paramètres suivants :

dans $1.value : valeur de l'élément à évaluer
in $2: param
dans $N... : param2...paramN

methodName doit fixer le(s) paramètre(s) suivant(s) :

$1.result (booléen) : true si l'évaluation de la valeur de l'élément est réussie, sinon false.
$1.stop (booléen, optionnel) : true pour stopper le rétroappel. La valeur retournée est la dernière calculée.

Par défaut, .some() évalue l'ensemble de la collection. Optionnellement, vous pouvez passer l'indice 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, il est considéré comme le décalage depuis la fin de la collection.
Si startFrom = 0, l'ensemble de la collection est évalué (défaut).

Exemple

 var $c : Collection
 var $b : Boolean
 $c:=New collection
 $c.push(-5;-3;-1;-4;-6;-2)
 $b:=$c.some("NumberGreaterThan0") // retourne false
 $c.push(1)
 $b:=$c.some("NumberGreaterThan0") // retourne true

 $c:=New collection
 $c.push(1;-5;-3;-1;-4;-6;-2)
 $b:=$c.some("NumberGreaterThan0") //$b=true
 $b:=$c.some(1;"NumberGreaterThan0") //$b=false

Avec la méthode NumberGreaterThan0 suivante :


 $1.result:=$1.value>0

.sort()

Historique

Release	Modifications
v16 R6	Ajout

.sort() : Collection
.sort( methodName : Text { ; ...extraParam : any } ) : Collection

Paramètres	Type		Description
methodName	Text	->	Nom de la méthode utilisée pour trier la collection
extraParam	any	->	Paramètre(s) à passer à la méthode
Résultat	Collection	<-	Collection d'origine triée

Description

La fonction .sort() sorts the elements of the original collection and also returns the sorted collection.

Si .sort() est appelé sans paramètre, seules les valeurs scalaires (numérique, texte, date, booléens) sont triées. Les éléments sont triés par défaut par ordre croissant, en fonction de leur type. 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

Si vous souhaitez trier les éléments de la collection dans un autre ordre ou trier n'importe quel type d'élément, vous devez fournir, dans methodName, une méthode de comparaison qui compare deux valeurs et retourne true dans $1.result si la première valeur est inférieure à la deuxième valeur. Si nécessaire, vous pouvez passer des paramètres supplémentaires à la méthode via extraParam.

methodName 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)

methodName doit fixer le paramètre suivant :

$1.result(boolean): true if*$1.value < $1.value2*, false otherwise

Exemple 1

 var $col; $col2 : Collection
 $col:=New collection("Tom";5;"Mary";3;"Henry";1;"Jane";4;"Artie";6;"Chip";2)
 $col2:=$col.sort() // $col2=["Artie","Chip","Henry","Jane","Mary","Tom",1,2,3,4,5,6]
  // $col=["Artie","Chip","Henry","Jane","Mary","Tom",1,2,3,4,5,6]

Exemple 2

 var $col; $col2 : Collection
 $col:=New collection(10;20)
 $col2:=$col.push(5;3;1;4;6;2).sort() //$col2=[1,2,3,4,5,6,10,20]

Exemple 3

 var $col; $col2; $col3 : Collection
 $col:=New collection(33;4;66;1111;222)
 $col2:=$col.sort() //tri numérique : [4,33,66,222,1111]
 $col3:=$col.sort("numberOrder") //tri alphabétique : [1111,222,33,4,66]

  //méthode projet numberOrder
 var $1 : Object
 $1.result:=String($1.value)<String($1.value2)

.sum()

Historique

Release	Modifications
v16 R6	Ajout

.sum( { propertyPath : Text } ) : Real

Paramètres	Type		Description
propertyPath	Text	->	Chemin de propriété d'objet à utiliser pour évaluer les valeurs
Résultat	Real	<-	Somme des valeurs de collection

Description

La fonction .sum() retourne la somme de toutes les valeurs numériques de 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.

.sum() retourne 0 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

 var $vSum : Real
 $col:=New collection(10;20;"Monday";True;2)
 $vSum:=$col.sum() //32

Exemple 2

 var $col : Collection
 var $vSum : Real
 $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,5))
 $vSum:=$col.sum("salary") //$vSum=70500,5

.unshift()

Historique

Release	Modifications
v16 R6	Ajout

.unshift( value : any { ;...valueN : any } ) : Collection

Paramètres	Type		Description
value	Text, Number, Object, Collection, Date	->	Valeur(s) à insérer au début de la collection
Résultat	Real	<-	Collection contenant des éléments ajoutés

Description

La fonction unshift() insère la ou les value(s) au début de la collection et retourne la collection modifiée.

Si plusieurs valeurs sont passées, elles sont insérées toutes en même temps, ce qui signifie qu'elles apparaissent dans la collection résultante dans le même ordre que dans la liste d'arguments.

Exemple

 var $c : Collection
 $c:=New collection(1;2)
 $c.unshift(4) // $c=[4,1,2]
 $c.unshift(5) //$c=[5,4,1,2]
 $c.unshift(6;7) // $c=[6,7,5,4,1,2]

Exemple​

Sommaire​

New collection​

Description​

Exemple 1​

Exemple 2​

Exemple 3​

New shared collection​

Description​

Exemple​

.average()​

Description​

Exemple 1​

Exemple 2​

.clear()​

Description​

Exemple​

.combine()​

Description​

Exemple​

.concat()​

Description​

Exemple​

.copy()​

Description​

Exemple 1​

Exemple 2​

Exemple 3​

Exemple 4​

.count()​

Description​

Exemple​

.countValues()​

Description​

Exemple 1​

Exemple 2​

Exemple 3​

.distinct()​

Description​

Exemple​

.equal()​

Description​

Exemple​

.every()​

Description​

Exemple 1​

Exemple 2​

.extract()​

Description​

Exemple 1​

Exemple 2​

.fill()​

Description​

Exemple​

.filter()​

Description​

Exemple 1​

Exemple 2​

.find()​

Description​

Exemple 1​

Exemple 2​

.findIndex()​

Description​

Exemple​

.indexOf()​

Description​

Exemple​

.indices()​

Description​

Exemple​

.insert()​

Description​

Exemple​

.join()​

Description​

Exemple​

.lastIndexOf()​

Description​

Exemple​

Exemple

Sommaire

`New collection`

Description

Exemple 1

Exemple 2

Exemple 3

`New shared collection`

Description

Exemple

.average()

Description

Exemple 1

Exemple 2

.clear()

Description

Exemple

.combine()

Description

Exemple

.concat()

Description

Exemple

.copy()

Description

Exemple 1

Exemple 2

Exemple 3

Exemple 4

.count()

Description

Exemple

.countValues()

Description

Exemple 1

Exemple 2

Exemple 3

.distinct()

Description

Exemple

.equal()

Description

Exemple

.every()

Description

Exemple 1

Exemple 2

.extract()

Description

Exemple 1

Exemple 2

.fill()

Description

Exemple

.filter()

Description

Exemple 1

Exemple 2

.find()

Description

Exemple 1

Exemple 2

.findIndex()

Description

Exemple

.indexOf()

Description

Exemple

.indices()

Description

Exemple

.insert()

Description

Exemple

.join()

Description

Exemple

.lastIndexOf()

Description

Exemple