I. Présentation

XMLBeans est un outil qui permet de faire du databinding Java/XML.

Il a été initié en 2003 par David Bau, de BEA, puis est devenu open source puisque cédé à la fondation Apache.

On peut télécharger la librairie sur http://xmlbeans.apache.org/

La version actuelle est 2.3.0.

Elle offre la possibilité de mapper un document XML en objets Javabeans.

Au lieu de parcourir un arbre DOM ou de faire de l'évènementiel avec SAX par exemple, on passe par des getters et setters.

On peut générer des fichiers XML à partir de classes Java, ou inversement, générer des objets Java (POJOs) à partir de fichiers XML.

Les outils utilisés dans cet article sont :

  • Eclipse 3.4 Ganymede
  • Java 1.5
  • Altova XMLSpy version 2008
  • XMLBeans 2.3.0
  • Saxon 8.8 (fichier saxonb8-8j.zip), une implémentation open-source de XSLT 2.0 et XPath 2.0, et XQuery 1.0

II. Schéma XML et DTD

Il est nécessaire de faire quelques rappels rapides.

  • Une DTD (Document Type Definition) : une DTD permet de vérifier qu'un document XML est valide. Il est valide s'il est conforme aux règles sémantiques définies dans la DTD.
  • Un schéma XML : aussi appelé XSD (XML Schema Definition), il est une alternative aux DTDs.

II-A. Validation via un Schéma XML

Vehicule1.xml
TéléchargerCacherSélectionnez

A l'aide de XMLSpy (ou tout simplement d'un browser), on peut valider le fichier XML, par rapport au schéma XML suivant.

Vehicule1.xsd
TéléchargerCacherSélectionnez

II-B. Validation via une DTD

Vehicule2.xml
TéléchargerCacherSélectionnez
Vehicule2.dtd
TéléchargerCacherSélectionnez

Les schémas XML présentent plusieurs avantages par rapport aux DTDs :

  • une syntaxe XML
  • possibilité de spécifier les types des données
  • espace de nommage (namespace), ce qui implique que les règles pour définir certains éléments seront à un certain endroit tandis que les règles pour valider les règles pour définir d'autres éléments seront à un autre endroit.

III. Exemple

Pour ce tutoriel, je vais prendre comme exemple de base le cas d'un parc automobile qu'on peut découper de la façon suivante :

parcAuto.xml
TéléchargerCacherSélectionnez

On peut automatiquement créer le Schéma XML grâce à XMLSpy :

Image non disponible

parcAuto.xsd
TéléchargerCacherSélectionnez

IV. Génération des classes

Pour utiliser XMLBeans, il faut définir la variable d'environnement XMLBEANS_HOME, elle pointe vers le répertoire d'installation de XMLBeans.

On va créer les classes Java à partir du Schéma XML.

Pour cela, il y a 2 façons de faire. Soit on passe par l'utilitaire SCOMP, soit on utilise une tâche Ant xmlbean.

IV-A. L'utilitaire SCOMP (Schema Compiler)

Dans une fenêtre DOS, on tape la commande scomp :

Image non disponible

Après avoir ajouter XMLBEANS_HOME/bin dans le PATH (set PATH=%PATH%;%XMLBEANS_HOME%\bin\), on peut taper la commande suivante :

 
Sélectionnez
  1. >scomp -src src -javasource 1.5 -out parcAuto.xsd  

Image non disponible

Note: pour éviter d'avoir un java.io.IOException, il faut modifier le script scomp.cmd en changeant la ligne suivante :

 
Sélectionnez
  1. java -classpath "%cp%" org.apache.xmlbeans.impl.tool.SchemaCompiler %* 

par

 
Sélectionnez
  1. %JAVA_HOME%/bin/java -classpath "%cp%" org.apache.xmlbeans.impl.tool.SchemaCompiler %* 

