Transformace XML dat

Tomáš Pitner

Copyright © 2001-2003 Tomáš Pitner

Table of Contents

Jazyk XSLT
Souvislosti, historie
Hlavní principy
Hlavní informační zdroje - specifikace, reference, tutoriály, FAQ
Syntaxe XSLT
Struktura celého XSLT stylu
XSLT šablony
Sémantika XSLT
XSLT - postup zpracování vstupního dokumentu
XSLT - pořadí volání šablon
XSLT - specifikace výstupu/"výsledku" šablony
XSLT - výstup textových uzlů
Implicitní šablony
Přehled implicitních šablon
Přehled implicitních šablon (2)
Vybrané XSLT konstrukce podrobněji
Generování pevně daného elementu s atributy
Generování elementu s kalkulovaným názvem i atributy
Řízení chodu transformace uvnitř šablony - větvení
Řízení chodu transformace uvnitř šablony - vícecestné větvení
Řízení chodu transformace uvnitř šablony - cykly
Pokročilá témata
Režimy (módy) zpracování
Deklarace a volání pojmenovaných šablon
Automatické (generované) číslování
Automatické číslování (2)
Co používat raději?
Znovupoužitelnost stylů
Návrhové vzory
Odkazy na pokročilá témata

  • XSLT (eXtensible Stylesheet Language Transformation) je jazyk pro specifikaci transformací XML dokumentů na (obvykle) XML výstupy, případně textové, HTML či jiné výstupní formáty.

  • Původní aplikační oblastí byla transformace XML dat na XSL:FO (formátovací objekty), tedy vizualizace XML.

  • XSLT byl tedy součástí specifikací XSL (eXtensible Stylesheet Language).

  • Později se z XSL vyčlenil a začal být chápán jako univerzální jazyk popisu obecných XML->XML(txt, HTML) transformací.

  • Aktuální verze je dána specifikací XSLT 1.0.

    Práce na verzi 1.1 byly zastaveny ve prospěch vývoje XSLT 2.0.

  • XSLT je funkcionálním jazykem, kde redukční pravidla mají podobu šablon, které předepisují, jak se uzly zdrojového dokumentu přepisují do výstupního dokumentu.

  • Specifikace XSLT transformace je obsažena v tzv. stylu (stylesheet), což je XML dokument tvořený podle syntaxe XSLT. Kořenovým elementem je stylesheet nebo transformation (to jsou synonyma).

  • XSLT styl obsahuje tzv. šablony (template).

  • Šablony mají výběrovou část - která reprezentuje levou stranu funkcionálního redukčního pravidla a konstrukční část představující pravou stranu red. prav.

  • Výběrovou část tvoří atribut match šablony.

    Konstrukční část představuje tělo elementu šablony.

  • Vlastní transformace pak znamená, že interpreter XSLT stylů (XSLT procesor, XSLT engine) bere uzly vstupního dokumentu, vyhledá k nim vhodnou šablonu - podle její výběrové části - a vyprodukuje výsledek odpovídající konstrukční části pravidla daného touto šablonou.

Kořenový element xsl:transform nebo xsl:stylesheet uzavírá celý XSLT styl a specifikuje NS prefix pro XSLT elementy.

V kořenovém elementu je:

Šablona (template) je specifikace který uzel přepsat a na co (jak).

Který uzel se přepisuje, je dáno atributem match.

Na co se přepisuje, je uvedeno v těle šablony.

Šablona může být explicitně pojmenovaná (named template), v tom případě ji lze volat přímo/explicitně pomocí xsl:call-template.

