1. XML Grunnlag

Transkript

1 Avdeling for informatikk og e-læring, Høgskolen i Sør-Trøndelag XML Mildrid Ljosland Lærestoffet er utviklet for faget LO701D Interaktive Webtjenester med Java og XML 1. XML Resymé: Webtjeneste-teknologien baserer seg i stor grad på XML, og det er derfor viktig å ha et rimelig godt grunnlag i XML før vi går løs på kursets hovedinnhold. I denne leksjonen definerer vi hva XML er, og ser på hva det vil si å lage et lovlig og gyldig XML-dokument. Innhold 1.1. GRUNNLAG Prolog Elementer Attributter NOEN REGLER FOR OPPBYGGING AV XML-DOKUMENTER Regler for velformede XML-dokumenter PCDATA og CDATA Navnerom XML SKJEMA Enkle og komplekse datatyper Deklarere elementer Bestemme antall ganger et element kan brukes Lage egne navngitte komplekse datatyper Lage egne enkle datatyper Attributter og attributtgrupper Skjema-syntaks Grunnlag XML står for Extensible Markup Language. Det ligner på mange måter HTML, men med noen vesentlige forskjeller. Extensible (utvidbart) betyr at man kan lage de elementene man vil, i motsetning til HTML hvor det er fastsatte navn på de elementene som skal brukes. HTML er beregnet på framvisning av dokumenter i en nettleser mens XML kan ses på som en plass å lagre data. Informasjonen i XML-dokumentet kan presenteres på mange former, alt fra avanserte programmer, f.eks. på Internett, til helt enkle websider. Vi vil nå se på de ulike delene et XML-dokument kan bestå av.

2 XML side 2 av Prolog I starten av et XML-dokument kommer det en beskrivelse av dokumentet. Dette kaller vi for en prolog. En prolog kan bestå av: XML-deklarasjonen (<?xml version= 1.0?> ). Denne står helt først i XMLdokumentet. Den forteller at dette er et XML-dokument. Hvis vi ønsker et bestemt tegnsett, må dette settes her ved hjelp av et encoding-attributt. For norske forhold har vi følgende tegnsett: <?xml version= 1.0 encoding= ISO ?>. Kommentarer (<!-- Filnavn: Boksamling.xml --> ) Blanke linjer DOCTYPE-deklarasjon (<!DOCTYPE boksamling SYSTEM boksamling.dtd >). Denne deklarasjonen brukes for å henvise til en Dokumenttype-deklarasjon (DTD) som gjør XML-dokumenter lovlige. Prosessorinstruksjoner. Brukes for å sende mer informasjon til XML-prosessoren, for eksempel informasjon om hvordan dataene skal vises fram. XML-deklarasjonen må alltid finnes, mens de andre delene er valgfrie Elementer Elementet er den viktigste delen av et XML-dokument og er bygd opp på samme måte som i HTML/XHTML-dokumenter. Et element består av startmerke, innhold og sluttmerke: Startmerke Innhold Sluttmerke <navn> Randi Berg </navn> Innholdet til et element beskrives av navnet på merket (start- og sluttmerke). Derfor sier vi at XML er selvbeskrivende, og nettopp dette gjør XML anvendelig å bruke for eksempel i datautveksling. Vi kaller ofte navnet på et element for elementnavn. Trenger vi opplysninger om en person, kan vi for eksempel ha elementnavnene person, navn og telefon. Start- og sluttmerke kalles også for markup eller tags. Elementene kan nøstes, slik at vi får et helt dokument: <?xml version= 1.0 encoding= ISO ?> <person> <navn>randi Berg </navn> <telefon> </telefon> <telefon> </telefon> <epost>randi@berg.com</epost> </person> I dokumentet her har vi først prologen (linje 1) og deretter kommer det et element person som alle de andre elementene er nøstet innenfor. Dette kaller vi for et rotelement. Alle XMLdokumenter består av ett, og bare ett, rotelement. Elementene inni et element kalles barneelmentene til dette elementet.

