Kapitel 3. XML-Prozessoren. Document Object Model Simple API for XML DOM SAX

Transkript

1 Kapitel 3 XML-Prozessoren DOM SAX Document Object Model Simple API for XML

2 Anforderungen Verarbeitung von XML Suchen und Ändern in bzw. von XML-Dokumenten gewünscht Schnittstellen für Anwendungen, die Information in Form von XML- Dokumenten verwalten und verarbeiten XML-Prozessoren machen den Inhalt eines XML-Dokuments für Anwendungen verfügbar Parsen des Dokuments und Auflösen von Entities Überprüfen der Gültigkeit und Schemakonformität XML-Prozessoren bieten standardisierte Schnittstellen für zahlreiche Programmiersprachen, z.b. Java, Phyton,, C, C++,... Arten von XML-Prozessoren: Baumorientiert (DOM) Ereignisorientiert (SAX) beide sind jedoch prozedural! XML-Anwendung XML-Prozessor (XML-Engine)? 3-2

3 DOM Document Object Model (DOM) beschreibt ausschliesslich Schnittstellen (APIs) zum Zugriff auf XML- Dokumente und zur Veränderung von Struktur und Inhalten definiert nicht die zugrunde liegende Implementierung und Speicherung der XML-Dokumente W3C Recommendation Objektorientierte Sicht auf XML-Dokumente XML-Dokumente intern als Bäume repräsentiert unterschiedliche Knotentypen: Element, Attribut, etc. Methoden zur Traversierung und Manipulation der Baumstruktur Es gibt zahlreiche DOM-Implementierungen, z.b. Java (+ XML-Parser) JavaScript und Web-Browser C++-Bibliotheken 3-3

4 DOM Illustration <?xml version="1.0"?> <bookstore> <book price='8.99'> <title> The Autobiography of Benjamin Franklin </title> <author> Benjamin Franklin </author> </book> </bookstore> Knoten vom Typ: DOCUMENT Knoten vom Typ: ELEMENT bookstore book title author price Knoten vom Typ: ATTR The Autobiography of Benjamin Franklin Benjamin Franklin 8.99 Knoten vom Typ: TEXT 3-4

5 Verarbeitung von XML: DOM XML-Anwendung XML-Prozessor (XML-Engine) DOM- Methoden Anwendung behält Kontrolle über den Ablauf Zugriff erfolgt mit den von DOM standardisierten Methoden 3-5

6 DOM-Schnittstellenhierarchie DOMImplementation Node NodeList NamedNodeMap Attr CharacterData Comment Text CDataSection Document DocumentFragment DOM spezifiziert nur Schnittstellen DOM-Anwender muss sich eine Klassenbibliothek besorgen, die diese Schnittstellen implementiert DocumentType Element Entity EntityReference Notation ProcessingInstruction 3-6

