Java API pour parser un fichier XML

• Working with XML. The Java API for Xml Parsing (JAXP) Tutorial

Parser SAX vs parseur DOM

SAX

Faire l'écho du contenu d'un fichier XML avec un parseur SAX

• juste pour fins d'illustration
• approche plus simple: construire un arbre DOM et utiliser les fonctions prédéfinies

Créer un squelette

public class DomEcho01 {

  public static void main(String argv[]) {
    if (argv.length != 1) {
      System.err.println("Usage: java DomEcho filename");
      System.exit(1);
    }
  }
}

Importer les APIs SAX que nous allons utiliser

import java.io.*;
import org.xml.sax.*;
import org.xml.sax.helpers.DefaultHandler;
import javax.xml.parsers.SAXParserFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;

• import org.xml.sax définit les interfaces que nous allons utiliser pour le parseur SAX.
• La classe SAXParserFactory crée l'instance que nous utilisons. Elle déclenche ParserConfigurationException si elle n'est pas capable de produire un parseur correspondant aux options de la configuration.
• SAXParser est le parseur créé par SAXParserFactory.
• DefaultHandler est la classe pour traiter les événements SAX générés par le parser.

Préparer E/S

public static void main(String argv[]) {
  if (argv.length != 1) {
    System.err.println("Usage: cmd filename");
    System.exit(1);
  }
  try {
    // Set up output stream
    out = new OutputStreamWriter(System.out, "UTF8");

  } catch (Throwable t) {
      t.printStackTrace();
  }
  System.exit(0);
}

Implémenter l'interface ContentHandler

• L'interface contient plusieurs méthodes appelées par le parseur SAX comme réponse aux différents événements. Elle contient, en outre, les méthodes startDocument, endDocument, startElement, endElement et characters.

  Méthode	Description
  startDocument()	Début du document.
  endDocument()	Fin du document.
  startElement(String nsURI,String name,String qName,Attributes atts)	Élément ouvrant. nsURI est l'URI de l'espace de noms de l'élément, name son nom, qName son nom avec le préfixe de l'espace de noms et atts la liste des attributs.
  endElement(String nsURI,String name,String qName)	Élément fermant. Les attributs ont la même signification que pour l'élément ouvrant.
  characters(char[] ch,int start,int length)	Texte passé sous forme d'un tableau de caractère, un indexe de début et la longueur du texte.

• Une facon simple d'implémenter cette interface est d'étendre la classe DefaultHandler, définie dans le package org.xml.sax.helpers. La classe fournit les implémentations vides pour tous les événements de l'interface ContentHandler.

public class Echo extends DefaultHandler {
  ...
}

• DefaultHandler fournit aussi les implémentations vides pour les événements définis dans les interfaces DTDHandler, EntityResolver et ErrorHandler.
• Chacune des méthods de l'interface ContentHandler est requise d'avoir "throw SAXException" dans son en-tête. L'exception déclenchée est renvoyée au parseur qui la renvoie au code qui a appelé le parser (la methode main).

Établir un parseur

public static void main(String argv[]) {
  if (argv.length != 1) {
    System.err.println("Usage: cmd filename");
    System.exit(1);
  }

  // Use an instance of ourselves as the SAX event handler
  DefaultHandler handler = new Echo();

  // Use the default (non-validating) parser
  SAXParserFactory factory = SAXParserFactory.newInstance();
  try {
    // Set up output stream
    out = new OutputStreamWriter(System.out, "UTF8");
    // Parse the input
    SAXParser saxParser = factory.newSAXParser();
    saxParser.parse( new File(argv[0]), handler );
  } catch (Throwable t) {
    t.printStackTrace();
  }
  System.exit(0);
}

Écriture dans un fichier de sortie

  static private Writer out;

  private void emit(String s) throws SAXException {
    try {
      out.write(s);
      out.flush();
    } catch (IOException e) {
    throw new SAXException("I/O error", e);
    }
  }
  ...

  private void nl() throws SAXException {
    String lineEnd =  System.getProperty("line.separator");
    try {
      out.write(lineEnd);
    } catch (IOException e) {
      throw new SAXException("I/O error", e);
    }
  }

Traitement d'événements

  public void startDocument() throws SAXException {
    emit("<?xml version='1.0' encoding='UTF-8'?>");
    nl();
  }

  public void endDocument() throws SAXException {
    try {
      nl();
      out.flush();
    } catch (IOException e) {
      throw new SAXException("I/O error", e);
    }
  }

  public void startElement(String namespaceURI,
                           String sName, // simple name (localName)
                           String qName, // qualified name
                           Attributes attrs) throws SAXException {
    String eName = sName; // element name
    if ("".equals(eName)) eName = qName; // not namespace-aware
    emit("<" + eName);
    if (attrs != null) {
      for (int i = 0; i < attrs.getLength(); i++) {
        String aName = attrs.getLocalName(i); // Attr name
        if ("".equals(aName)) aName = attrs.getQName(i);
        emit(" ");
        emit(aName+"=\""+attrs.getValue(i)+"\"");
      }
    }
    emit(">");
  }

  public void endElement(String namespaceURI,
                         String sName, // simple name
                         String qName  // qualified name
                        ) throws SAXException {
    String eName = sName; // element name
    if ("".equals(eName)) eName = qName; // not namespace-aware
    emit("</"+eName+">");
  }

• localName - nom local (sans préfixe) ou la chaîne vide si le traitement de Namespace n'est pas effectué
• qName - nom qualifié (avec préfixe) ou la chaîne vide si noms qualifiés ne sont pas disponibles

  public void characters(char buf[], int offset, int len) throws SAXException {
    String s = new String(buf, offset, len);
    emit(s);
  }

Résultats

<?xml version='1.0' encoding='UTF-8'?>
<slideshow title="Sample Slide Show" date="Date of publication" author="Yours Truly">


    <slide type="all">
      <title>Wake up to WonderWidgets!</title>
    </slide>


    <slide type="all">
      <title>Overview</title>
      <item>Why <em>WonderWidgets</em> are great</item>
      <item>
      <item>Who <em>buys</em> WonderWidgets</item>
    </slide>

</>