On obtient la hiérachie suivante :

 
Sélectionnez
  1.     D:\tutorielXMLBeans\   
  2.     D:\tutorielXMLBeans\parcAuto.xsd   
  3.     D:\tutorielXMLBeans\xmltypes.jar  (contient les classes compilées et des fichiers XSB nécessaires à XMLBeans)   
  4.     D:\tutorielXMLBeans\src (contient les interfaces et classes générées)   
  5.     D:\tutorielXMLBeans\src\noNamespace (pas de namespace dans le Schema)   
  6.     D:\tutorielXMLBeans\src\noNamespace\CouleurDocument.java   
  7.     D:\tutorielXMLBeans\src\noNamespace\MarqueDocument.java (type complexe Marque)   
  8.     D:\tutorielXMLBeans\src\noNamespace\NombreDocument.java   
  9.     D:\tutorielXMLBeans\src\noNamespace\NomDocument.java   
  10.     D:\tutorielXMLBeans\src\noNamespace\ParcautomobileDocument.java (element racine Parcautomobile)   
  11.     D:\tutorielXMLBeans\src\noNamespace\PuissanceDocument.java   
  12.     D:\tutorielXMLBeans\src\noNamespace\VehiculeDocument.java  (type complexe Vehicule)   
  13.     D:\tutorielXMLBeans\src\noNamespace\impl   
  14.     D:\tutorielXMLBeans\src\noNamespace\impl\CouleurDocumentImpl.java   
  15.     D:\tutorielXMLBeans\src\noNamespace\impl\MarqueDocumentImpl.java   
  16.     D:\tutorielXMLBeans\src\noNamespace\impl\NombreDocumentImpl.java   
  17.     D:\tutorielXMLBeans\src\noNamespace\impl\NomDocumentImpl.java   
  18.     D:\tutorielXMLBeans\src\noNamespace\impl\ParcautomobileDocumentImpl.java   
  19.     D:\tutorielXMLBeans\src\noNamespace\impl\PuissanceDocumentImpl.java   
  20.     D:\tutorielXMLBeans\src\noNamespace\impl\VehiculeDocumentImpl.java   

Il faut inclure le jar xmltypes.jar dans le CLASSPATH.

IV-B. Tâche Ant xmlbean

Une tâche ANT existe pour compiler un fichier XSD en classe XMLBeans. Elle permet d'obtenir un fichier JAR mais aussi le code source.

build.xml
TéléchargerCacherSélectionnez

Après lancement de la tâche, on obtient la hiérarchie suivante dans Eclipse :

Image non disponible

L'archive tuto.jar contient les fichiers XSB et est à mettre dans le build path du projet :

Image non disponible

V. Génération d'un fichier XML

Grâce aux classes engendrées par XMLBeans, on peut manipuler les différents éléments XML comme des objets java Beans.

Chaque interface possède une classe factory avec une méthode statique newInstance() pour créer une instance du type de la classe.

Les valeurs fixes sont représentées avec des énumérations.

On valide par rapport au schéma XML l'instance nouvellement créée avec la méthode validate() de l'interface XmlObject.

GenerationXML.java
Sélectionnez
  1. package com.developpez.tutoriel;   
  2.    
  3. import java.io.File;   
  4. import java.io.IOException;   
  5.    
  6. import noNamespace.ParcautomobileDocument;   
  7. import noNamespace.CouleurDocument.Couleur;   
  8. import noNamespace.MarqueDocument.Marque;   
  9. import noNamespace.NomDocument.Nom;   
  10. import noNamespace.ParcautomobileDocument.Parcautomobile;   
  11. import noNamespace.PuissanceDocument.Puissance;   
  12. import noNamespace.VehiculeDocument.Vehicule;   
  13. import noNamespace.VehiculeDocument.Vehicule.Modele;   
  14.    
  15. import org.apache.xmlbeans.XmlOptions;   
  16.    
  17. public class GenerationXML {   
  18.        
  19.      public static void main(String[] args) throws IOException   
  20.       {             
  21.             //parc est une instance du document XML   
  22.             ParcautomobileDocument parc = ParcautomobileDocument.Factory.newInstance();   
  23.                
  24.             //ajout d'un tag Parcautomobile au document XML   
  25.             Parcautomobile parcautomobile = parc.addNewParcautomobile();   
  26.                
  27.             // ajout d'un Vehicule au parc automobile   
  28.             Vehicule vehicule1 = parcautomobile.addNewVehicule();                          
  29.             vehicule1.setModele(Modele.COUPE);   
  30.                
  31.             //Vehicule de modèle COUPE, 1ère marque    
  32.             Marque marque1 = vehicule1.addNewMarque();   
  33.             marque1.setNom(Nom.RENAULT);   
  34.                
  35.             Puissance puissance1 = Puissance.Factory.newInstance();            
  36.             puissance1.setChevaux((byte)8);   
  37.             puissance1.setVitessemax((short)280);              
  38.             marque1.setPuissance(puissance1);      
  39.             marque1.setNombre((byte)18);   
  40.             marque1.setCouleur(Couleur.NOIR);   
  41.                
  42.             //Vehicule de modèle COUPE, 2ème marque    
  43.             Marque marque2 = vehicule1.addNewMarque();   
  44.             marque2.setNom(Nom.PEUGEOT);   
  45.                
  46.             Puissance puissance2 = Puissance.Factory.newInstance();            
  47.             puissance2.setChevaux((byte)11);   
  48.             puissance2.setVitessemax((short)320);              
  49.             marque2.setPuissance(puissance2);      
  50.             marque2.setNombre((byte)10);   
  51.             marque2.setCouleur(Couleur.ROUGE);   
  52.                                    
  53.             // ajout d'un Vehicule au parc automobile   
  54.             Vehicule vehicule2 = parcautomobile.addNewVehicule();                          
  55.             vehicule2.setModele(Modele.BERLINE);   
  56.                
  57.             //Vehicule de modèle COUPE, 1ère marque    
  58.             Marque marque3 = vehicule2.addNewMarque();   
  59.             marque3.setNom(Nom.MERCEDES);   
  60.                
  61.             Puissance puissance3 = Puissance.Factory.newInstance();            
  62.             puissance3.setChevaux((byte)10);   
  63.             puissance3.setVitessemax((short)330);              
  64.             marque3.setPuissance(puissance3);      
  65.             marque3.setNombre((byte)9);   
  66.             marque3.setCouleur(Couleur.GRIS);   
  67.                
  68.             //Vehicule de modèle COUPE, 2ème marque    
  69.             Marque marque4 = vehicule2.addNewMarque();   
  70.             marque4.setNom(Nom.BMW);   
  71.                
  72.             Puissance puissance4 = Puissance.Factory.newInstance();            
  73.             puissance4.setChevaux((byte)12);   
  74.             puissance4.setVitessemax((short)300);              
  75.             marque4.setPuissance(puissance4);      
  76.             marque4.setNombre((byte)7);   
  77.             marque4.setCouleur(Couleur.BLEU);   
  78.                
  79.             // Validation de l'instance du schema XML   
  80.               boolean estValide = parc.validate();   
  81.                
  82.               if (! estValide){   
  83.                    System.err.println("Attention, cette instance du schema n'est pas valide ! ");   
  84.                    return;   
  85.               }   
  86.                
  87.             XmlOptions opts = new XmlOptions();   
  88.             //cette option permet d'indenter le code    
  89.             opts.setSavePrettyPrint();   
  90.                
  91.             System.out.println(parc.xmlText(opts));   
  92.             parc.save(new File ("d:/parcAuto.xml"), opts);       
  93.       }   
  94. }   