Je možné je specifikovat:

  1. Přímo/explicitně voláním (pojmenované) šablony - což ale odpovídá spíše přístupu procedurálních jazyků, takže se tomu spíše vyhýbáme.

  2. Nepřímo/implicitně tím, že se zavolá šablona, jejíž vzor (obsah atr. match) "pasuje" ("matchuje") na vybraný uzel - funkcionální přístup. Výběr uzlu se přitom děje opět:

    • Explicitně ("řízeně") uvedením atributu select u apply-templates. Takto můžeme vybrat jak dceřinné elementy, tak dceřinné uzly, tak jakékoli jiné uzly odpovídající XPath výrazu uvedenému v select.

    • Implicitně, necháme-li procesor sám "si uzel vybrat" (u apply-templates neuvádíme select). V tomto případě se ale vybírají pouze dceřinné elementy kontextového uzlu.

  • Výstupem aplikace šablony je část tzv. result tree fragmentu.

  • Výstupy jednotlivých šablon se "skládají" na to místo result tree fragmentu, který odpovídá pořadí volání šablon.

  • Výstup celé transformace pak směřuje standardně do jednoho proudu, kde se z výstupního proudu událostí generuje výsledný (XML, text, HTML) dokument.

  • Výstup bývá procesorem primárně generován jako sled událostí (např. SAX2), které jsou až druhotně převáděny na výsledný dokument - s uplatněním výstupního kódování, atd.

Jak dostat text (textový uzel) na výstup?

  1. Vepsat text přímo (jako literál) do výstupu (konstrukční části) šablony. Pozor na bílé znaky (mezery, CR/LF)!

  2. vepsat text přímo (jako literál) do výstupu šablony. Pozor na bílé znaky (mezery, CR/LF)!

  3. do speciálního elt. <xsl:text>textový uzel</xsl:text>. Bílé znaky jsou v něm vždy zachovány/respektovány!

Implicitní šablony jsou "vestavěné" v každém korektním procesoru XSLT:

  • aby byly (alespoň jistým standardním "fallback" způsobem) zpracovány základní struktury (procházení stromu dokumentu)

  • abychom "ušetřili psaní" často používaných šablon (ignorování komentářů a PI).

  • Jsou překrytelné, abychom mohli chování změnit uvedením vlastní šablony, která bude mít stejnou (nebo překrývající se) klauzuli match=.

  • "Default tree (do-nothing) traversal":

<xsl:template match="*|/">
    <xsl:apply-templates/>
<xsl:template>

  • "Default tree (do-nothing) traversal for specified mode":

<xsl:template match="*|/" mode="...">
    <xsl:apply-templates mode="..."/>
<xsl:template>

  • "Copy text nodes and attributes" (do výsledku zkopíruje textové uzly a atributy):

<xsl:template match="text()|@*">
    <xsl:value-of select="."/>
<xsl:template>

  • "Ignore PIs and comments" ignoruje (nezahrnuje do výsledku PI a komentáře):

<xsl:template match="processing-instruction()|comment()" />

Cíl: Vygenerovat na výstup předem daný element (s předem známým jménem), ale s atributy s hodnotami kalkulovanými při transformaci.

Řešení: Použít normální postup - literal result element - a hodnoty atributy specifikovat jako tzv. attribute value templates (AVT):

Vstup: 

<link ref="odkaz_dovnitr_dok"> ... </link>

Šablona: 

<xsl:template match="link"> 
    <a href="#{@ref}"> ... </a>
</xsl:template>

Transformuje odkaz link na a, hodnotu atributu href spočte tak, že před hodnotu původního atributu ref přidá znak #

Cíl: Vygenerovat na výstup element, jehož název, atributy i obsah předem - při psaní stylu - neznáme.

Řešení: Použít do konstrukční části šablony xsl:element:

Vstup: 

<generate element="elt_name"> ...
</generate>

Šablona: 

<xsl:template match="generate">
    <xsl:element name="@element">
        <xsl:attribute name="id">ID1</xsl:attribute>
    </xsl:element>
</xsl:template>

Vytvoří element s názvem elt_name, opatří jej atributem id="ID1".

Cíl: Větvit generování výstupu na základě podmínky.

Řešení: Použít do konstrukční části šablony větvení - jednoduché xsl:if nebo vícecestné xsl:choose/xsl:when/xsl:otherwise:

Vstup: 

<rohlik cena="5"> ... </rohlik>

Šablona: 

