Manipuler des données XML avec Java et JDOM

Nicolas CYNOBER

Vous apprendrez dans cet article à manipuler des données XML avec le langage Java et l'API JDOM.

Nous étudierons les possibilités de cette API grâce à des exemples simples.

Nous apprendrons ainsi à créer un simple fichier XML, à parcourir son arborescence et à modifier son contenu.

- Titre : Manipuler des données XML avec Java et JDOM

- Auteur : Nicolas CYNOBER

- Parution : 14 janvier 2013

- Mise à jour : 8 novembre 2019

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2013 Nicolas CYNOBER. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Les origines de JDOM

- I-A. Description de SAX

- I-B. Description de DOM

- I-C. 1.3. Pourquoi JDOM ?

- II. 2. Créer un fichier XML avec JDOM

- II-A. 2.1. Téléchargement et installation l'API JDOM

- II-B. 2.2. Créer une arborescence simple

- II-C. Afficher et enregistrer son fichier XML

- III. Parcourir un fichier XML

- III-A. 3.1. Parser un fichier XML

- III-B. Parcourir une arborescence

- III-C. 3.3. Filtrer les éléments

- IV. Modifier une arborescence JDOM

- IV-A. Modifier des éléments

- IV-B. Passer de DOM à JDOM et l'inverse

- IV-C. JDOM et XSLT

- V. Conclusion

I - Les origines de JDOM

I-A - Description de SAX

SAX est l'acronyme de Simple API for XML.

Ce type de parseur utilise des événements pour piloter le traitement d'un fichier XML. Un objet (nommé handler en anglais) doit implémenter des méthodes particulières définies dans une interface de l'API pour fournir les traitements à réaliser : selon les événements, le parseur appelle ces méthodes.

Pour en savoir plus sur SAX, visitez le site officiel.

JDOM utilise des collections SAX pour parser les fichiers XML.

I-B - Description de DOM

DOM est l'acronyme de Document Object Model. C'est une spécification du W3C pour proposer une API qui permet de modéliser, de parcourir et de manipuler un document XML. Le principal rôle de DOM est de fournir une représentation mémoire d'un document XML sous la forme d'un arbre d'objets et d'en permettre la manipulation (parcours, recherche et mise à jour).

À partir de cette représentation (le modèle), DOM propose de parcourir le document, mais aussi de pouvoir le modifier. Ce dernier aspect est l'un des aspects les plus intéressants de DOM.

DOM est défini pour être indépendant du langage dans lequel il sera implémenté. DOM n'est qu'une spécification qui, pour être utilisée, doit être implémentée par un éditeur tiers. DOM n'est donc pas spécifique à Java.

Le parseur DOM pour JAVA le plus répandu est Xerces que vous pouvez trouver ici.

JDOM utilise DOM pour manipuler les éléments d'un Document Object Model spécifique (créé grâce à un constructeur basé sur SAX).

JDOM permet donc de construire des documents, de naviguer dans leur structure, s'ajouter, de modifier, ou de supprimer leur contenu.

I-C - 1.3. Pourquoi JDOM ?

Une question logique que l'on peut se poser à ce stade de l'article : Mais qu'est-ce que JDOM nous apporte de plus ?

La simplicité ! Il est en vérité très laborieux de développer des applications complexes autour de XML avec DOM, qui rappelons-le, n'a pas été développé spécifiquement pour Java.

Voyons maintenant toutes les possibilités de JDOM à travers des exemples simples.

II - 2. Créer un fichier XML avec JDOM

II-A - 2.1. Téléchargement et installation l'API JDOM

Il vous faut dans un premier temps télécharger la dernière version de JDOM disponible à cette adresse : http://www.jdom.org/dist/binary/. Il suffit ensuite de rendre accessible le fichier /build/jdom.jar, en le plaçant dans votre classpath.

II-B - 2.2. Créer une arborescence simple

La création d'un fichier XML en partant de zéro est des plus simple. Il suffit de construire chaque élément puis de les ajouter les uns aux autres de façon logique. Un nœud est une instance de org.jdom.Element.

Nous commençons donc par créer une classe JDOM1 qui va se charger de créer l'arborescence suivante :

Fichier XML

<personnes>
<etudiant classe="P2">
<nom>CynO</nom>
<etudiant>
<personnes>

