entitySelection.toCollection( )

4D v19.8


entitySelection.toCollection ( {filtre ;}{ options {; début {; combien}}} ) -> Résultat

Paramètre	Type	Description
filtre	Chaîne, Collection	Indique les propriétés d'entité à extraire
options	Entier long	dk with primary key : ajoute la clé primaire dk with stamp : ajoute le marqueur
début	Entier long	Désigne l'index de début
combien	Entier long	Nombre d'entités à extraire
Résultat	Collection	Collection d'objets contenant les attributs et valeurs de la sélection d'entités

Description

La méthode entitySelection.toCollection( ) crée et renvoie une collection dans laquelle chaque élément est un objet contenant un ensemble de propriétés et de valeurs correspondant aux noms et aux valeurs des attributs de la sélection d'entités.

Si le paramètre filtre est omis ou contient une chaîne vide ou "*", tous les attributs sont extraits. Les attributs dont la propriété "kind" est "relatedEntity" sont extraits avec la forme simple : un objet avec la propriété __KEY (clé primaire). Les attributs dont la propriété "kind" est "relatedEntities" ne sont pas extraits.

Dans le paramètre filtre, vous pouvez indiquer les attributs à extraire. Deux syntaxes sont permises :

une chaîne avec les chemins des propriétés séparés par des virgules : "propertyPath1, propertyPath2, ...".
une collection de chaînes : ["propertyPath1","propertyPath2",...]

Si filtre est spécifié pour des attributs de type relatedEntity :

propertyPath = "relatedEntity" -> l'extraction se fait dans une forme simple
propertyPath = "relatedEntity.*" -> toutes les propriétés sont extraites
propertyPath = "relatedEntity.propertyName1, relatedEntity.propertyName2, ..." -> seules ces propriétés sont extraites

Si filtre est spécifié pour des attributs de type relatedEntities :

propertyPath = "relatedEntities.*" -> toutes les propriétés sont extraites
propertyPath = "relatedEntities.propertyName1, relatedEntities.propertyName2, ..." -> seules ces propriétés sont extraites

Dans le paramètre options, vous pouvez passer les sélecteurs dk with primary key et/ou dk with stamp pour ajouter les clés primaires et/ou les marqueurs internes des entités dans les objets extraits.

Le paramètre début vous permet d'indiquer la position de départ des entités à extraire. Vous pouvez passer toute valeur comprise entre 0 et la longueur de la sélection d'entités -1.

Le paramètre combien vous permet de spécifier le nombre d'entités à extraire, à partir de celle désignée par début. Les entités supprimées ne sont pas retournées mais sont prises en compte dans combien. Par exemple, si combien=3 s'il y a une entité supprimée, seulement 2 entités sont extraites.

Si combien > length de la sélection d'entités, la méthode retourne (length - début) objets.

Une collection vide est retournée si :

la sélection d'entités est vide, ou
début est supérieur à la longueur de la sélection d'entités.

Exemple 1

La structure suivante sera utilisée pour les exemples de cette section :

Exemple sans paramètre filtre ni options :

 C_COLLECTION($employeesCollection)

 C_OBJECT($employees)

 

 $employeesCollection:=New collection

 $employees:=ds.Employee.all()

 $employeesCollection:=$employees.toCollection()

Retourne :

[
    {
        "ID": 416,
        "firstName": "Gregg",
        "lastName": "Wahl",
        "salary": 79100,
        "birthDate": "1963-02-01T00:00:00.000Z",
        "woman": false,
        "managerID": 412,
        "employerID": 20,
        "photo": "[object Picture]",
        "extra": null,
        "employer": {
            "__KEY": 20
        },
        "manager": {
            "__KEY": 412
        }
    },
    {
        "ID": 417,
        "firstName": "Irma",
        "lastName": "Durham",
        "salary": 47000,
        "birthDate": "1992-06-16T00:00:00.000Z",
        "woman": true,
        "managerID": 412,
        "employerID": 20,
        "photo": "[object Picture]",
        "extra": null,
        "employer": {
            "__KEY": 20
        },
        "manager": {
            "__KEY": 412
        }
    }
]