7 definiert Methoden zur Identifikation des Knotentyps DOM-Schnittstelle "Node" (1) Navigation durch die Dokumentstruktur Manipulation der Dokumentstruktur interface Node { // Attributdefinitionen readonly attribute DOMString readonly attribute unsigned short readonly attribute Node readonly attribute NodeList readonly attribute NamedNodeMap nodename; nodetype; parentnode; childnodes; attributes; // Methodendeklarationen (siehe nächste Folie) 3-7

8 DOM-Schnittstelle "Node" (2) // Ausgewählte der Methoden der Schnittstelle Node // Lesende Methoden Node get_documentelement() // liefert das Wurzelelement NodeList get_childnodes() // liefert alle Kindknoten Node get_firstchild() // liefert ersten Kindknoten Node get_lastchild() // liefert letzten Kindknoten Node get_parentnode() // liefert Elternknoten Node get_nextsibling() // liefert nächsten Geschwisterknoten Node get_previoussibling() // liefert vorhergehenden Geschwisterknoten unsigned short get_nodetype() // liefert Knotentyp DOMString get_nodevalue() // liefert assoziierten Knotenwert // Änderungsmethoden Node appendchild(node neu) // hängt Kindknoten an Node insertbefore(node neu, Node alt) // fügt Kindknoten vor einen anderen ein Node removechild(node alt) // entfernt spezifizierten Kindknoten Node replacechild(node neu, Node alt) // ersetzt Kindknoten durch einen anderen 3-8

9 DOM-Methoden Methoden zur Navigation durch das Dokument Ausgehend vom Knoten liefern folgende Methoden der Klasse Node die Knoten bzw. Knotenlisten als Ergebnis: getparentnode() 2 - getfirstchild() getlastchild() 4 - getchildren() getprevioussibling() 6 - getnextsibling() 3-9

10 DOM-Methoden Methoden zur Manipulation eines Dokuments A A insertbefore(k, G) B D B D F K G F G K A appendchild(k) B D F G replacechild(g, K) A A removechild(g) B D B D F F K 3-10

11 DOM-Schnittstellen "Element" und "Attr" Attr" interface Element : Node { // Attributdefinitionen readonly attribute DOMString tagname; // Methodendeklarationen DOMString gettagname() // liefert Tagnamen eines Elementes Attr getattributenode(domstring name) // liefert angegebenes Attribut Attr setattributenode(attr neu) // setzt bzw. fügt neues Attribut ein Attr removeattributenode(attr alt) // löscht spezifiziertes Attribut NodeList getelementsbytagname(domstring name) // liefert alle Elemente, die den // spezifizierten Elementnamen haben interface Attr : Node { // Attributdefinitionen readonly attribute DOMString name; attribute DOMString value; readonly attribute boolean specified; readonly attribute Element ownerelement; readonly attribute TypeInfo schematype; 3-11

12 DOM-Schnittstelle "CharacterData" CharacterData" interface CharacterData : Node { // Attributdefinitionen attribute DOMString data; readonly attribute unsigned long length; // Methodendeklarationen substringdata(start, count) appenddata(text) replacedata(offset, count, text) insertdata(offset, text) deletedata(offset, count) // liefert Teil der Zeichenkette // hängt Text an die Zeichenkette an // ersetzt Teil der Zeichenkette // fügt Text in die Zeichenkette ein // löscht Teil der Zeichenkette 3-12

13 DOM-Schnittstelle "Document" Document" interface Document : Node { // Attributdefinitionen readonly attribute DocumentType doctype; readonly attribute DOMImplementation implementation; readonly attribute Element documentelement; attribute DOMString documenturi; // Methodendeklarationen Element DocumentFragment Text Comment CDATASection Attr EntityReference NodeList Element createelement(in DOMString tagname); createdocumentfragment(); createtextnode(in DOMString data); createcomment(in DOMString data); createcdatasection(in DOMString data); createattribute(in DOMString name); createentityreference(in DOMString name); getelementsbytagname(in DOMString tagname); getelementbyid(in DOMString elementid); Neue Objekte werden mit bereits gezeigten Methoden in den Baum eingefügte 3-13

14 DOM-Anwendung (1) // This file demonstrates a simple use of the parser and DOM API. The XML file that is given // to the application is parsed and the elements and attributes in the document are printed. // The use of setting the parser options is demonstrated. import java.io.*; import java.net.*; import org.w3c.dom.*; import org.w3c.dom.node; import oracle.xml.parser.v2.domparser; public class DOMSample { static public void main(string[] argv) { DOMParser parser = new DOMParser(); URL url = createurl(argv[0]); parser.seterrorstream(system.err); parser.setvalidationmode(true); parser.showwarnings(true); parser.parse(url); Document doc = parser.getdocument(); // get an instance of the parser // generate a URL from the filename // set various parser options: error stream set to stderr // validation on // warnings shown // parse the document // obtain the document System.out.print("The elements are: "); printelements(doc); // print document elements System.out.println("The attributes of each element are: "); printelementattributes(doc); // print document element attributes // go on with the next foil 3-14

15 DOM-Anwendung (2) static URL createurl(string filename) { URL url = null; // here we omit the checking whether // the filename is a correct path expression url = new URL(fileName); return url; static void printelements(document doc) { NodeList nl = doc.getelementsbytagname("*"); Node n; for (int i=0; i<nl.getlength(); i++) { n = nl.item(i); System.out.print(n.getNodeName() + " "); System.out.println(); // go on with the right column static void printelementattributes(document doc) { NodeList nl = doc.getelementsbytagname("*"); Element e; Node n; NamedNodeMap nnm; String attrname; String attrval; int i, len; len = nl.getlength(); for (int j=0; j < len; j++) { e = (Element)nl.item(j); System.out.println(e.getTagName() + ":"); nnm = e.getattributes(); if (nnm!= null) { for (i=0; i<nnm.getlength(); i++) { n = nnm.item(i); attrname = n.getnodename(); attrval = n.getnodevalue(); System.out.print(" " + attrname + " = " +attrval); System.out.println(); // end class DOMSample 3-15

16 Simple API for XML (SAX) Vorgehensweise: XML-Engine liest sequentiell den Eingabestrom (Dokument) prüft die Korrektheit und ruft Callback-Methoden bei Eintreten von Ereignissen auf, z.b. wenn ein Beginoder End-Tag abgearbeitet wird Anwendung kann auf diese Ereignisse reagieren oder sie ignorieren Anwendungsprogrammierer muss "Event-Handler" für die Callback-Methoden implementieren, an deren Ereignisse er interessiert ist XML-Engine kontrolliert den Ablauf SAX triggert Anwendung durch Aufruf von Callback-Methoden standardisiert die Schnittstellen der Callback-Methoden erleichtert das Vermeiden einer mehrfachen internen Repräsentationen eines XML-Dokuments, da nur temporäre Strukturen für Ereignisse benötigt werden 3-16

17 Verarbeitung von XML: SAX XML-Anwendung Aufruf für XML-Dokumente XML-Prozessor (XML-Engine) Callback- Methoden Callback-Methoden: XML-Prozessor hält Kontrolle 3-17

18 SAX-Architektur Architektur Handler #1 Parser Anwendungsprogramm Ereignisstrom Dispatcher Auslösende Muster ("Trigger") Callback, mit dem Ereignis als Parameter Anmeldung der Handler Handler #2... Handler #n Ereignisse sind das Vorkommen der XML-spezifischen Konstrukte, z.b. Elemente, Text-Bestandteile, Kommentare 3-18

19 Beispiel: XML-Baum Baum-Traversierung <?xml version="1.0"?> <book price= 8.99 > <title> The Autobiography of Benjamin Franklin </title> <author> <first-name> Benjamin </first-name> <last-name> Franklin startdocument() startelement("book", AttributeList(length=1, {name='price', type='pcdata', value='8.99') startelement("title", null) characterdata("the Autobiography of Benjamin Franklin", start, length) endelement("title") startelement("author", null) startelement("first-name", null) characterdata(benjamin", start, length) endelement("first-name") startelement("last-name", null) character("franklin", start, length) </last-name> endelement("last-name") </author> endelement("author") </book> endelement("book") enddocument() Abarbeitungsreihenfolge ist fest vorgegeben, wir können nicht z.b. auf Breitensuche umschalten 3-19

20 SAX-Schnittstellen Schnittstellen Schnittstellen für Parser-Implementierer Parser: Registrierung von Event-Handler für Callbacks AttributeList: Iteration durch eine Attributliste Locator: Positionierung im XML-Dokument Schnittstellen für Anwendungsentwickler DocumentHandler: Implementierung von Event-Handler-Methoden ErrorHandler: Spezielle Fehlerbehandlung DTDHandler: Arbeiten mit Notationen und Entities EntityResolver: "Umbiegen" von URIs im Dokument 3-20

21 Beispiel: SAX-Anwendung Anwendung (1) import java.io.filereader; import org.xml.sax.xmlreader; import org.xml.sax.attributes; import org.xml.sax.inputsource; import org.xml.sax.helpers.xmlreaderfactory; import org.xml.sax.helpers.defaulthandler; public class MySAXApp extends DefaultHandler { public static void main (String args[]) throws Exception { XMLReader xr = XMLReaderFactory.createXMLReader(); MySAXApp handler = new MySAXApp(); xr.setcontenthandler(handler); xr.seterrorhandler(handler); // parse each file provided on the command line for (int i = 0; i < args.length; i++) { FileReader r = new FileReader(args[i]); xr.parse(new InputSource(r)); public MySAXApp () { super(); // overload event handlers (instead of explicitly registering them) public void startdocument () { System.out.println("Start document"); public void enddocument () { System.out.println("End document"); // go on with the next foil 3-21

22 Beispiel: SAX-Anwendung Anwendung (2) public void startelement (String uri, String name, String qname, Attributes atts) { if ("".equals (uri)) System.out.println("Start element: " + qname); else System.out.println("Start element: {" + uri + "" + name); public void endelement (String uri, String name, String qname) { if ("".equals (uri)) System.out.println("End element: " + qname); else System.out.println("End element: {" + uri + "" + name); public void characters (char ch[], int start, int length) { System.out.print("Characters: \""); for (int i = start; i < start + length; i++) { switch (ch[i]) { case '\\': System.out.print("\\\\"); break; case '"': System.out.print("\\\""); break; case '\n': System.out.print("\\n"); break; case '\r': System.out.print("\\r"); break; case '\t': System.out.print("\\t"); break; default: System.out.print(ch[i]); break; System.out.print("\"\n"); // end of class MySAXApp 3-22

23 Beispiel: SAX-Anwendung Anwendung (3) <?xml version="1.0"?> <poem xmlns=" <title>roses are Red</title> <l>roses are red,</l> <l>violets are blue;</l> <l>sugar is sweet,</l> <l>and I love you.</l> </poem> Eingabedokument Ausgabe Start document Start element: { Characters: "\n" Start element: { Characters: "Roses are Red" End element: { Characters: "\n" Start element: { Characters: "Roses are red," End element: { Characters: "\n" Start element: { Characters: "Violets are blue;" End element: { Characters: "\n" Start element: { Characters: "Sugar is sweet," End element: { Characters: "\n" Start element: { Characters: "And I love you." End element: { Characters: "\n" End element: { End document 3-23

24 Vergleich DOM versus SAX SAX einfacher Zugriff einfach strukturierte oder gleichartig strukturierte Dokumente auch geeignet für sehr große XML- Dokumente Zugriff nur auf geringe Anteile eines Dokuments DOM Navigation durch Dokumentstruktur dadurch kontextabhängige Zugriffe Manipulation der Struktur für sehr große XML-Dokumente problematisch auch Speicherungsstruktur Beide Schnittstellen sind standardisiert und viele Implementierungen ngen vorhanden: Portabilität, Plattformunabhängigkeit Beide Ansätze erlauben KEINEN deklarativen, d.h., mengenorientierten rten Zugriff wie bei SQL auf die Daten in den XML-Dokumenten Programmieraufwand nötig (selbst für einfache Probleme) Wie lernen später Techniken kennen, die genau dieses Problem lösen! 3-24