JDOM1.java

import java.io.*;
import org.jdom.*;
import org.jdom.output.*;

public class JDOM1
{
//Nous allons commencer notre arborescence en créant la racine XML
//qui sera ici "personnes".
static Element racine = new Element("personnes");

//On crée un nouveau Document JDOM basé sur la racine que l'on vient de créer
static org.jdom.Document document = new Document(racine);

public static void main(String[] args)
{
//On crée un nouvel Element etudiant et on l'ajoute
//en tant qu'Element de racine
Element etudiant = new Element("etudiant");
racine.addContent(etudiant);

//On crée un nouvel Attribut classe et on l'ajoute à etudiant
//grâce à la méthode setAttribute
Attribute classe = new Attribute("classe","P2");
etudiant.setAttribute(classe);

//On crée un nouvel Element nom, on lui assigne du texte
//et on l'ajoute en tant qu'Element de etudiant
Element nom = new Element("nom");
nom.setText("CynO");
etudiant.addContent(nom);

//Les deux méthodes qui suivent seront définies plus loin dans l'article
affiche();
enregistre("Exercice1.xml");
}
}

II-C - Afficher et enregistrer son fichier XML

Nous allons afficher puis enregistrer notre arborescence.

Nous allons utiliser une unique classe pour ces deux flux de sortie : org.jdom.output.XMLOutputter, qui prend en argument un org.jdom.output.Format.

En plus des trois formats par défaut (PrettyFormat, CompactFormat et RawFormat), la classe Format contient une panoplie de méthodes pour affiner votre sérialisation.

Vous pouvez trouver une description de ces méthodes dans la javadoc.

JDOM1.java

//Ajouter ces deux méthodes à notre classe JDOM1
static void affiche()
{
try
{
//On utilise ici un affichage classique avec getPrettyFormat()
XMLOutputter sortie = new XMLOutputter(Format.getPrettyFormat());
sortie.output(document, System.out);
}
catch (java.io.IOException e){}
}

static void enregistre(String fichier)
{
try
{
//On utilise ici un affichage classique avec getPrettyFormat()
XMLOutputter sortie = new XMLOutputter(Format.getPrettyFormat());
//Remarquez qu'il suffit de créer une instance de FileOutputStream
//avec en argument le nom du fichier pour effectuer la sérialisation.
sortie.output(document, new FileOutputStream(fichier));
}
catch (java.io.IOException e){}
}

Après exécution voici le résultat obtenu (affichage sur la sortie standard et contenu du fichier « Exercice1.xml »).

Exercice1.xml

<?xml version="1.0" encoding="UTF-8"?>
<personnes>
<etudiant classe="P2">
<nom>CynO</nom>
</etudiant>
</personnes>

Nous verrons dans la troisième partie comment travailler sur un document existant, parcourir son arborescence et filtrer ses éléments.

III - Parcourir un fichier XML

III-A - 3.1. Parser un fichier XML

Parser un fichier XML revient à transformer un fichier XML en une arborescence JDOM.

Nous utiliserons pour cela le constructeur SAXBuilder, basé, comme son nom l'indique, sur l'API SAX.

Créez tout d'abord le fichier suivant dans le répertoire contenant votre future classe JDOM2 :

Exercice2.xml

<?xml version="1.0" encoding="UTF-8"?>
<personnes>
<etudiant classe="P2">
<nom>CynO</nom>
<prenoms>
<prenom>Nicolas</prenom>
<prenom>Laurent</prenom>
</prenoms>
</etudiant>
<etudiant classe="P1">
<nom>Superwoman</nom>
</etudiant>
<etudiant classe="P1">
<nom>Don Corleone</nom>
</etudiant>
</personnes>

Notre objectif ici est d'afficher dans un premier temps le nom de tous les élèves.

Nous allons créer pour cela une nouvelle classe : JDOM2.

JDOM2.java

import java.io.*;
import org.jdom.*;
import org.jdom.input.*;
import org.jdom.filter.*;
import java.util.List;
import java.util.Iterator;