3 XML side 3 av Attributter Attributter brukes for å beskrive ytterligere informasjon om et element. Det består av et navn og en verdi, og må stå i startmerket til et element: <bok innbinding= myk perm >...</bok> Rundt verdien må det alltid stå eller. Det er stor uenighet om i hvor stor grad attributter bør brukes. Noen mener det er bedre å legge alle dataene som et element, fordi dette gir større fleksibilitet Noen regler for oppbygging av XML-dokumenter Det finnes en rekke regler knyttet til XML-dokumenter. Først og fremst må dokumentet være velformet. Deretter finnes det regler som man kan velge å ta i bruk, blant annet for bruk av navnerom, hvordan man kan definere dokumentet som gyldig/lovlig og hvordan man kan definere hvordan dataene skal vises fram Regler for velformede XML-dokumenter Vi sier vi har et velformet XML-dokument hvis følgende reglene følges: 1. Elementnavnet må starte med en bokstav eller understrektegnet (_). Dette kan følges av bokstaver, tall, bindestrek, punktum eller flere understrektegn. Lengden på navnet er ubegrenset. 2. Mellomrom og andre symboler er ikke tillatt i elementnavn 3. Kolon kan bare brukes i elementnavn når navnerom spesifisere. Beskrives nærmere nedenfor. 4. Ingen egendefinerte elementnavn kan begynne med xml eller XML. Disse ordene er reservert til fremtidige spesifikasjoner. 5. Alle XML-dokumenter må ha ett, og bare ett, rotelement. 6. XML er casesensitivt, hvilket betyr at det skilles mellom store og små bokstaver. NAVN er ikke det samme som navn. 7. Alle elementer som inneholder data (ikke er et tomt element), må ha et start- og et sluttmerke. Sluttmerket må være det samme som startmerket, bortsett fra en / først. 8. Tomme elementer trenger ikke inneholde et sluttmerke, men må da ha en / på slutten, eksempel: <logo src= hist.gif /> 9. Alle merker må nøstes korrekt et element kan ikke avsluttes før alle barneelementene er avsluttet. <adresse><gate>...</gate></adresse> er lovlig, mens <adresse><gate>...</adresse></gate> er ulovlig PCDATA og CDATA Alle XML-dokumenter består av tegn/tekst. Dette deles opp i to kategorier: PCDATA (Parsed Character Data). Tegn/tekst som må parses. (En parser analyserer XML-dokumentet for å sjekke om syntaksen er rett. Det vil si om det er velformet.) CDATA (Character Data). Tegn/tekst som ikke parses.

4 XML side 4 av 11 Innhold til elementer består av PCDATA, mens attributter består av CDATA Navnerom Navnerom er et begrep som kom lenge før XML-standarden og brukes for å unngå forvirring rundt hva et navn betyr/referer til. Elementer som navn og type vil bety ulike ting i ulike sammenhenger. Navn kan være navn på en person, på en bedrift, på en vare osv., mens type kan være institusjonstype, varetype, biltype osv. Vi knytter et elementnavn opp mot et navnerom for å sikre at vi til en hver tid vet hva det er snakk om. I kapittel 1.3 kommer vi til å se på XML-standarden XML-skjema. Denne standarden brukes for å angi oppbygning av XML-dokumenter for å sikre at et XML-dokument er på korrekt format. XML-skjema har et fastsatt sett med elementer og attributter. For å fortelle at det er disse vi ønsker å bruke, knytter vi skjemaet opp mot det navnerommet som er fastsatt for denne standarden. Under er et eksempel på et enkelt XML-skjema. I kapittel 1.3 kommer vi til å forklare de ulike delene, men for nå skal vi bare se på det som har med navnerom å gjøre: <?xml version= 1.0?> <xsd:schema xmlns:xsd= > <xsd:element name= person > <xsd:complextype> <xsd:sequence> <xsd:element name= navn type= xsd:string /> <xsd:element name= tlf type= xsd:integer /> </xsd:sequence> </xsd:complextype> </xsd:element> </xsd:schema> På linje to setter vi opp selve navnerommet. Vi bruker attributtet xmlns (XML Namespace). Etter kolon kommer navnet på navnerommet, her xsd (egentlig fritt valgt, men det er vanlig å bruke dette navnet). Dette brukes som prefiks (foran kolon) hver gang vi vil knytte et element eller datatype opp mot navnerommet. Verdien til attributtet xmlns vil være en URI til selve navnerommet. Denne URI en er unik, men trenger ikke å faktisk eksistere. Den gir navnerommet en entydig referanse og kan dermed fortelle programmet hva elementene og attributtene tilknyttet dette navnerommet betyr. Det er også mulig å sette et navnerom som standard navnerom, slik at vi slipper å føre opp prefikset hver gang. Da ville koden over sett ut som: <schema xmlns= > <element name= person > <complextype> <sequence> <element name= navn type= string /> <element name= tlf type= integer /> </sequence> </complextype> </element> </schema> Nå ser du at selve prefikset er fjernet alle steder. Det er bare mulig å ha ett standard navnerom. Men vi kan ha så mange navngitte navnerom vi vil, enten i tillegg til, eller i stedet for, standard navnerom.

