SAX Simple API for XML

Transkript

1 SAX Simple API for XML

2 Was ist SAX? SAX definiert ein API für einen Event basierten Parser Funktioniert wie ein serieller I/O Stream(kein random access)

3 SAX Wozu? Schnelles, effizientes Lesen von XML Daten Wenig Speicher zur Verfügung Nur, wenn keine Änderungen in der XML Struktur nötig sind

4 Wie funktioniert SAX? XML Dokument <name> <first_name> Alan </first_name> <last_name> Turing </last_name> </name> SAX-Parser startelement() startelement() characters() endelement() startelement() characters() endelement() endelement()

5 Sax Packages SAXParserFactory zum Erzeugen eines SAXParsers(mit verschiedenen parse Methoden. Die Interfaces ContentHandler (start/ enddocument, start/ end- Element, characters,...) ErrorHandler(warning, error, fatalerror). werden alle von der Convenience- Klasse DefaultHandlerleer implementiert.

6 Parsen mit SAX Main SAXParser ContentHandler ErrorHandler parse() start/enddocument() XML Document start/endelement() characters() Application EventHandler

7 MyDefaultHandler import org.xml.sax.*; import org.xml.sax.helpers.*; public class MyDefaultHandler extends DefaultHandler { // implementation of start/end Methods }...

8 startdocument / enddocument public void startdocument() throws SAXException { } //Initialisierung zu Beginn des Dokuments public void enddocument() throws SAXException { } //ev. Aufräumen am Ende des Dokuments

9 startelement public void startelement( String uri, // Namespace URI String lname, // lokaler Name String qname, Attributes attrs ) // Attribut Liste throws SAXException { } // Initialisieren des Elements und // Verarbeiten der Attribute // qualifizierter Name

10 Attribute // Verarbeiten der Attribute if (attrs!= null) { for(int i=0; i<attrs.getlength(); i++) { // Attribut Name String aname = attrs.getlocalname(i); } } // Attribut Wert String val = attrs.getvalue(i);

11 characters StringBuffer textbuffer = new StringBuffer(); public void characters( char buf[], // die Zeichen aus dem XML // Dokument int start, // die Start-Position im Array int length ) // die Anzahl Zeichen, welche // gelesen werden können throws SAXException { } // Auslesen der Zeichen aus dem Puffer buf textbuffer.append(buf, start, length);

12 endelement public void endelement( String uri, // Namespace URI String lname, // lokaler Name String qname ) // qualifizierter Name throws SAXException { } // Inhalt des Elements verarbeiten // ev. aufräumen.

13 Weitere Methoden processinginstruction() beim Auftreten einer Verarbeitungs-Anweisung startprefixmapping() / endprefixmapping() am Anfang/Ende des Setzen eines Namespace Prefix

14 Fehlerbehandlung warning (SAXParseException e) Fehler in Schema oder DTD (validierender Parser) error (SAXParseException e) XML Dokument ist nicht gültig (gemäss Schema oder DTD) fatalerror (SAXParseException e) XML Dokument ist nicht wohlgeformt e.getlinenumber() e.getcolumnnumber() e.getlocalizedmessage()

15 SAX Beispiel: Initialisierung public static void main(string[] args) { try { File inputfile = new File(fileName); SAXParserFactory factory = SAXParserFactory.newInstance(); SAXParser saxparser = factory.newsaxparser(); SchemaFactory schemafactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI); Schema schema = schemafactory.newschema(new File(schemaName)); factory.setschema(schema); SAXExample handler = new SAXExample(); // DefaultHandler saxparser.parse(inputfile, handler); } catch (... e) { } //... Behandlung von allen Exceptions

16 SAX Beispiel public class SAXExample extends DefaultHandler public void startdocument() { System.out.println("StartDocument"); public void enddocument() { System.out.println("EndDocument"); public void startelement(string uri, String lname, String qname, Attributes attrs) { System.out.println("StartElement: " + qname); for (int i = 0; i < attrs.getlength(); i++) System.out.println(" " + attrs.getlocalname(i)+"="+ attrs.getvalue(i)); public void endelement(string uri, String lname, String qname) { System.out.println("EndElement: " + qname); }

17 XML DOM Document Object Model

18 Was ist DOM? DOM ist ein W3C Standard. DOM definiert einen Standard zum Lesen und Bearbeiten von XML Dokumenten. DOM stellt XML Dokumente als Baumstruktur dar. DOM definiert eine Menge von Interfaces (Node, NodeList, Element, Attr,...) und eine Menge von Methoden darauf. DOM ist plattform-und sprach-unabhängig definiert.

19 DOM Document create Das DOM Document ist ein Baum, das aus den einzelnen Knoten des XML Dokuments besteht. parse

20 Die wichtigsten DOM Knoten Node node- Name() node- Value() attributes node- Type() Attr name of attribute value of attribute null 2 Element tag name null Text #text content of text node Named- NodeMap 1 null 3 Document #document null null 9

21 Die Java Interfaces in org.w3c.dom Attr CDATASection CharacterData Document DocumentFragment DocumentType DOMError DOMErrorHandler Element Node NodeList Processing- Instruction Text

22 Das Node Interface NamedNodeMap getattributes() NodeList getchildnodes() Node getfirstchild() / getlastchild() String getlocalname() / getnamespaceuri() String getnodename() short getnodetype() / String getnodevalue() Node appendchild(node newchild) Node removechild(node oldchild)

23 Die NodeList Interface public interface NodeList eine geordnete Liste von Nodes int getlength() Die Anzahl Elemente der NodeList Node item(int n) Gibt das n-te Element der Liste zurück (beginnend bei 0).

24 Das Document Interface NodeList getelementsbytagname(string tagname) NodeList getelementsbytagnamens(string ns, String lname ) Element getelementbyid(string elementid) void normalizedocument()

25 Das Element Interface String getattribute(string name) void setattribute(string name, String value) void removeattribute(string name) NodeList getelementsbytagname(string name) void setidattribute(string name, boolean isid)

26 Initialisierung des DOM Parsers MyDOMParser( ) { } try { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); dbf.setignoringelementcontentwhitespace(true); DocumentBuilder db = dbf.newdocumentbuilder(); db.seterrorhandler( errorhandler ); // Read the entire document into memory Document doc = db.parse(new File(fileName));... } catch (... ){... }

27 Navigieren durch den DOM NodeList nodelist = doc.getelementsbytagname("nodename"); for (int i = 0; i < nodelist.getlength(); i++) { Node node = nodelist.item(i); String value = node.getnodevalue();... } // deep copy Node clone = node.clonenode(true); node.getparentnode().appendchild(clone);

28 Löschen von Nodes NodeList nodelist = doc.getelementsbytagname("name"); len = nodelist.getlength(); for(int i = len-1; i >= 0; i--) { } // Rückwärts! Node node= nodelist.item(i); Node parent = node.getparentnode(); parent.removechild(node);...

29 DOM 3: LSSerializer OutputFormat format = new OutputFormat(DOM Document); format.setlinewidth(linewidth); format.setindenting(true/false); format.setindent(indent); format.setomitdocumenttype(true/false);...

30 DOM 3: LSSerializer FileOutputStream fos = new FileOutputStream(resultFile); XMLSerializer serializer = new XMLSerializer(fos, format); serializer.serialize(domdocument);

31 StAX Streaming API for XML

32 XMLStreamReader START_DOCUMENT / END_DOCUMENT Beginn / Ende des XML-Dokuments START_ELEMENT Start Tag des Elements, Attribute lesen END_ELEMENT End Tag des Elements CHARACTERS Text innerhalb von Elementen...

33 XMLStreamReader while (parser.hasnext()) { switch (parser.next()) { case XMLStreamConstants.START_ELEMENT: parser.getname(); parser.getattributevalue(0); parser.getelementtext(); break; case XMLStreamConstants.END_ELEMENT:... break; case XMLStreamConstants.CHARACTERS: parser.gettext(); break;... }

34 XMLStreamReader InputStream is = new FileInputStream(inFile); XMLInputFactory factory = XMLInputFactory.newInstance(); XMLStreamReader reader = XMLStreamReader reader = factory.createxmlstreamreader(is);

35 XMLStreamWriter FileOutputStream fos = new FileOutputStream(outFile); XMLOutputFactory factory = XMLOutputFactory.newInstance(); XMLStreamWriter writer = factory.createxmlstreamwriter(fos);

36 XMLStreamWriter Methoden zum Schreiben des Dokuments writer.writestartdocument("1.0"); writer.writestartelement(name); writer.writeendelement(); writer.writeattribute(name, value) writer.writecharacters(string) writer.writecomment(comment)...

37 StAX Beispiel public void writedocument() { try { while (reader.hasnext()) { switch (reader.next()) { case XMLStreamConstants.START_ELEMENT: outwriter.writestartelement( reader.getname().getlocalpart()); if (reader.getattributecount() > 0) outwriter.writeattribute( reader.getattributename(0).getlocalpart(), reader.getattributevalue(0)); break; case XMLStreamConstants.END_ELEMENT:... }... } } catch (XMLStreamException e) {... }

38 Übung

39 Schreiben eines Parsers Schreiben Sie einen Parser, welcher die catalog.xml Datei einliest, die www-adressen der Pulishers um das http- Protokoll ( http;// ) ergänzt, die Autoren-Referenzen auflöst und Am Ende den DOM-Baum in ein File result.xml schreibt.

40 DOM Parsen Sie zuerst mit dem DOM Parser das XML Dokument in einen DOM-Baum (Kap 2.7). Benutzen Sie einen LSSerializer (Kap 2.10) um den so erzeugten DOM-Baum in ein XML-File zu scheiben (result.xml) Schreiben Sie einen ErrorHandler und binden Sie diesen an den DocumentBuilder (Kap 1.11 und Kap 2.7). Verschieben Sie die Autoren der Bücher in das jeweilige Buch indem Sie die Referenzen (ID/IDREF-Beziehungen) auflösen. Benutzen Sie dazu einen validierenden Parser (setvalidating(true)) und die Methoden getelementbyid und getelementsbytagname (Kap 2.8). Löschen Sie die (nun überflüssig gewordenen) authors und authorref Elemente aus dem catalog heraus (Kap 2.9).

41 SAX, StAX Schreiben Sie einen SAX-Parser (Kap 1.5) um das catalog.xml Dokument einzulesen. Verwenden Sie den StAX XMLStream (DefaultHandler Kap 1 und XMLStreamWriter Kap 3.3) um das Dokument in ein tmp.xml File zu schreiben. Selbststudium: Benutzen Sie einen XMLReader (org.xml.sax.xmlreader) bzw. einen XMLFilter (org.xml.sax.xmlfilter), um während des Lesens des catalog Files jeweils die URL-Adresse des Publishers um die " zu erweitern. Selbststudium: Löschen Sie mit Hilfe dieses XMLFilters auch alle volume- Elemente aus dem catalog.