public class JDOM2
{
static org.jdom.Document document;
static Element racine;

public static void main(String[] args)
{
//On crée une instance de SAXBuilder
SAXBuilder sxb = new SAXBuilder();
try
{
//On crée un nouveau document JDOM avec en argument le fichier XML
//Le parsing est terminé ;)
document = sxb.build(new File("Exercice2.xml"));
}
catch(Exception e){}

//On initialise un nouvel élément racine avec l'élément racine du document.
racine = document.getRootElement();

//Méthode définie dans la partie 3.2. de cet article
afficheALL();
}
}

III-B - Parcourir une arborescence

Nous utiliserons dans cette méthode deux classes appartenant au framework Collection (package java.util) :

- java.util.List ;

- java.util.Iterator.

Nous allons créer une liste basée sur les nœuds étudiants de notre arborescence puis nous allons la parcourir grâce à un iterator.

JDOM2.java

//Ajouter cette méthode à la classe JDOM2
static void afficheALL()
{
//On crée une List contenant tous les nœuds "etudiant" de l'Element racine
List listEtudiants = racine.getChildren("etudiant");

//On crée un Iterator sur notre liste
Iterator i = listEtudiants.iterator();
while(i.hasNext())
{
//On recrée l'Element courant à chaque tour de boucle afin de
//pouvoir utiliser les méthodes propres aux Element comme :
//sélectionner un nœud fils, modifier du texte, etc.
Element courant = (Element)i.next();
//On affiche le nom de l'élément courant
System.out.println(courant.getChild("nom").getText());
}
}

À l'exécution vous devriez voir s'afficher CynO, Superwoman et Don Corleone.

III-C - 3.3. Filtrer les éléments

Notre nouvel objectif est d'afficher la classe des étudiants dont le prénom est Laurent et le nom est CynO.

Les seuls filtres que nous ayons faits pour le moment étaient directement implémentés dans les méthodes que nous utilisions.

List listEtudiants = racine.getChildren("etudiant") nous a permis de filtrer les sous-éléments de racine selon leur nom.

Vous aurez remarqué que de toute façon nous n'avions que des étudiants, le problème ne se posait donc pas ;)

Les filtres permettent des sélections d'éléments selon plusieurs critères.

Nous allons donc créer un filtre qui permettra de ne prendre en compte que les Elements qui possèdent :

- un sous-élément nom qui doit avoir pour valeur « CynO » ;

- un sous-élément prenoms qui doit posséder au moins un sous-élément prenom dont la valeur est « Laurent ».

Une fois le filtre créé nous pourrons récupérer une liste contenant les éléments répondant à ces critères.

JDOM2.java

//Ajouter cette méthode à la classe JDOM2
//Remplacer la ligne afficheALL(); par afficheFiltre();
static void afficheFiltre()
{
//On crée un nouveau filtre
Filter filtre = new Filter()
{
//On définit les propriétés du filtre à l'aide
//de la méthode matches
public boolean matches(Object ob)
{
//1re vérification : on vérifie que les objets
//qui seront filtrés sont bien des Elements
if(!(ob instanceof Element)){return false;}

//On crée alors un Element sur lequel on va faire les
//vérifications suivantes.
Element element = (Element)ob;

//On crée deux variables qui vont nous permettre de vérifier
//les conditions de nom et de prenom
int verifNom = 0;
int verifPrenom = 0;

//2e vérification: on vérifie que le nom est bien "CynO"
if(element.getChild("nom").getTextTrim().equals("CynO"))
{
verifNom = 1;
}
//3e vérification: on vérifie que CynO possède un prenom "Laurent"
//On commence par vérifier que la personne possède un prenom,
//en effet notre fichier XML possède des étudiants sans prénom !
Element prenoms = element.getChild("prenoms");
if(prenoms == null){return false;}

//On constitue une liste avec tous les prenom
List listprenom = prenoms.getChildren("prenom");

//On effectue la vérification en parcourant notre liste de prenom
//(voir: 3.1. Parcourir une arborescence)
Iterator i = listprenom.iterator();
while(i.hasNext())
{
Element courant = (Element)i.next();
if(courant.getText().equals("Laurent"))
{
verifPrenom = 1;
}
}

//Si nos conditions sont remplies on retourne true, false sinon
if(verifNom == 1 && verifPrenom == 1)
{
return true;
}
return false;
}
};//Fin du filtre

//getContent va utiliser notre filtre pour créer une liste d'étudiants répondant
//à nos critères.
List resultat = racine.getContent(filtre);
//On affiche enfin l'attribut classe de tous les éléments de notre liste
Iterator i = resultat.iterator();
while(i.hasNext())
{
Element courant = (Element)i.next();
System.out.println(courant.getAttributeValue("classe"));
}
}

