Générer du XML avec 4D 2004 - 1ère partie

Date de publication : Septembre 2004

Par Christophe KEROMEN, (Cabinet de Consultants CKTI)
 

I. Approche DOM

Gestion de l'arbre DOM

<?xml version="1.0" encoding="UTF-8" ?>

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<valeursXML>


   <Champ1>
      <value1>liste1_choix1 </value>
      <value1>liste1_choix3 </value>
      <value1>liste1_choix2 </value>
   </Champ1>


   <Champ2> 
      <value1>liste2_choix2 </value>
      <value1>liste2_choix4 </value>
   </Champ2>


   <Champ3> 
      <value1>liste3_choix2 </value>
   </Champ3>


</valeursXML>

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<valeursXML><Champ1><value1>liste1_choix1</value><value1>liste1_choix3 </value><value1>
liste1_choix2</value></Champ1><Champ2><value1>liste2_choix2</value><value1>liste2_choix4</
value></Champ2><Champ3><value1>liste3_choix2</value></Champ3></valeursXML>

Remplissage de l'arbre

Note : Dans la version 2004, les noms des commandes de construction et de parcours d'un arbre DOM ont été renommés pour plus de cohérence avec les commandes d'écriture. Toutes sont désormais préfixées par DOM, ainsi Analyser source XML devient DOM Analyser source XML.

II. Modification de l'enregistrement d'une structure XML

Méthode XMLvalues_Record_Save

Méthode XMLvalues_Values2XML_2004

III. Génération d'un document XML pour une sélection d'enregistrements

Appel depuis l'extérieur

Présentation de l'exemple

Nous appliquerons ces routines à une structure volontairement très simple comprenant une seule table :

      Figure 3 : la structure d'exemple

      Figure 4 : dialogue de test des différents modes de génération XML

Traitement par DOM

         <root>
            <nom_table>structure de l'enregistrement</nom_table>
            <nom_table>structure de l’enregistrement</nom_table>
             ... (autant de fois que d’enregistrements dans la sélection)
         </root>
   Pour chaque enregistrement DOM_EnregistrementVersXML : convertit chaque champ en un élément   
   <nom_du_champ>valeur du champ</nom_du_champ>
   Pour chaque champ DOM_set_ElementWithValue : écrit un élément avec sa valeur

Méthode CD_ListeXML

Commentaires : Remarquez la gestion des paramètres d'entrée-sortie suivant l'origine de l'appel, client SOAP ou requête http. Avec SOAP, les paramètres sont nommés, décrits dans le WSDL et tout assistant du type de celui de 4D permet de générer facilement le code d’appel dit méthode proxy :       Figure 6 : Assistant SOAP mettant en évidence les paramètres nommés En revanche, dans le cas d’une requête http, il n'existe aucun moyen de savoir quel URL appeler et quel paramètre passer et suivant quelle syntaxe. D'un strict point de vue de consommation de ressources, la requête http reste cependant plus performante.

Méthode DOM_Liste_EnregistrementsVersXML

Commentaires Il est possible de passer un paramètre $2 désignant une méthode qui se chargera de convertir l'enregistrement courant en XML au lieu de la méthode générique DOM_EnregistrementVersXML. La routine XML_AppelerSurErreur_set appelle une simple gestion d'erreurs, la dernière erreur rencontrée peut être retrouvée en appelant la méthode accesseur XML_AppelerSurErreur_getLastErr. DOM creer element XML se charge d’encoder les valeurs passées en accord avec l'option fixée dans DOM ECRIRE OPTIONS XML. Cependant, cela ne comprend pas la vérification des règles syntaxiques XML comme par exemple l'interdiction d’espace dans les noms d'éléments. C'est pourquoi nous traitons au préalable le nom de l'élément par la routine XMLw_Replace_Char déjà présentée dans la note technique 4D-200402-04- FR. Une fois toute notre sélection d’enregistrements parcourue, nous utilisons la commande DOM EXPORTER VERS VARIABLE pour récupérer notre arbre DOM dans un BLOB que nous repassons immédiatement à DOM Analyser variable XML afin de vérifier si notre document est bien formé. Si tel est le cas, nous renvoyons à la méthode appelante la structure XML en BLOB et la structure XML convertie en texte. Cette dernière conversion souffre d’un bug de 4ème Dimension dans la version à la date de rédaction. En effet, DOM EXPORTER VERS VARIABLE($_vt_Ref_XML;$_vt_XML) devrait décoder notre arbre XML encodé en UTF-8 pour, d'après la documentation, nous le ranger dans une variable texte en codage Mac Roman. Le décodage n'est pourtant pas effectué. C'est pourquoi nous conseillons en attendant la correction de ce bug et pour récupérer une version texte, de passer plutôt par un encodage en ISO-8859-1 puis de décodermanuellement (ISO vers Mac) la version texte de la structure XML.

