Select (méthode)

Présentation

Type :	Méthode
Disponible à partir de :	V1.4.15.0

Description fonctionnelle

Cette méthode est utilisée pour sélectionner un élément particulier parmi les données au format JSON analysées. En fonction de l'élément sélectionné, des méthodes supplémentaires peuvent être exécutées.

L'élément est spécifié à l'aide d'une expression JPath. Si l'expression JPath correspond à plusieurs éléments, le premier élément désigné est sélectionné. Si une chaîne nulle est attribuée à l'entrée i_sJPath, l'élément racine est sélectionné.

Lors de chaque appel, la recherche de l'élément spécifié est lancée à partir du début des données analysées. L'utilisation d'une même expression JPath résulte donc toujours dans la sélection du même élément.

La valeur de retour de type BOOL indique TRUE si un élément a été sélectionné avec succès. Si une erreur a été détectée, utilisez les propriétés Result et ResultMsg pour obtenir le résultat de la méthode.

Si l'élément demandé n'a pas pu être sélectionné, l'élément sélectionné précédemment reste sélectionné.

Interface

Entrée	Type de données	Description
i_sJPath	STRING [255]	JPath expression permettant de spécifier l'élément à sélectionner. Si une chaîne nulle est attribuée, l'élément racine est sélectionné.

NOTE : L'exécution de cette méthode réinitialise les erreurs signalées précédemment par les propriétés correspondantes.

JPath Expressions

Pour désigner l'élément à sélectionner, utilisez la syntaxe du langage JPath.

Le tableau suivant répertorie les expressions JPath prises en charge :

JPath expression	Description
`.<item name>` `<item name>` `.[<item name>]` `[<item name>]`	Sélectionne le premier élément présentant le nom indiqué au premier niveau.
`.<item name>.<item name>` `.[<item name>].[<item name>]` `[<item name>][<item name>]`	Sélectionne le premier élément correspondant au chemin absolu indiqué.
`.<parent name>.<item name>[<n>]` `.<parent name>.<item name>.[<n>]`	Sélectionne le premier élément de tableau correspondant au chemin absolu indiqué. `<n>` désigne l'index (base zéro) de l'élément dans le tableau.
`.<parent name>.<item name>.[<n>].<item name>` `.<parent name>.<item name>.[<n>].[<item name>]`	Sélectionne l'élément enfant du premier élément de tableau correspondant au chemin absolu indiqué. `<n>` désigne l'index (base zéro) de l'élément dans le tableau.

L'exemple suivant montre comment utiliser l'expression JPath pour sélectionner un élément parmi des données au format JSON :

JPath expression	Données JSON analysées
`.Library -------------> .Supported Formats[1]-> .Address -------------> .Address.Street ------>`	`{ "Library": "FileFormatUtility", "Namespace": "FFU", "Forward Compatible": true, "Supported Formats": [ "JSON", "XML", "CSV"], "Company": "Schneider Electric", "Address": { "Street": "Schneiderplatz", "House Number": 1, "Postal Code": "97828", "City": "Marktheidenfeld", "Country": "Germany" } }`

JPath expression

Données JSON analysées


.Library ------------->


.Supported Formats[1]->




.Address ------------->
.Address.Street ------>

{ 
  "Library": "FileFormatUtility",
  "Namespace": "FFU",
  "Forward Compatible": true,
  "Supported Formats": [
               "JSON",
               "XML",
               "CSV"],
  "Company": "Schneider Electric",
  "Address":  {
               "Street": "Schneiderplatz",
               "House Number": 1,
               "Postal Code": "97828",
               "City": "Marktheidenfeld",
               "Country": "Germany"
  }
}