5 XML side 5 av 11 Når vi starter med de ulike standardene i forbindelse med webtjenester, vil vi gjøre stor bruk av navnerom XML Skjema Ved siden av velformede dokumenter har man også gyldige (lovlige) XML-dokumenter. Dette er XML-dokumenter som er knyttet sammen med en DTD eller et XML-skjema (det finnes også andre skjema-varanter). Disse standardene bestemmer blant annet hvilke elementer og attributter et XML-dokument kan bestå av og hvordan de kan nøstes. For eksempel er alle elementer og attributter for et HTML-dokument definert i en DTD. Det er ikke noe krav om å ha et gyldig XML-dokument, men et valg programmereren har. I denne leksjonen skal vi bare ta for oss XML-skjema (ikke DTD), siden det er mest aktuelt i forbindelse med webtjenester. XML-skjemaer er dokumenter som beskriver innhold og struktur på en gruppe med XMLdokumenter. Her defineres hvilke elementer og attributter som kan brukes, og hvordan elementene skal ordnes i en hierarkisk struktur. I tillegg kan det settes begrensninger på innholdet i elementet eller attributtet. Det som legges fram her bygger på de standarder som er definert av W3C og du kan finne disse på: (beskriver XML-skjemaets muligheter) (beskriver ulike strukturer) (beskriver ulike datatyper) Enkle og komplekse datatyper Før vi begynner å lage egne XML-skjema må vi definere hva enkle (simple) og komplekse (complex) datatyper er. Vi ser på følgende eksempel: <person> <navn>ola Nordmann</navn> <telefon type= mobil > </telefon> <alder>24</alder> </person> Elementer som ikke inneholder barneelementer eller attributter, er enkle datatyper. I eksemplet over ser vi at dette gjelder for elementene navn og alder. De inneholder kun tekst som tegn eller tall. Komplekse datatyper inneholder andre elementer eller attributter. I eksemplet ser vi at person-elementet inneholder tre andre elementer: navn, telefon og alder. Dette gjør at person-elementet er av en kompleks datatype. telefon-elementet er også kompleks da det har et attributt. Komplekse datatyper må vi deklarere selv, mens for enkle datatyper er det flere ferdiglagede datatyper vi kan bruke. Når du oppretter en kompleks datatype tar du utgangspunkt i en av de ferdiglagede datatypene. Her er en oversikt over de vanligste:

6 XML side 6 av 11 datatype beskrivelse string boolean double integer date en streng med tekst verdien true eller false desimaltall heltall (uendelig sett med tallverdier) dato på formatet YYYY-MM-DD Det er i tillegg mulig å lage egne enkle datatyper som baserer seg på disse, for eksempel ved å legge inn en begrensning på at alderen ikke skal være mer enn 100. Dette kommer vi tilbake til snart Deklarere elementer Til nå har vi sett på to ulike datatyper: enkle og komplekse. Vi skal nå begynne med å deklarere elementer som bruker disse datatypene og benytter xsd:element. Dette er et xsdelement som forteller at vi skal definere et element. Vi kan bruke dette til å lage et navn-element: <xsd:element name= navn type= xsd:string > Her har vi laget et element som heter navn og der innholdet kan bestå av bokstaver, tegn eller tall. I XML-dokumentet kan vi dermed skrive: <navn>ola Nordmann</navn> Vi kan tenke oss følgende XML-dokument: <person> <navn>ola Nordmann</navn> <tlf> </tlf> </person> Nå vil vi deklarere elementet person med de barneelementer det har og ønsker at personelementet skal være av kompleks datatype. Videre vil vi bruke den enkle datatypen xsd:string på navn-elementet, og xsd:integer på tlf-elementet: 1 <xsd:element name= person > 2 <xsd:complextype> 3 <xsd:sequence> 4 <xsd:element name= navn type= xsd:string /> 5 <xsd:element name= tlf type= xsd:integer /> 6 </xsd:sequence> 7 </xsd:complextype> 8 </xsd:element> Det første vi gjør er å opprette et person-element. Vi forteller at det er en kompleks type ved å bruke elementet xsd:complextype, se linje 2. På linje 3 forteller vi om rekkefølgen på barneelementene. Elementet xsd:sequence er en innholdsmodell og betyr at barneelementene må komme i den rekkefølgen som er angitt innenfor sequence-elementet. I eksemplet betyr det først navn og så tlf. For elementene navn og tlf er innebygde enkle

7 XML side 7 av 11 typer brukt. navn skal være en streng og tlf skal være heltall. Merk at deklarasjonene til disse to elementene er tomme elementer og trenger derfor ikke sluttmerke, men avsluttes i stedet med / til slutt i startmerket. Merk også at det står xsd foran alle elementnavnene i eksemplet over. Dette tilsvarer prefikset til navnerommet som ble omtalt i kap I eksemplet over brukte vi elementet sequence som innholdsmodell. Den forteller at elementene må komme i en bestemt rekkefølge. Det finnes i tillegg to andre innholdsmodeller; choice (valg mellom et av flere barneelementer) og all (barneelementene kan komme i hvilken som helst rekkefølge). Dersom du isteden vil bruke en av disse elementene, byttes sequence-elementet ganske enkelt ut til fordel for en av de andre Bestemme antall ganger et element kan brukes I skjemastandarden finnes det attributter som bestemmer hvor mange ganger et bestemt element kan brukes: minoccurs: minimum antall ganger elementet kan brukes. Blir 1 hvis man ikke oppgir noe annet. maxoccurs: maksimum antall ganger elementet kan brukes. Blir 1 hvis man ikke oppgir noe annet. For å illustrere bruken kan vi si at tlf -elementet kan opptre fra 1 til 3 ganger: <xsd:element name= tlf type= xsd:integer maxoccurs= 3 /> Siden standard-verdi er 1 for minoccurs, er det ikke nødvendig å føre opp minoccurs, kun maxoccurs. Ofte ønsker vi å spesifisere at elementet kan forekomme et vilkårlig antall ganger. Det gjør vi ved å la maxoccurs ha verdien unbounded. Og hvis elementet kan være med, men ikke behøver å være med, setter vi minoccurs til Lage egne navngitte komplekse datatyper I eksemplet over deklarerte vi en anonym datatype. Det betyr at vi nøstet hele typedefinisjonen innenfor xsd:element. Dette er en grei løsning så lenge vi bare skal bruke datatypen en gang. Skal derimot datatypen brukes flere ganger kan datatypen navngis. Dette vil da se slik ut (endringer er markert med uthevet skrift): <xsd:element name= person type= persontype /> <xsd:complextype name= persontype > <xsd:sequence> <xsd:element name= navn type= xsd:string /> <xsd:element name= tlf type= xsd:integer /> </xsd:sequence> </xsd:complextype> I linje 1 deklareres et person-element av typen persontype. Legg merke til at personelementet er et tomt element, resten av koden er ikke nøstet inni dette elementet. På linje 2 begynner vi å lage den komplekse typen persontype og det gjøres på samme måte som tidligere.