Exemple 2

Exemple avec options :

 $employeesCollection:=New collection

 $employees:=ds.Employee.all()

 $employeesCollection:=$employees.toCollection("";dk with primary key+dk with stamp)

Retourne :

[
    {
        "__KEY": 416,
        "__STAMP": 1,
        "ID": 416,
        "firstName": "Gregg",
        "lastName": "Wahl",
        "salary": 79100,
        "birthDate": "1963-02-01T00:00:00.000Z",
        "woman": false,
        "managerID": 412,
        "employerID": 20,
        "photo": "[object Picture]",
        "extra": null,
        "employer": {
            "__KEY": 20
        },
        "manager": {
            "__KEY": 412
        }
    },
    {
        "__KEY": 417,
        "__STAMP": 1,
        "ID": 417,
        "firstName": "Irma",
        "lastName": "Durham",
        "salary": 47000,
        "birthDate": "1992-06-16T00:00:00.000Z",
        "woman": true,
        "managerID": 412,
        "employerID": 20,
        "photo": "[object Picture]",
        "extra": null,
        "employer": {
            "__KEY": 20
        },
        "manager": {
            "__KEY": 412
        }
    }]

Exemple 3

Exemple avec découpage et filtrage :

 $employeesCollection:=New collection

 $filter:=New collection

 $filter.push("firstName")

 $filter.push("lastName")

 

 $employees:=ds.Employee.all()

 $employeesCollection:=$employees.toCollection($filter;0;0;2)

Retourne :

[
    {
        "firstName": "Gregg",
        "lastName": "Wahl"
    },
    {
        "firstName": "Irma",
        "lastName": "Durham"
    }
]

Exemple 4

Exemple avec le type relatedEntity avec une forme simple :

 $employeesCollection:=New collection

 employeesCollection:=$employees.toCollection("firstName,lastName,employer")

Retourne :

[
    {
        "firstName": "Gregg",
        "lastName": "Wahl",
        "employer": {
            "__KEY": 20
        }
    },
    {
        "firstName": "Irma",
        "lastName": "Durham",
        "employer": {
            "__KEY": 20
        }
    },
    {
        "firstName": "Lorena",
        "lastName": "Boothe",
        "employer": {
            "__KEY": 20
        }
    }
   ]

Exemple 5

Exemple avec filtre en tant que collection :

 $employeesCollection:=New collection

 $coll:=New collection("firstName";"lastName")

 $employeesCollection:=$employees.toCollection($coll)

Retourne :

[
    {
        "firstName": "Joanna",
        "lastName": "Cabrera"
    },
    {
        "firstName": "Alexandra",
        "lastName": "Coleman"
    }
]

Exemple 6

Exemple avec extraction de toutes les propriétés de relatedEntity :

 $employeesCollection:=New collection

 $coll:=New collection

 $coll.push("firstName")

 $coll.push("lastName")

 $coll.push("employer.*")

 $employeesCollection:=$employees.toCollection($coll)

Retourne :

[
    {
        "firstName": "Gregg",
        "lastName": "Wahl",
        "employer": {
            "ID": 20,
            "name": "India Astral Secretary",
            "creationDate": "1984-08-25T00:00:00.000Z",
            "revenues": 12000000,
            "extra": null
        }
    },
    {
        "firstName": "Irma",
        "lastName": "Durham",
        "employer": {
            "ID": 20,
            "name": "India Astral Secretary",
            "creationDate": "1984-08-25T00:00:00.000Z",
            "revenues": 12000000,
            "extra": null
        }
    },
    {
        "firstName": "Lorena",
        "lastName": "Boothe",
        "employer": {
            "ID": 20,
            "name": "India Astral Secretary",
            "creationDate": "1984-08-25T00:00:00.000Z",
            "revenues": 12000000,
            "extra": null
        }
    }
  ]