Conversion des champs de l'enregistrement, DOM_EnregistrementVersXML :

Commentaires La routine xmlw_Si_ChampBinaire nous sert à filtrer les champs binaires que nous ne pouvons pas facilement convertir en texte. Une solution consisterait à utiliser un encodage en base64 grâce à la nouvelle commande de la version 2004, ENCODER. Comme pour les noms de tables, nous pré-traitons les noms de champs dans la routine XMLw_Replace_Char. Par exemple, le nom du champ “[CD]Date Stock“ devient “DateStock“. 4D n’effectue pas automatiquement ce traitement, or les espaces étant interdits en XML dans les noms de champs, cela se traduirait par un document XML mal-formé et donc inexploitable. Nous rajoutons également un préfixe (le nom de la table) au nom du champ, ainsi “[CD]Date Stock“ devient réellement “CD.DateStock“ dans le document XML produit. Dans le cadre de cet exemple, cela n’a pas réellement d’intérêt. Dans une version plus évoluée pouvant mixer au sein d’un même document XML des champs provenant de plusieurs tables, il pourrait se produire des conflits entre des champs portant le même nom dans des tables différentes. Nous passons ici d’un nom local “ID“ par exemple à un nom global “Table1.ID“ qui ne peut être confondu avec un autre nom global possédant un nom local identique, “Table2.ID“ par exemple. Une solution plus canonique par rapport à XML consisterait à utiliser des espaces de noms différents pour chacune des tables. Cette routine n'est pas optimisée. Il serait plus efficace d’analyser une fois pour toute la structure de la table, et construire un tableau en mémoire contenant les éléments nécessaires pour la génération de la structure XML correspondante et d’utiliser ce tableau pour chaque enregistrement. Ici, l'analyse de la table est répétée pour chaque enregistrement.

Méthode DOM_set_ElementWithValue

IV. Conclusion

V. Base exemple

__________________________________________________
Copyright © 1985-2008 4D SA - Tous droits réservés
Tous les efforts ont été faits pour que le contenu de cette note technique présente le maximum de fiabilité possible.
Néanmoins, les différents éléments composant cette note technique, et le cas échéant, le code, sont fournis sans garantie d'aucune sorte. L'auteur et 4D S.A. déclinent donc toute responsabilité quant à l'utilisation qui pourrait être faite de ces éléments, tant à l'égard de leurs utilisateurs que des tiers.
Les informations contenues dans ce document peuvent faire l'objet de modifications sans préavis et ne sauraient en aucune manière engager 4D SA. La fourniture du logiciel décrit dans ce document est régie par un octroi de licence dont les termes sont précisés par ailleurs dans la licence électronique figurant sur le support du Logiciel et de la Documentation afférente. Le logiciel et sa documentation ne peuvent être utilisés, copiés ou reproduits sur quelque support que ce soit et de quelque manière que ce soit, que conformément aux termes de cette licence.
Aucune partie de ce document ne peut être reproduite ou recopiée de quelque manière que ce soit, électronique ou mécanique, y compris par photocopie, enregistrement, archivage ou tout autre procédé de stockage, de traitement et de récupération d'informations, pour d'autres buts que l'usage personnel de l'acheteur, et ce exclusivement aux conditions contractuelles, sans la permission explicite de 4D SA.
4D, 4D Calc, 4D Draw, 4D Write, 4D Insider, 4ème Dimension ®, 4D Server, 4D Compiler ainsi que les logos 4e Dimension, sont des marques enregistrées de 4D SA.
Windows,Windows NT,Win 32s et Microsoft sont des marques enregistrées de Microsoft Corporation.
Apple, Macintosh, Power Macintosh, LaserWriter, ImageWriter, QuickTime sont des marques enregistrées ou des noms commerciaux de Apple Computer,Inc.
Mac2Win Software Copyright © 1990-2002 est un produit de Altura Software,Inc.
4D Write contient des éléments de "MacLink Plus file translation", un produit de DataViz, Inc,55 Corporate drive,Trumbull,CT,USA.
XTND Copyright 1992-2002 © 4D SA. Tous droits réservés.
XTND Technology Copyright 1989-2002 © Claris Corporation.. Tous droits réservés ACROBAT © Copyright 1987-2002, Secret Commercial Adobe Systems Inc.Tous droits réservés. ACROBAT est une marque enregistrée d'Adobe Systems Inc.
Tous les autres noms de produits ou appellations sont des marques déposées ou des noms commerciaux appartenant à leurs propriétaires respectifs.
__________________________________________________