8 XML side 8 av 11 Alternativt kunne vi også brukt et ref-attributt til xsd:element for å referere til hele elementdeklarasjonen: <xsd:element ref= person /> <xsd:element name= person > <xsd:complextype name= persontype > <xsd:sequence> <xsd:element name= navn type= xsd:string /> <xsd:element name= tlf type= xsd:integer /> </xsd:sequence> </xsd:complextype> </xsd:element> Dette alternativet er blant annet i brukt i appendiks A i læreboka Lage egne enkle datatyper Av og til kan det være hensiktsmessig å lage sine egne enkle datatyper, noe vi gjør ved å bruke simpletype-elementet. Elementene i XML-dokumentet som bruker denne datatypen kan ikke ha egne barneelementer eller attributter. Vi skal her se på hvordan vi kan sette restriksjoner på en slik enkel datatype, dvs. bruk av elementet xsd:restriction. I tabell A.1 og A.2 side i læreboka står det en liste over elementer som kan brukes innenfor xsd:restriction for å sette ulike typer restriksjoner, og vi skal se på tre av dem. Begrense verdiene Vi ønsker å lage en datatype som registrerer lottotall. I lotto er tallverdiene mellom 1 og 34. Vi lager følgende deklarasjon: <xsd:simpletype name= lottotype > <xsd:restriction base= xsd:integer > <xsd:mininclusive value= 1 /> <xsd:maxinclusive value= 34 /> </xsd:restriction> </xsd:simpletype> På første linje har vi laget en ny enkel datatype. Som attributt til dette simpletype-elementet har vi name= lottotype, som gir navnet på den nye datatypen vår. Vi bruker deretter elementet restriction på linje to. Her er base-attributtet satt til xsd:integer, så datatypen består av heltall. På linje tre og fire kommer selve restriksjonene ved at elementene mininclusive og maxinclusive for henholdsvis laveste og høyeste lovlige verdi, er brukt. For å begrense mulig verdier på et element, kan følgende elementer brukes som barneelementer til restriction: mininclusive : gjelder fra og med verdien som er oppgitt maxinclusive : gjelder til og med verdien som er oppgitt maxexclusive : gjelder fra verdien som er oppgitt, men ikke inkludert denne verdien maxexclusive : gjelder til verdien som er oppgitt, men ikke inkludert denne verdien Bruk av mønster Vi kan også lage en datatype for registreringsnr på bil, på formen BN 34343:

9 XML side 9 av 11 <xsd:simpletype name= regnrtype > <xsd:restriction base= xsd:string > <xsd:pattern value= [A-Z]{2} \d{5} /> </xsd:restriction> </xsd:simpletype> Her starter vi med datatypen xsd:string som basis. Når vi bruker xsd:string, kan vi bruke både bokstaver, tall og andre tegn (som _ og - ). For å sette restriksjonen i dette eksemplet har vi brukt pattern-elementet, siden dette kan brukes til å sette opp et bestemt mønster til vår datatype. Her ser du verdien begynner med [A-Z] som forteller at vi kan ha en valgfri bokstav mellom A og Z. Det neste som står er {2}. Den forteller at [A-Z] består av to valgfrie bokstaver. Så kommer det et mellomrom. Det siste som står er \d{5}. \d forteller at vi skal ha et tall og {5} forteller at tallet skal bestå av 5 sifre. Dermed har vi vårt registeringsnr som må stå på nøyaktig formen BN I lenken under finner du mer om ulike mønstre som kan brukes i pattern-elementet: Bruken av datatypen regnrtype for elementet regnr i et XML-skjema vil se ut som: <xsd:element name= regnr type= regnrtype /> <xsd:simpletype name= regnrtype > <xsd:restriction base= xsd:string > <xsd:pattern value= [A-Z]{2} \d{5} /> </xsd:restriction> </xsd:simpletype> Som en øvelse kan du prøve å sette opp en egen enkel datatype for telefonnr. Et tlf.nr består av nøyaktige 8 siffer. Angi bestemte elementverdier Hvis vi har et sett med verdier som et element kan bestå av, kan enumeration-elementet brukes for å sette opp dette. Vi kan for eksempel angi sivilstatus til en person og si at gyldige verdier er Gift, Samboer og Enslig. For dette lager vi en egen enkel datatype: <xsd:element name= sivilstatus type= sivilstatustype use= required /> <xsd:simpletype name= sivilstatustype > <xsd:restriction base= xsd:string > <xsd:enumeration value= Gift /> <xsd:enumeration value= Samboer /> <xsd:enumeration value= Enslig /> </xsd:restriction> </xsd:simpletype> Her ser en at enumeration-element er brukt for hver gyldig verdi. Nå tillates ikke sivilstatus å ha andre verdier enn disse. Her er et eksempel på en gyldig verdi i XML-dokumentet: <sivilstatus>gift</sivilstatus> mens dette er en ugyldig verdi: <sivilstatus>ugift</sivilstatus> enumeration-elementet kan også brukes på samme måte for attributtdeklarasjoner.