À l'exécution vous devriez voir s'afficher P2 à votre écran.

La puissance de cet outil réside dans sa capacité à être utilisé à tout moment par n'importe quel Element de votre arborescence.

Dans notre exemple, nous nous sommes servis de notre filtre JDOM comme d'un moteur de recherche.

Et il est tout à fait envisageable de créer des filtres dynamiques selon vos besoins.

Pour en savoir plus sur la classe Filter je vous invite à vous rendre ici.

IV - Modifier une arborescence JDOM

IV-A - Modifier des éléments

Nom

Arguments des surcharges

Description

addContent

Collection, String ou Content, c'est-à-dire un Element ou quoi que se soit qui peut être contenu par un nœud.

Ajoute le contenu de l'argument à la fin du contenu d'un Element. On peut spécifier un index pour l'insérer à la position voulue.

clone

Retourne un clone parfait de l'Element.

cloneContent

Comme son nom l'indique, on ne copie que le contenu.

removeAttribute

Attribut ou nom de l'attribut (String)

Supprime un attribut d'un Element.

removeChild

Nom du nœud enfant (String)

Supprime le premier enfant portant ce nom.

removeChildren

Nom des nœuds enfants (String)

Supprime tous les enfants ayant ce nom.

removeContent

Content, Index ou Filtre

Supprime l'intégralité d'un nœud donné en argument ou par sa position. removeContent accept aussi les filtres, tout comme getContent vu précédemment.

setAttribute

Attribut ou nom de l'attribut et sa valeur (String, String)

Cette méthode permet à la fois de créer un attribut et d'en modifier sa valeur.

setContent

Content

Remplace le contenu d'un Element. On peut spécifier un index si l'on ne veut pas tout remplacer.

setName

Nouveau nom de l'Element (String)

Change le nom de l'Element.

setText

Nouveau texte à insérer (String)

Change le texte contenu par l'Element. <element>TEXT</element>

toString

Retourne une représentation de l'Element sous forme de chaîne.

Pour plus de détails, je vous invite à lire la documentation de la classe Element.

Maintenant, voyons un petit exemple de modification d'arborescence.

Il vous paraîtra simpliste à côté de ce que nous avons fait jusqu'à présent, mais c'est justement le but :

Je tiens à vous montrer que JDOM c'est la simplicité avant tout !

Nous allons modifier le contenu de notre fichier Exemple2.xml en supprimant tous les Element prenoms de notre arborescence.

JDOM3.java

//Créer une nouvelle class JDOM3
import java.io.*;
import org.jdom.*;
import org.jdom.input.*;
import org.jdom.output.*;
import java.util.List;
import java.util.Iterator;

public class JDom
{
static org.jdom.Document document;
static Element racine;

public static void main(String[] args)
{
try
{
lireFichier("Exercice 2.xml");
supprElement("prenoms");
enregistreFichier("Exercice 2.xml");
}
catch(Exception e){}
}

//On parse le fichier et on initialise la racine de
//notre arborescence
static void lireFichier(String fichier) throws Exception
{
SAXBuilder sxb = new SAXBuilder();
document = sxb.build(new File(fichier));
racine = document.getRootElement();
}

//On fait des modifications sur un Element
static void supprElement(String element)
{
//Dans un premier temps on liste tous les étudiants
List listEtudiant = racine.getChildren("etudiant");
Iterator i = listEtudiant.iterator();
//On parcourt la liste grâce à un iterator
while(i.hasNext())
{
Element courant = (Element)i.next();
//Si l&#8217;étudiant possède l'Element en question on applique
//les modifications.
if(courant.getChild(element)!=null)
{
//On supprime l'Element en question
courant.removeChild(element);
//On renomme l'Element père sachant qu'une balise XML n'accepte
//ni les espaces ni les caractères spéciaux
//"étudiant modifié" devient "etudiant_modifie"
courant.setName("etudiant_modifie");
}
}
}

//On enregistre notre nouvelle arborescence dans le fichier
//d'origine dans un format classique.
static void enregistreFichier(String fichier) throws Exception
{
XMLOutputter sortie = new XMLOutputter(Format.getPrettyFormat());
sortie.output(document, new FileOutputStream(fichier));
}
}