<xsl:template match="rohlik"> 
    <p>
        <xsl:if test="cena>2"> 
            <span class="expensive">Drahý</span> 
        </xsl:if> rohlík - cena <xsl:value-of select="@cena"/> Kč </p>
</xsl:template>

Vytvoří element p, do něj vloží info o rohlíku - se zvýrazněním, je-li drahý.

Vstup: 

<rohlik cena="5"> ... </rohlik>
<rohlik cena="2"> ... </rohlik>
<rohlik cena="0.9"> ... </rohlik>

Šablona: 

<xsl:template match="rohlik">
    <p>
        <xsl:when test="cena>2">
            <span class="expensive">Drahý</span>
        </xsl:when>
        <xsl:when test="cena<1">
            <span class="strangely-cheap">Podezřele levný</span>
        </xsl:when>
        <xsl:otherwise>
            <span class="normal-price">Běžný</span>
        </xsl:otherwise> rohlík - cena <xsl:value-of select="@cena"/> Kč </p>
</xsl:template>

Odfiltruje dvě extrémní úrovně ceny - pro xsl:otherwise zůstane “normální” cena.

Cíl: Větvit generování výstupu na základě podmínky.

Řešení: Použít do konstrukční části šablony větvení - jednoduché xsl:if nebo vícecestné xsl:choose/xsl:when/xsl:otherwise:

Vstup: 

<pecivo>
    <rohlik cena="5"> ... </rohlik> 
    <rohlik cena="2"> ... </rohlik>
    <rohlik cena="0.9"> ... </rohlik>
</pecivo>

Šablona: 

<xsl:template match="pecivo">
    <xsl:for-each select="rohlik">
       <p>Rohlík - cena <xsl:value-of select="@cena"/> Kč</p> 
    </xsl:for-each>
</xsl:template>

Vytvoří element p, do něj vloží info o rohlíku - se zvýrazněním, je-li drahý.

Pozor: Konstrukce xsl:for-each má typicky procedurální charakter, je dobré s ní šetřit. D8v8 toti6 minumum flexibility na obsah iterované množiny uzlů - tj. předem musím vědět, co tam bude.

Motivace: Módy umožňují mít paralelně sadu šablon se stejnými vzory match, používaných ale pro různé účely, např.:

  • jedna sada pro generování obsahu (index) dokumentu

  • druhá pro formátování plného textu dokumentu

Při explicitním vyvolání aplikace šablon (apply-templates) lze uvést mód (atributem mode=):

  • uvede-li se, aplikují se pouze šablony se stejným módem, jaký byl uveden v xsl:apply-templates mode="mód".

  • neuvede-li se, aplikují se pouze šablony bez specifikace módu (bez atributu mode=).

Deklarace - xsl:template name="jmeno_sablony"

Šablona smí obsahovat deklarace parametrů:

  • <xsl:param name="jmenoParametru"/>

Volání - <xsl:call-template name="jmenoSablony">

volání smí specifikovat parametry:

  • <xsl:with-param name="jmenoParametru" select="hodnotaParametru"/> nebo

  • <xsl:with-param name="jmenoParametru">hodnota parametru</xsl:with-param>

Vložíme-li do konstrukční části šablony (do těla šablony) element xsl:number , zajistí nám vygenerování čísla daného čítačem.

Je možné uvést, podle čeho se má číslovat, např.:

  • pořadového čísla zdrojového elementu v rámci jeho rodičovského elementu

    - a to i víceúrovňově, např. číslo kapitoly 1.1. apod.

Example 1.1. Automatické číslování podle pozice elementu

Aplikujeme-li tento styl

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                version="1.0">
   <xsl:template match="/">
      <html>
         <body>
            <xsl:for-each select="devguru_staff/programmer">
               <xsl:number value="position()" format="1. " />
               <xsl:value-of select="name" /> 
               <br/>
            </xsl:for-each>
         </body>
      </html>
   </xsl:template>
</xsl:stylesheet>

na následující zdrojový soubor