On obtient en sortie un fichier XML parcAuto.xml identique au précédent.

VI. Parsing d'un fichier XML

Et inversement, il est possible de parcourir un fichier XML de façon totalement objet.

On utilise la méthode parse() de l'interface ParcautomobileDocument pour charger le fichier et ensuite le parcourir.

ParseXML.java
TéléchargerCacherSélectionnez

Sortie de la console :

 
TéléchargerCacherSélectionnez

VII. L'interface XMLCursor

L'interface XmlCursor fournit une navigation efficace dans un arbre XML, à la manière d'un curseur en PL/SQL.

Le curseur représente un endroit spécifique (noeud) dans le document XML.

Dans l'API XMLCursor, un document XML est constitué par des tokens.

Concrètement, un token est soit un type d'attribut, soit un début d'élément, soit une fin d'élément etc.

Exemple: on peut insérer un nouveau modèle de véhicule au niveau de l'élément racine <parcautomobile> , au tout début.

InsertionXML.java
TéléchargerCacherSélectionnez

Résultat de l'insertion :

 
TéléchargerCacherSélectionnez

VIII. XQuery

Pour une recherche avancée dans le document XML, on doit passer par Xquery.

XQuery est à XML ce que SQL est aux bases de données.

Si on veut récupérer dans le document XML le nombre de Peugeot dans le parc automobile, on peut naviguer dans l'arbre pour aller se positionner directement sur le sous-élément <nombre> de l'élément <marque> , lui-même sous-élément de l'élément <vehicule modele="coupe">.

La méthode execQuery(queryExpression) de l'interface XmlCursor prend en paramètre une expression Xquery.

Note: il est nécessaire d'installer la librairie Saxon (processor XSLT et XQuery).
En effet, pour des raisons d'incompatibilités de licences, cette librairie n'est malheureusement pas incluse dans XMLBeans.

InsertionXML.java
TéléchargerCacherSélectionnez

Résultat :

 
TéléchargerCacherSélectionnez

Note: il existe une autre interface graphique, beaucoup plus simple que XMLSpy, pour rapidement tester les requêtes XQuery, à savoir XQuisitor.

IX. XPath

On peut passer par des expressions XPath, que l'on donne en paramètre de la méthode selectPath(String).

Elle retourne des sélections.

Et on navigue ensuite à l'aide de la méthode toNextSelection(), pour itérer à travers les sélections.

Exemple : afficher tous les noms de marque de vehicules dans le fichier XML.

XpathXML.java
TéléchargerCacherSélectionnez

Résultat de la recherche :

 
TéléchargerCacherSélectionnez

X. Liens