Voici le contenu du fichier « Exemple2.xml » après exécution.

Exemple2.xml

<?xml version="1.0" encoding="UTF-8"?>
<personnes>
<etudiant_modifie classe="P2">
<nom>CynO</nom>
</etudiant_modifie>
<etudiant classe="P1">
<nom>Superwoman</nom>
</etudiant>
<etudiant classe="P1">
<nom>Don Corleone</nom>
</etudiant>
</personnes>

IV-B - Passer de DOM à JDOM et l'inverse

Il vous arrivera parfois de devoir travailler sur un document DOM.

Nous allons voir comment transformer un document DOM en un document JDOM et vice versa.

Voici une petite méthode qui reçoit en argument un document DOM et retourne un document JDOM.

//Pour être compilée cette fonction a besoin de l'importation suivante
//qui contient la classe DOMBuilder
import org.jdom.input.*;

org.jdom.Document DOMtoJDOM(org.w3c.dom.Document documentDOM) throws Exception
{
//On utilise la classe DOMBuilder pour cette transformation
DOMBuilder builder = new DOMBuilder();
org.jdom.Document documentJDOM = builder.build(documentDOM);
return documentJDOM;
}

Et maintenant, voici la fonction inverse qui reçoit en argument un document JDOM et qui retourne un document DOM.

Vous remarquerez la similitude avec la fonction précédente.

//Pour être compilée cette fonction a besoin de l'importation suivante
//qui contient la classe DOMOutputter
import org.jdom.output.*;

org.w3c.dom.Document DOMtoJDOM(org.jdom.Document documentJDOM) throws Exception
{
//On utilise la classe DOMOutputter pour cette transformation
DOMOutputter domOutputter = new DOMOutputter();
org.w3c.dom.Document documentDOM = domOutputter.output(documentJDOM);
return documentDOM;
}

IV-C - JDOM et XSLT

Grâce à l'API JAXP et TraX il est très facile de faire des transformations XSLT sur un document JDOM.

Dans l'exemple suivant, nous allons créer une méthode qui prend en entrée un document JDOM et le nom d'un fichier XSL et qui crée en sortie un fichier XML transformé.

//Pour être compilée cette fonction a besoin des importations suivantes
import java.io.*;
//JDOM
import org.jdom.transform.*;
import org.jdom.output.*;
//TrAX
import javax.xml.transform.*;
import javax.xml.transform.stream.StreamSource;

void outputXSLT(org.jdom.Document documentJDOMEntree,String fichierXSL)
{
//Document JDOMResult, résultat de la transformation TraX
JDOMResult documentJDOMSortie = new JDOMResult();
//Document JDOM après transformation
org.jdom.Document resultat = null;

try
{
//On définit un transformer avec la source XSL
//qui va permettre la transformation
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(new StreamSource(fichierXSL));

//On transforme le document JDOMEntree grâce à notre transformer.
//La méthode transform() prend en argument le document d&#8217;entrée associé au transformer
//et un document JDOMResult, résultat de la transformation TraX
transformer.transform(new org.jdom.transform.JDOMSource(documentJDOMEntree), documentJDOMSortie);

//Pour récupérer le document JDOM issu de cette transformation
//il faut utiliser la méthode getDocument()
resultat = documentJDOMSortie.getDocument();

//On crée un fichier xml correspondant au résultat
XMLOutputter outputter = new XMLOutputter(Format.getPrettyFormat());
outputter.output(resultat, new FileOutputStream("resultat.xml"));
}
catch(Exception e){}
}

V - Conclusion

Vous vous êtes maintenant rendu compte de l'utilité de JDOM dans le traitement de données XML avec Java.

Cependant, cette API est encore toute jeune et en voie d'amélioration.

Pour en apprendre plus sur JDOM et rester informé, je vous conseille les sites suivants :

- http://www.jdom.org ;

- http://java.sun.com.

Je tiens à remercier également les forums de Developpez.com pour leur aide.