10 XML side 10 av Attributter og attributtgrupper Vi kan også deklarere attributter til elementene i XML-dokumentet. Tenk deg at vi har følgende XML-kode: <person personnr= > <navn>ola Nordmann</navn> <tlf> </tlf> </person> XML-skjemaet vil da bli (attributtdeklarasjon er vist med uthevet skrift): 1 <xsd:element name= person type= persontype /> 2 <xsd:complextype name= persontype > 3 <xsd:sequence> 4 <xsd:element name= navn type= xsd:string /> 5 <xsd:element name= tlf type= xsd:integer minoccurs= 0 maxoccurs= 3 /> 6 </xsd:sequence> 7 <xsd:attribute name= personnr type= xsd:integer /> 8 </xsd:complextype> På linje 7 er det lagt til et attributt som hører til elementet som blir deklarert på linje 1, person-elementet. Legg merke til at det ligger utenfor sequence-elementet, men innenfor complextype-elementet til persontype-elementet. Det skal kun være elementdeklarasjoner innenfor sequence-elementet. Attributtet består her av et navn og en datatype. Det er vanlig at elementer har både et attributt og et innhold: <pris valuta= kr >150</pris> Her har elementet pris fått attributtet valuta. Elementet har ingen barneelementer, men vi må likevel bruke en kompleks type på pris-elementet på grunn av attributtet. Hvis vi vil ha vanlig innhold (elementet innholder ingen barneelementer, bare PCDATA) i et element av en kompleks type, må vi deklarere den komplekse typen som blandet (mixed) innhold (Merk at attributtet allikevel vil ha CDATA som innhold). Her vises deklarasjonen på pris: <xsd:element name= pris type= pristype /> <xsd:complextype name= pristype mixed= true > <xsd:attribute name= valuta type= xsd:string /> </xsd:complextype> Innenfor attribute -elementet kan man bruke use-attributtet. Dette attributtet angir hvordan det deklarerte attributtet skal brukes og kan inneholde ulike verdier: required: sier at dette attributtet må være med fixed: verdien på attributtet er satt i XML-skjemaet. Brukes sammen med valueattributtet der selve verdien settes default: setter en standardverdi dersom ikke annet er oppgitt optional: angir at det er valgfritt om attributtet er med prohibited: dette attributtet kan ikke brukes I eksemplet over kan vi for eksempel angi at valuta-attributtet må være med: <xsd:attribute name= valuta type= xsd:string use= required />

11 XML side 11 av 11 Hvis vi har flere attributter på samme element, kan vi samle disse i en egen attributtgruppe og referere til gruppen i elementdeklarasjonen. Til dette har vi skjemaelementet attributegroup. Alle attributtdeklarasjonene plasseres innenfor dette: <xsd:attributegroup name= attributtgruppe > <xsd:attribute /> <xsd:attribute /> </xsd:attributegroup> Bruk følgende kode for å referere til denne gruppedeklarasjonen: <xsd:attributegroup ref= attributtgruppe /> Skjema-syntaks Til nå har vi kun deklarert de ulike elementene og attributtene. Nå er det tid for å sette opp hele XML-skjemaet. Merk at XML-skjema er en form for XML-dokument og må derfor starte med XML-deklarasjonen: <?xml version= 1.0 encoding= ISO ?> Videre bruker vi et bestemt rotelement i alle XML-skjema og det er elementet schema. Innledningsvis til dette kapitlet lærte vi om et bestemt navnerom som må brukes. Dette kobler vårt XML-skjema sammen med selve skjemaspesifikasjonen. URI en til denne spesifikasjonen er Dermed vil rotelement bli seende slik ut: <xsd:schema xmlns:xsd= > Alle element- og attributtdeklarasjonene fra over må altså nøstes inn i rotelementet.