Programujeme s XML (1.) Document Object Model

Protože programování kolem XML je velmi dobře standardizované, rozhodl jsem se prozatím opustit původní téma Free Pascalu a zaměřit se více na XML.

26.5.2004 08:00 | Aleš Hakl | přečteno 28089×

Podrobné ponoření do XML bych začal poněkud netradičně údajně složitější variantou API pro XML jménem Document Object Model. Osobně si totiž myslím, že ač DOM je možná složitější na pochopení, je rozhodně jednodušší pro programování. Jelikož se jedná o API nezávislé na programovacím jazyku, ukážeme si použití ve Free Pascalu, Pythonu a programovacím jazyku Java. Uvidíme, že jednotlivé varianty jsou velice podobné, a ačkoli se místy liší, z velké části odpovídají dané normě rozhraní DOM.

Na konci minulého století vznikl jako produkt standardizace skriptovacího jazyka JavaScript takzvaný Document Object Model, jedná se o standardizované API usnadňující zpracování dokumentů XML (a i jiných strukturovaných dokumentů, například HTML nebo i třeba definice rozhraní systému CORBA). Ač je původním určením tohoto rozhraní právě použití pro skriptovaní dynamických změn webových stránek, je velmi dobře použitelné i pro jiné úkoly a manipulace se strukturovanými dokumenty.

Rozhraní DOM je publikováno postupně, v částech označovaných "levels", DOM Level 1 obsahuje většinu manipulací se strukturou dokumentu, Level 2 přidává podporu jmenných prostorů a například užitečnou metodu getElementById. Bohužel aktuální implementace DOM ve FCL podporuje spolehlivě pouze DOM Level 1. Jazyk Python podporuje DOM Level 2 a pro jazyk Java, jenž je dnes v podstatě hlavním jazykem pro DOM a XML vůbec, je, pokud vím, dostupná i experimentální implementace čerstvě publikovaného DOM Level 3. Až bude tato nová verze šířeji dostupná, můžeme se těšit na standardizovaný mechanismus načítání a ukládání a podporu XML Schémat.

Jak již napovídá slovo Object v Document Obejct Model, rozhraní je plně objektové, a skládá se z přibližně dvaceti tříd (v terminologii W3C rozhraní, interface). Pokud pomineme třídu DOMImplementation, která zapouzdřuje celé rozhraní a umožňuje nám dotazovat se na jeho schopnosti, můžeme za kořenovou třídu považovat Document. Jak tedy dokument načteme ze souboru do instance třídy Document?

Python doc = xml.dom.ext.reader.Sax2.reader().fromStream(open("jmeno_souboru.xml")
Zde používáme třídu reader z modulu xml.dom.ext.reader.Sax2, jež obaluje událostmi řízený parser XML a na základě jím generovaných událostí vytváří DOM strom.
Free Pascal ReadXMLFile(doc,'jmeno_souboru.xml');
Funkce ReadXMLFile z jednotky xmlread nám zajistí jakési načtení DOM stromu ze souboru a v zájmu našeho duševního zdraví je, abychom příliš nepátrali po tom, jak to dělá.
Java doc = javax.xml.parsers.DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new File("jmeno_souboru.xml"));
A zde začíná chaos. Velmi složitou cestou přes factory třídu získáme v podstatě další factory třídu, jež umí vytvořit instanci třídy Document načtením ze souboru. Zní to složitě, ale je to vlastně jednoduché, a navíc to umožňuje, že se nemusíme starat o to, která implementace XML se použije.

A když už umíme načíst dokument ze souboru podívejme se, jak jej vytvořit prázdný:
Python doc = xml.dom.getDOMImplementation().createDocument("jmeny_prostor","korenovy-element",0)
Tímhle způsobem se mají dokumenty správně vytvářet v DOM Level 2 a v Pythonu to snad ani nejde jinak, rozhodně jsem nepřišel na to jak. Poslední parametr (0) určuje DTD, a pokud je 0 tak dokument žádné DTD nemá.
Free Pascal (dom) doc := TXMLDocument.Create;
Vytvoření instance třídy TXMLDocument , nic víc, nic míň.
Java doc = javax.xml.parsers.DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument());
Toto rozhodně není jediná možnost, samozřejmě můžeme jít přes DOMImplementation, ale u tohoto mám ověřenu funkčnost.

A nakonec se podíváme jak náš dokument zase někam uložit:
Python doc = xml.dom.ext.PrettyPrint(doc,open("jmeno_souboru.xml","w"))
Vcelku zajímavý přístup, funkce PrettyPrint() z modulu xml.dom.ext vypíše obsah DOM stromu (1. parametr) do proudu (2. nepovinný parmetr) jako XML dokument. Snad jedině dodám, že existuje též funkce Print(), která výstupní dokument neodsazuje.
Free Pascal (xmlwrite) WriteXMLFile(doc,'jmeno_souboru.xml');
Princip jako u ReadXMLDocument() výše, něco to dělá, funguje to (téměř), vnitřnosti nás radši nezajímají.
Java javax.xml.transform.TransformerFactory.newInstance().newTransformer().transform(new javax.xml.transform.dom.DOMSource(doc), new javax.xml.transform.stream.StreamResult(new File('jmeno_souboru.xml')));
Zde děláme poměrně zajímavou věc - prázdnou XSLT transformaci, výstupem je kopie vstupu, ovšem v našem případě v jiném formátu - rovnou jako XML dokument. Osobně mě tohle řešení přijde jako poněkud "přes ruku", ale dokumentace Javy toto uvádí jako doporučený postup. Jestli je možné dokument uložit i nějak jinak jsem nezjišťoval, tohle funguje.

Ovšem vstup, výstup a vytváření objektů postrádá smysl, pokud s nimi neumíme dále pracovat. Dále nás instance třídy Document obvykle příliš nezajímá a pracujeme s jednotlivými uzly (potomky třídy Node) uvnitř. Ale na to se podíváme až příště.

Online verze článku: http://www.linuxsoft.cz/article.php?id_article=168