XSLT extensible Stylesheet Language Transformation

Transkript

1 XSLT extensible Stylesheet Language Transformation Seite 1

2 Inhaltsverzeichnis 1. Was ist XSLT Vorteile von XSLT Anwendungen von XSL 3 2. Ablauf einer XSLT Transformation Xalan und Xerces 5 Beispiel 1: Transformation in ein C++ File 6 3. XSL Anweisungen Syntax XSL Stylesheet Aufbau Grundlegende Anweisungen 9 Beispiel 2: Transformation in ein Html Ziel Dokument Weitere XSL Anweisungen 14 Beispiel 3: Parameter Verwendung Pattern Matching Location Steps Achsen Knoten Typen Prädikate und vollständige Location Steps (gekürzter Syntax) 22 Beispiel 4: Benutzung von XPath anweisungen 23 Anhang: Default Template Rules Quellen 26 Seite 2

3 Was ist XSLT: XSLT bedeutet extensible Stylesheet Language Transformation. Es ist eine Skript Sprache, deren Syntax XML gebunden ist. Mittels eines XSL Stylesheets transformiert man ein XML Dokument (Ursprungs Dokument) in ein anderes Dokument (Ziel Dokument). An einer Transformation sind also 3 Komponenten beteiligt: Das Ursprungs XML Dokument Es enthält Elemente in XML Syntax Das XSL Stylesheet Es enthält Rules (Transformations Regeln) sowie Processing Instrucktion (Steueranweisungen) Das Ziel Dokument Die Transformation kann man sich als Copy & Paste vorstellen. Ein Element wird im Ursprungs Dokument gefunden, daraufhin wird das zugehörige Fragment aus dem XSL Stylesheet genommen, und in das Ziel Dokument eingefügt. Das XSL Stylesheet beschreibt dabei: In welcher Reihenfolge der Inhalt des XML Ursprungs Dokument in das Ziel Dokument überführt wird. Wie die Elemente des XML Ursprungs Dokumentes im Ziel Dokument dargestellt werden. 1.1 Vorteile von XSLT Benutzung des XML Syntax Das es sich um ASCII text handelt sind die Transoformations Regeln gut lesbar. Außerdem ist das Stylesheet von XML Parser verarbeitbar. Es können verschiedene XSLT Stylesheets auf ein Dokument angewendet werden. Nicht an eine Programmiersprache gebunden. Von den meisten Programmiersprachen aus kann aber auf XSLT mittels API s zugegriffen werden. Trennung von Daten, Logik und Darstellung Daten: Logik: Darstellung: XML externes Programm z.b. Programm (mittels DOM Zugriff) XSL Stylesheet 1.2 Anwendungen für XSLT Transformation in ein HTML Ziel Dokument Dies ist die im Moment häufigste Anwendung. XSLT dient hier wie bereits erwähnt der Trennung von Daten, Logik und Darstellung Transformation in andere Ziel Dokumente wie z.b. PDF oder Tex Einfügen von Dynamischen Inhalt in Templates. (siehe Beispiel Transformation in ein "C++" File Seite 3

4 2.Ablauf einer XSLT Transformation (aus Hands on XSL von Don R. Day) An der Transformation sind 2 Parser beteiligt: XML Parser XSL Parser Zuerst kommt der XML Parser zum Einsatz. Er liest zuerst das XSL Stylesheet ein, und erzeugt daraus eine sogenannte Rules Base. Dies ist eine Pointer Struktur, die es nachher erlaubt schneller auf die einzelnen Rules des XSL Stylesheets zuzugreifen. Nun wird das XML Ursprungs Dokument vom XML Parser geparsed. Aus diesem wird ein Source Tree (eine Baumstruktur) gemacht, mit einer Wurzel, an dem die einzelnen Elemente des XML Ursprungs Dokumentes hängen. Die Reihenfolge des Parsens kann dabei je nach verwendeten Parser variieren. Nun kommt der XSL Parser zum Einsatz. Er wendet nun zu den einzelnen Elementen des Source Tree die entsprechende Rule in der Rules Base an, und schreibt das Ergebnis der Rule in den Result Tree. Zu beginn wird der Parser dabei auf die Wurzel gesetzt. Er steigt dann immer Links am Baum entlang hinab, bis er an das Ende eines Astes kommt. Dieses Absteigen wird im XSL Stylesheet durch die <xsl:apply template...> Anweisungen gesteuert. Am Ende wird der Result Tree zur Ausgabe und damit zum Ziel Dokument Seite 4

5 2.1. Xalan und Xerces Es gibt mehrere XSLT Prozessoren wie es auch mehrere XML Parser gibt. Am bekanntesten sind wohl Xerces (XML Parser) sowie Xalan (XSLT Prozessor). Beide sind vom Apache Projekt, und frei zugänglich. Xalan Aufruf: Java.org.apache.xalan.xslt.Process [Parameter] Parameter: IN [URL] Definiert das XML Ursprungs Dokument, welches geparsed werden soll { XSL [URL] } optional Das XSL File, in denen die Rules stehen { PARAM [name] [expression] } optional Setzen eines Stylesheet parameters (name) und dessen Wert (expression) {OUT [URL] } optional Das Ausgabefile. Wird dieser Parameter weggelassen, wird auf die Standart Ausgabe geschrieben. Seite 5

6 Beispiel 1: Transformation in ein c++ File XML Ursprungs Dokument: cpp.xml <?xml version="1.0"?> <CPP> <MAIN> <TEXT>eine Ausgabe</TEXT> </MAIN> </CPP> XML Ursprungs Dokument: cpp_mitstylesheet.xml <?xml version="1.0"?> <?xml stylesheet href="cpp.xsl" type="text/html"?> <CPP> <MAIN> <TEXT>eine Ausgabe</TEXT> </MAIN> </CPP> XSL Stylesheet:cpp.xsl <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl=" <xsl:template match="cpp"> /****************************************** Eine Transformation nach C++ ******************************************/ <xsl:apply templates/> <xsl:template match="main"> int main(int argc,char[] argv) { <xsl:apply templates/> } <xsl:template match="text"> printf( <xsl:value of select="."/> ); </xsl:stylesheet> Seite 6

7 Aufruf: Java org.apache.xalan.xslt.process in cpp.xml xsl cpp.xsl Wenn in der XML Datei ein Stylesheet angegeben ist, dann braucht man den xsl Parameter nicht Aufruf: Java org.apache.xalan.xslt.process in cpp_mitstylesheet.xml Ausgabe eines Transformations Vorganges == Parsing file:/home/thorsten/wba Vortrag/Samples/cpp.xsl == Parse of file:/home/thorsten/wba Vortrag/Samples/cpp.xsl took 363 milliseconds == Parsing cpp.xml ====== Parse of cpp.xml took 63 milliseconds ============================= Transforming... transform took 7 milliseconds XSLProcessor: done Ziel Dokument: cpp.cpp /****************************************** Eine Transformation nach C++ ******************************************/ int main(int argc,char[] argv) { printf( eine Ausgabe ); } Seite 7

8 3. XSL Anweisungen 3.1 Syntax Da XSL auf XML basiert, haben alle anweisungen folgenden Syntax: <xsl:[anweisung [Parameter] ]>... </xsl:[anweisung]> oder <xsl:[anweisung [Parameter] ]/> 3.2 XSL Stylesheet Aufbau Das XSL Stylesheet wird repräsentiert von dem <xsl:stylesheet> Tag. Darin enthalten sind sogenannte Top Level Anweisungen: <xsl:import> Importiert ein Stylesheet <xsl:include> Fügt ein Stelysheet ein <xsl:stripe space> bestimmt welche Text Elemente von ohne Leerzeichen zu lesen sind <xsl:preserve space> bestimmt welche Text Elemente mit Leerzeichen zu lesen sind <xsl:output> <xsl:key> <xsl:decimal format> <xsl:namspace alias> <xsl:attribute set> <xsl:variable> legt Variablen fest <xsl:param> legt parameter fest <xsl:template> Definition der Regeln, welcher Text in das Ziel Dokument einfügt werden soll. Wenn das Element für das die <xsl:template> Anweisung steht im XML Urprungs Dokument gefunden wird. Seite 8

9 3.3. Grundlegende Anweisungen Syntax: <xsl:stylesheet> <xsl:stylesheet xmnlns:[namensraum]> </xsl:stylesheet> Beschreibung: Wurzel Element eines XSL Stylesheets. Schließt den Rest des Stylesheets ein. Als Parameter muß der Namensraum definiert werden. Achtung Der Namensraum ist in mancher Dokumentation veraltet. Die Aktuelle Xalan Version erkennt folgenden Namensraum: xmlns:xsl=" Beispiel: Syntax: <xsl:stylesheet xmlns:xsl= " <xsl:include> <xsl:include href="[url]"/> Beschreibung: Nur in xsl:stylesheet erlaubt Die Knoten innerhalb des xsl:stylesheet des einzufügenden Dokuments werden an die Stelle des <xsl:include> Aufrufes in das aktuelle Dokument eingefügt Beispiel: Syntax: <xsl:include "Steylesheet2.xsl"/> <xsl:import> <xsl:import href="[url]"/> Beschreibung: Nur in xsl:stylesheet erlaubt Die Knoten innerhalb des xsl:stylesheet des einzufügenden Dokuments werden an die Stelle des xsl:import Aufrufes in das aktuelle Dokument eingefügt Beispiel: Unterschied zu include: Wenn in beiden Stylesheets gleiche Definitionen oder Template rules vorhanden sind, habe diejenigen des Importierenden Files Vorrang <xsl:import "Steylesheet2.xsl"/> Seite 9

10 Syntax: Beschreibung: Beispiel: Syntax: Beschreibung: Beispiel: Syntax: Beschreibung: Beispiel: <xsl:template> <xsl:template name="[name] match="[query String]"> Zuweisung eines Elementes zu einer Transformations Regel. Elemente die die Bedingung im Query String (siehe Pattern Matching) erfüllen werden durch den Inhalt des Tags ersetzt. <xsl:template match="/"> <html> Dies ist die Wurzel </Html> <xsl:apply template> <xsl:apply template select="[query String]"/> Steuerung des Absteigens im Source Tree. Alle Elemente die die Bedingung im Query String erfüllen werden abgearbeitet. <xsl:apply templates/> oder <xsl:apply templates select="/kinderelemente"/> <xsl:value of> <xsl:value of select="[query String]"/> Holt sich den Inhalt der im Query String angegebenen Elemente und fügt diesen in den Result Tree ein. Wenn das im Query String adressierte Element keinen Inhalt hat, sucht der Parser in dessen Kinder Elementen <xsl:value of select="."/> Seite 10

11 Beispiel 2: Transformation in ein Html Ziel Dokument XML Ursprungs Dokument: cpp.xml <?xml version="1.0"?> <EINFACH> <ADRESSE> <NAME> Maier </NAME> <VORNAME> Heinz </VORNAME> </ADRESSE> <ADRESSE> <NAME> Wagner </NAME> <VORNAME> Hildegard </VORNAME> </ADRESSE> </EINFACH> Seite 11

12 XSL Stylesheet: einfach.xsl <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl=" <xsl:template match="/"> <html> <xsl:apply templates/> </html> <xsl:template match="einfach"> <table border="1"> Name Vorname <xsl:apply templates/> </table> <xsl:template match="adresse"> <xsl:apply templates/> <xsl:template match="name"> <xsl:value of select="."/> <xsl:template match="vorname"> <xsl:value of select="."/> </xsl:stylesheet> Seite 12

13 Ergebnis: einfach.html <html> <table border="1"> Name Vorname Maier Heinz Wagner Hildegard </table> </html> Seite 13

14 3.4.Weitere XSL Anweisungen Syntax: Beschreibung: <xsl:variable> <xsl:variable name="[name]" select="[wert]/> <xsl:variable name="[name]">[wert]</xsl:variable> <xsl:variable name="[name]"/> Definition einer Variable. Ist nur das Attribut select mit einem Ausdruck besetzt, so ist der Wert der Variable das Ergebnis des Ausdrucks. Ist kein select Attribut besetzt, dafür aber der Kontext, so ist der Wert der Variable der Kontext. Beispiel: Syntax: Beschreibung: Ist beides nicht besetzt, so ist der Wert der variable ein leerer String. <xsl:variable name="var" select="234"/> <xsl:variable name="var">ein Template</xsl:variable> <xsl:variable name="var"/> <xsl:param> <xsl:param name="[name]" select="[wert]/> <xsl:param name="[name]">[wert]</xsl:param> <xsl:param name="[name]"/> Definition eines Parameters. Ist nur das Attribut select mit einem Ausdruck besetzt, so ist der Wert des Parameters das Ergebnis des Ausdrucks. Ist kein Select Attribut besetzt, dafür aber der Kontext, so ist der Wert des Parameters der Kontext. Ist beides nicht besetzt, so ist der Wert des Parameters ein leerer String. Beispiel: Unterschied zu Variable: Die Definition von Parameter ist der Default wert. Einem Parameter kann ein anderer Wert von Außen (z.b. durch PARAM parameter von Xalan) mitgegeben werden. <xsl:param name="var" select="5"/> <xsl:param name="var">default</xsl:param> <xsl:param name="var"/> Seite 14

15 Syntax: Beschreibung: Beispiel: Syntax: Beschreibung: Beispiel: <xsl:call template> <xsl:call template name=[template]> Aufruf eines Templates <xsl:call template name="mytemplate"> <xsl:with param> <xsl:with param name="[template]> [wert] </xsl:with param> Zuweisung eines Wertes an einen Parameter oder Variable beim Aufruf einer Rule <xsl:with param name="local">4</xsl:with param> Seite 15

16 Beispiel 3: Parameter Verwendung In diesem Beispiel wird das einfach.xml File aus Beispiel 2 verwendet XSL Stylesheet: einfach.xsl <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl=" <xsl:param name="parameter">2</xsl:param> <xsl:variable name="local"/> <xsl:template match="/"> <html> <xsl:apply templates/> </html> <xsl:template match="einfach"> <table border="1"> Name Vorname <xsl:apply templates select="/einfach/adresse[position()=$parameter]"/> <xsl:call template name="aufruf"> <xsl:with param name="local"> 1 </xsl:with param> </xsl:call template> </table> <xsl:template match="adresse"> <xsl:apply templates/> <xsl:template match="name"> <xsl:value of select="."/> <xsl:template match="vorname"> <xsl:value of select="."/> <xsl:template name="aufruf"> <xsl:value of select="/einfach/adresse[position()=$local]/name"/> <xsl:value of select="/einfach/adresse[position()=$local]/vorname"/> </xsl:stylesheet> Seite 16

17 Aufruf: java org.apache.xalan.xslt.process in einfach.xml xsl parambsp.xsl out parambsp1.html Ergebnis: parambsp1.html <html> <table border="1"> Name Vorname Wagner Hildegard Maier Heinz </table> </html> Seite 17

18 Aufruf: java org.apache.xalan.xslt.process in einfach.xml xsl parambsp.xsl out parambsp2.html PARAM parameter 1 Ergebnis: parambsp2.html <html> <table border="1"> Name Vorname Maier Heinz Maier Heinz </table> </html> Seite 18

19 4.Pattern matching In einigen der bisher behandelten Anweisungen war als Attribute ein Query String angesprochen worden. Der Query String dient dazu Elemente zu adressieren, um die Verarbeitung auf diese Elemente zu beziehen. Dieser Query String wird auch als Location Step bezeichnet. Die Notation des Query Strings ist an die Adressierung im Filesystem angelehnt und wird als XPath bezeichnet. Neben XPath gibt es noch XPointer, auf das nicht näher eingegangen wird. Mit XPath Location Steps kann man von dem Element auf dem man sich gerade befindet ausgehend in verschiedene Suchrichtungen im Source Tree navigieren. Mit XPointer kann man Elemente im Source Tree ansprechen unabhängig von der Suchrichtung. 4.1.Location Steps Location Steps bestehen aus 3 Teilen: Achse Knoten Typ Prädikat Syntax: [achse]::[knoten Typ()][Prädikat] Mittels der Locaton Steps werden nun ein oder mehrere Knoten adressiert werden Achsen Die Achsen geben an in welcher Suchrichtung die auszuwählenden Elemente sich befinden, ausgehend vom aktuellen Element self Das aktuelle Element wird adressiert. child Die direkten Nachkommen des Elementes werden adressiert. Seite 19

20 parent Der direkte Vorfahre des aktuellen Elementes wird adressiert. descendant Alle direkten Nachkommen des aktuellen Elementes und deren Nachkommen werden adressiert. ancestor Alle Elemente von der Wurzel ausgehend, die durchlaufen wurden um auf das Aktuelle Element zu kommen werden adressiert. following sibling Die Elemente die den gleichen Vorfahren haben, aber in der Verarbeitung nach dem Aktuellen Element folgen, werden adressiert. preceding sibling Die Elemente die den gleichen Vorfahren haben, aber in der Verarbeitung vor dem Aktuellen Element stehen, werden adressiert. following Die Elemente die in der Verarbeitung nach dem Aktuellen Element folgen, aber kein Vorfahr des Aktuellen Elementes sind oder ein Vorfahr dieses Vorfahren sind, werden adressiert. Seite 20

21 preceding Alle Elemente die in der Verabeitung vor dem Aktuellem Element liegen, aber keine Vorfahren des Aktuellen Elementes sind, oder Vorfahren dieses Vorfahren sind, werden adressiert. descendant or self Variation von descendant und self. Alle Nachkommen des aktuellen Elementes sowie das Aktuelle Element selbst, werden adressiert. ancestor or self Variation von ancestor und self. Alle Elemente von der Wurzel ausgehend, die durchlaufen wurden um auf das Aktuelle Element zu kommen, sowie das Aktuelle Element selbst, werden adressiert. 4.3.Knoten Typen Mit der Angabe eines Knoten Typen kann man die Selektion der zu adressierenden Elemente noch einschränken, bzw. Teile von Elementen adressieren. Wenn kein Knoten Type angegeben ist, so wird default mäßig node() angewendet. node() alle Knoten egal welcher Typ text() alle Knoten die Text enthalten comment() alle Kommentare processing instructions() alle Processing Instructions attribute() alle Attribute Seite 21

22 4.4.Prädikate und vollständige Location Steps (gekürzter Syntax) Prädikate werden als boolsche Ausdrücke in eckigen Klammern notiert und beschreiben weitere Einschränkungen in der Selektion der Knoten. Sie werden direkt an die Node Typen angehängt Knoten betreffende Location Steps / Die Wurzel adressieren. * alles (vom aktuellen Element ausgehend adressieren. //Kinder/derenKinder von aktuellen Element ausgehende alle Nachkommen adressieren, die ein Element»Kinder«haben, die wiederum ein Element»derenKinder«haben. Prädikate following::node()[@anzahl="1"] Alle (wegen node()) Elemente die in der Verarbeitung nach dem Aktuellen Element folgen, aber kein Vorfahr des Aktuellen Elementes sind oder ein Vorfahr dieses Vorfahren sind, adressieren, die ein Attribut namens»anzahl«haben, und dessen Wert 1 ist. (zusätzlich) Positionsangaben./Kinder[@anzahl][position()= 1 ] Das Aktuelle Element adressieren (.), und dessen ersten Nachkommen adressieren, welches ein Element»Kinder«hat, daß ein Attribut»anzahl«hat. /Eltern[position()=last()] Die Nachkommen adressieren, die ein Element»Eltern«haben, und davon das letzte Element auswählen. Benutzung boolscher Funktionen presceding::kinder[enkel and Enkel[position()=last()]] Alle Elemente die in der Verabeitung vor dem Aktuellem Element liegen, aber keine Vorfahren des Aktuellen Elementes sind, oder Vorfahren dieses Vorfahren sind, ein Element»Kinder«haben, die wiederum entweder ein Element»Enkel«haben, und dieses ist das letzte aller Möglichen. anchestor or self::kinder[@wert="2" Alle Elemente von der Wurzel ausgehend, die durchlaufen wurden um auf das Aktuelle Element zu kommen, sowie das Aktuelle Element selbst, die ein Element»Kinder«haben dessen Attribut»wert«=2 ist oder dessen Attribut»anzahl«=3 ist werden adressiert. Seite 22

23 Beispiel 4: Benutzung von XPath Anweisungen XML Ursprungs Dokument: buch.xml <?xml version="1.0"?> <BUCH> <KAPITEL Nummer="1"> <NAME> Das erste Kapitel </NAME> <SEITE Nummer="1"> <INHALT> Seite 1 Kapitel 1 </INHALT> <KOPFZEILE> Buch Kopfzeile 1 Kapitel 1 </KOPFZEILE> </SEITE> </KAPITEL> <KAPITEL Nummer="2"> <NAME> Das zweite Kapitel </NAME> <SEITE Nummer="1"> <INHALT> Seite 1 Kapitel 1 </INHALT> <KOPFZEILE> Buch Kopfzeile 1 Kapitel 1 </KOPFZEILE> </SEITE> <SEITE Nummer="2"> <INHALT> Seite 2 Kapitel 2 </INHALT> <KOPFZEILE> Buch Kopfzeile 2 Kapitel 2 </KOPFZEILE> </SEITE> </KAPITEL> <KAPITEL Nummer="3"> <NAME> Das dritte Kapitel </NAME> <SEITE Nummer="1"> <INHALT> Seite 1 Kapitel 3 </INHALT> <KOPFZEILE> Buch Kopfzeile 1 Kapitel 3 </KOPFZEILE> </SEITE> </KAPITEL> </BUCH> Seite 23

24 Alle Kapitel eines Buches auswählen > Alle Kinder mit Namen "Kapitel" von Buch auswählen XSL Stylesheet: buchbsp1.xsl <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl=" <xsl:template match="/"> <HTML> <xsl:apply templates select="/buch/kapitel"/> </HTML> <xsl:template match="/buch/kapitel"> <br/>dies ist ein Kapitel: <xsl:value of select ="NAME"/> <br/> </xsl:stylesheet> Ergebnis: buchbsp1.html Dies ist ein Kapitel: Das erste Kapitel Dies ist ein Kapitel: Das zweite Kapitel Dies ist ein Kapitel: Das dritte Kapitel Bestimmtes Kapitel eines Buches auswählen > Kapitel mit Attribut Nummer= 2 XSL Stylesheet: buchbsp2.xsl <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl=" <xsl:template match="/"> <HTML> <xsl:apply templates select="/buch/kapitel[@nummer= 2 ]"/> </HTML> <xsl:template match="/buch/kapitel"> <br/>dies ist ein Kapitel: <xsl:value of select ="NAME"/> <br/> </xsl:stylesheet> Ergebnis: buchbsp2.html Dies ist ein Kapitel: Das zweite Kapitel Seite 24

25 Bestimmtes Kapitel eines Buches auswählen > Kapitel mit Positionsnummer XSL Stylesheet: buchbsp3.xsl <?xml version="1.0"?> <xsl:stylesheet xmlns:xsl=" <xsl:template match="/"> <HTML> <br/>erstes <br/><xsl:apply templates select="/buch/kapitel[position()= 1 ]"/> <br/>positionsnummer <br/><xsl:apply templates select="/buch/kapitel[position()= 2 ]"/> <br/>letztes <br/><xsl:apply templates select="/buch/kapitel[position()=last()]"/> <br/>vorletztes <br/><xsl:apply templates select="/buch/kapitel[position()=last() 1]"/> </HTML> <xsl:template match="/buch/kapitel"> <br/>dies ist ein Kapitel: <xsl:value of select ="NAME"/> <br/> </xsl:stylesheet> Ergebnis: buchbsp3.html Erstes Dies ist ein Kapitel: Das erste Kapitel Positionsnummer Dies ist ein Kapitel: Das zweite Kapitel Letztes Dies ist ein Kapitel: Das dritte Kapitel Vorletztes Dies ist ein Kapitel: Das zweite Kapitel Seite 25

26 Anhang 1: Default Template Rules Es gibt mehrere Default Template Rules, die angewandt werden, wenn im Stylesheet keine andere Rule diese außer kraft setzt Wenn der Parser auf ein Element stößt, für das es keine Template Rule gibt, wird folgende Rule angewandt: <xsl:template match="* /"> <xsl:apply templates/> <xsl:template/> Wenn es sich bei dem Element handelt, daß keine Nachkommen hat, wird folgende Rule angewandt: <xsl:template <xsl:value of select="."/> <xsl:template/> Anhang 2: Quellen Hands on XSL ( Don R. Day) ibm.com/developerworks/xml/library/hands on xsl/index.html?dwzone=xml Xalan und Xerces XSL Seite 26