Exemple 7

Exemple avec extraction de quelques propriétés de relatedEntity :

 $employeesCollection:=New collection

 $employeesCollection:=$employees.toCollection("firstName, lastName, employer.name")

[
    {
        "firstName": "Gregg",
        "lastName": "Wahl",
        "employer": {
            "name": "India Astral Secretary"
        }
    },
    {
        "firstName": "Irma",
        "lastName": "Durham",
        "employer": {
            "name": "India Astral Secretary"
        }
    },
    {
        "firstName": "Lorena",
        "lastName": "Boothe",
        "employer": {
            "name": "India Astral Secretary"
        }
    }]

Exemple 8

Exemple avec extraction de quelques propriétés de relatedEntities :

 $employeesCollection:=New collection

 $employeesCollection:=$employees.toCollection("firstName, lastName, directReports.firstName")

Retourne :

[
    {
        "firstName": "Gregg",
        "lastName": "Wahl",
        "directReports": []
    },
    {
        "firstName": "Mike",
        "lastName": "Phan",
        "directReports": [
            {
                "firstName": "Gary"
            },
            {
                "firstName": "Sadie"
            },
            {
                "firstName": "Christie"
            }
        ]
    },
    {
        "firstName": "Gary",
        "lastName": "Reichert",
        "directReports": [
            {
                "firstName": "Rex"
            },
            {
                "firstName": "Jenny"
            },
            {
                "firstName": "Lowell"
            }
        ]
    }]

Exemple 9

Exemple avec extraction de toutes les propriétés de relatedEntities :

 $employeesCollection:=New collection

 $employeesCollection:=$employees.toCollection("firstName, lastName, directReports.*")

Retourne :

[
    {
        "firstName": "Gregg",
        "lastName": "Wahl",
        "directReports": []
    },    
    {
        "firstName": "Mike",
        "lastName": "Phan",
        "directReports": [
            {
                "ID": 425,
                "firstName": "Gary",
                "lastName": "Reichert",
                "salary": 65800,
                "birthDate": "1957-12-23T00:00:00.000Z",
                "woman": false,
                "managerID": 424,
                "employerID": 21,
                "photo": "[object Picture]",
                "extra": null,
                "employer": {
                    "__KEY": 21
                },
                "manager": {
                    "__KEY": 424
                }
            },
            {
                "ID": 426,
                "firstName": "Sadie",
                "lastName": "Gallant",
                "salary": 35200,
                "birthDate": "2022-01-03T00:00:00.000Z",
                "woman": true,
                "managerID": 424,
                "employerID": 21,
                "photo": "[object Picture]",
                "extra": null,
                "employer": {
                    "__KEY": 21
                },
                "manager": {
                    "__KEY": 424
                }
            }
                   ]
    },
    {
        "firstName": "Gary",
        "lastName": "Reichert",
        "directReports": [
            {
                "ID": 428,
                "firstName": "Rex",
                "lastName": "Chance",
                "salary": 71600,
                "birthDate": "1968-08-09T00:00:00.000Z",
                "woman": false,
                "managerID": 425,
                "employerID": 21,
                "photo": "[object Picture]",
                "extra": null,
                "employer": {
                    "__KEY": 21
                },
                "manager": {
                    "__KEY": 425
                }
            },
            {
                "ID": 429,
                "firstName": "Jenny",
                "lastName": "Parks",
                "salary": 51300,
                "birthDate": "1984-05-25T00:00:00.000Z",
                "woman": true,
                "managerID": 425,
                "employerID": 21,
                "photo": "[object Picture]",
                "extra": null,
                "employer": {
                    "__KEY": 21
                },
                "manager": {
                    "__KEY": 425
                }
            }
           ]
 }
]

Voir aussi

dataClass.fromCollection( )