<devguru_staff>
    <programmer>
        <name>Bugs Bunny</name>
        <dob>03/21/1970</dob>
        <age>31</age>
        <address>4895 Wabbit Hole Road</address>
        <phone>865-111-1111</phone>
    </programmer>
    <programmer>
        <name>Daisy Duck</name>
        <dob>08/09/1949</dob>
        <age>51</age>
        <address>748 Golden Pond</address>
        <phone>865-222-2222</phone>
    </programmer>
    <programmer>
        <name>Minnie Mouse</name>
        <dob>04/13/1977</dob>
        <age>24</age>
        <address>4064 Cheese Factory Blvd</address>
        <phone>865-333-3333</phone>
    </programmer>
</devguru_staff>

dostaneme výslednou HTML stránku (nebrat v úvahu odsazení - to bude jiné...)

<html>
    <body>1. Bugs Bunny<br>
          2. Daisy Duck<br>
          3. Minnie Mouse<br>
    </body>
</html>

Example 1.2. Automatické víceúrovňové číslování

Aplikujeme-li tento styl

<xsl:stylesheet
        xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        version="1.0">
    <xsl:template match="/book">
        <html>
            <body>
                <xsl:for-each select="chapter">
                    <h2>
                        <xsl:number count="chapter" format="1. "/>
                        <xsl:value-of select="title" />
                    </h2>
                    <xsl:for-each select="sect1">
                        <h3>
                            <xsl:number count="chapter" format="1. "/>
                            <xsl:number count="sect1" format="a. "/>
                            <xsl:value-of select="title" />
                        </h3>
                        <xsl:apply-templates select="para"/>
                    </xsl:for-each>
                </xsl:for-each>
            </body>
        </html>
    </xsl:template>
</xsl:stylesheet>

na následující zdrojový soubor

<book>
    <title>Moje nová kniha</title>
    <chapter>
        <title>První kapitola</title>
        <sect1>
            <title>První sekce první kapitoly</title>
            <para>Text</para>
        </sect1>
        <sect1>
            <title>Druhá sekce první kapitoly</title>
            <para>Text druhé sekce</para>
        </sect1>
    </chapter>
    <chapter>
        <title>Druhá kapitola</title>
        <sect1>
            <title>První sekce druhé kapitoly</title>
            <para>Text</para>
        </sect1>
        <sect1>
            <title>Druhá sekce druhé kapitoly</title>
            <para>Text druhé sekce</para>
        </sect1>
    </chapter>
</book>

dostaneme výslednou HTML stránku

  • Preferovat funkcionální přístup - např. xsl:template match= a xsl:apply-templates select=

  • před procedurálním přístupem - xsl:template name= a xsl:call-template name=

Používat módy zpracování (xsl:template ... mode= a xsl:apply-templates ... mode=)

módy lze dobře kombinovat s funkcionálním přístupem:

  • xsl:apply-templates select=... mode=...

  • xsl:template match=... mode=...

Co pro ni můžeme udělat?

  • Členit styly do menších znovupoužitelných celků (souborů) a podle potřeby je vřazovat pomocí xsl:include a nebo, ještě lépe, xsl:import - protože import upřednostňuje šablony uvedené přímo v základním stylu nad šablonami importovanými.

Podrobněji viz příspěvek TP pro DATAKON 2001 - fulltext příspěvku a slidy.

Identická transformace 1 (nepřevede do výsledku atributy kořenového elementu!) http://wwbota.free.fr/XSLT_models/identquery.xslt

Identická transformace 2 http://wwbota.free.fr/XSLT_models/identquery2.xslt

Identická transformace s potlačením elementů, které nemají na ose // (v dceřinných uzlech ani jejich potomcích) žádné textové uzly http://wwbota.free.fr/XSLT_models/suppressEmptyElements.xslt

Nahradí atributy pomocí elementů http://wwbota.free.fr/XSLT_models/attributes2elements.xslt

Dtto, ale elementy vzniklé z atributů jsou ve zvláštním jmenném prostoru xslt/attributes2elements.xslt

Reverzní transformace xslt/elements2attributes.xslt

XSLT Design Patterns - výběr

The Functional Programming Language XSLT