JAXP: Java API for XML Processing. Marco Tessarotto Programmazione dei Web Server Anno Accademico

Transcript

1 JAXP: Java API for XML Processing Marco Tessarotto Programmazione dei Web Server Anno Accademico

2 JAXP: Java API for XML processing JAXP: elaborazione di dati XML in Java Utilizza i parser che seguono gli standard SAX (Simple API for XML Parsing) e DOM (Document Object Model) SAX: interpreta i dati XML come un flusso di eventi DOM: costruisce un oggetto che rappresenta i dati XML XSLT (XML Stylesheet Language Transformations): rappresentazione dei dati XML, conversione di dati XML in altri formati 2

3 JAXP API Le principali API si trovano in javax.xml.parsers SAXParserFactory, DocumentBuilderFactory: forniscono all applicazione degli oggetti SAXParser, DocumentBuilder che incapsulano parser XML Le API di JAXP permettono di utilizzare implementazioni di parser SAX e DOM di terze parti senza cambiare il codice della propria applicazione 3

4 SAX e DOM SAX è una API ad eventi, che fornisce un meccanismo per l accesso seriale ad un documento XML, elaborandolo elemento dopo elemento DOM è una API che fornisce una struttura di oggetti; l intero documento XML è presente in memoria dove può essere manipolato dall applicazione Costruire il DOM implica tenere in memoria l intera struttura, è più pesante in termini di consumo di CPU e memoria 4

5 Architettura SAX 5

6 Architettura SAX/2 SAXParserFactory: crea una istanza di SAXParser SAXParser: l elaborazione è invocata tramite parse(); si fornisce una sorgente XML e un gestore (DefaultHandler) che processa i dati XML ed invoca i metodi (callabcks) dell oggetto gestore SAXReader: incapsula un parser SAX DefaultHandler: implementa le interfacce necessarie per l elaborazione XML; è sufficiente riscrivere i metodi che servono all applicazione; ContentHandler, ErrorHandler, DTDHandler, EntityResolver 6

7 Architettura SAX/3 ContentHandler: metodi startdocument, enddocument, startelement, endelement, characters: sono invocati durante l elaborazione dei dati XML ErrorHandler: metodi error,fatalerror, warning: invocati in risposta ad errori di parsing XML EntityResolver: il metodo resolveentity è invocato quando il parser deve identificare un URI. 7

8 Packages di SAX org.xml.sax: definisce le interfacce SAX org.xml.sax.helpers: classi ausiliarie che rendono più semplice l uso di SAX, inclusi i gestori di default javax.xml.parsers: definisce SAXParserFactory, SAXParser 8

9 SAX Modello ad eventi: vengono specificati i metodi che vengono chiamati dal parser man mano che legge i dati XML Veloce, richiede meno memoria di DOM perché non costruisce una rappresentazione interna dei dati Simile a uno stream I/O seriale: non si può tornare indietro nello stream o saltare avanti Caso d uso migliore: l applicazione deve solo leggere i dati Gestione degli errori: uguale per SAX e DOM 9

10 Documento XML Prepariamo un documento XML Processing instruction: <?xml version='1.0'encoding='utf-8'?> Commenti: <!-- esempio di commento -- > Elemento root : <rootelement>. </rootelement> 10

11 Documento XML/2 <?xml version='1.0'encoding='utf-8'?> <channellist> <channel> <id>563</id> <ShortName>RAINews24</ShortName> <Satellite>EUTELSAT 13</Satellite> <Transponder>5400</Transponder> <VideoPID>516</VideoPID> <AudioPID>654</AudioPID> </channel> </channellist> 11

12 SAX parsing Costruiamo una applicazione che effettua la lettura per eventi del documento satellite1.xml 1 - Importazioni import java.io.*; import org.xml.sax.*; import org.xml.sax.helpers.defaulthandler; import javax.xml.parsers.saxparserfactory; import javax.xml.parsers.parserconfigurationexception; import javax.xml.parsers.saxparser; 12

13 SAX parsing/2 import java.io.* : per stream di I/O import org.xml.sax.*: interfacce per implementare metodi di callback per il parser SAX import org.xml.sax.helpers.defaulthandler [C]: implementa le principali interfacce di callback del parser: ContentHandler, DTDHandler, EntityResolver, ErrorHandler import javax.xml.parsers.saxparserfactory [C]: usato per creare una istanza del parser 13

14 SAX parsing/3 import javax.xml.parsers.parserconfigurationexcepti on: indica un errore di configurazione del parser import javax.xml.parsers.saxparser: incapsula il parser SAX, passa i dati XML al parser; restituito da SAXParserFactory 2 la classe public class SatParser1 extends DefaultHandler { } 14

15 SAX parsing/4 javax.xml.parsers.saxparserfactory: definisce una API per configurare ed ottenere un SAX parser; si inizializza così: SAXParserFactory factory = SAXParserFactory.newInstance(); Otteniamo una istanza di un javax.xml.parsers.saxparser: SAXParser saxparser = factory.newsaxparser(); Per attivare il parser ed eseguire la lettura di un file XML: saxparser.parse(new File( nomefile ), handler); 15

16 SAX parsing/5 Handler è di tipo org.xml.sax.helpers.defaulthandler [C] Implementa le principali interfacce per il parser: ContentHandler, DTDHandler, EntityResolver, ErrorHandler [I di org.xml.sax] Vediamo org.xml.sax.contenthandler [I] Tramite questa interfaccia il parser informa l applicazione dell inizio e la fine documento, inizio e fine elemento (ed altre informazioni) 16

17 org.xml.sax.contenthandler public void startdocument(): invocato solo una volta dal parser all inizio del documento XML public void enddocument(): invocato solo una volta dal parser alla fine del documento XML public void startelement(java.lang.string namespaceuri, java.lang.string localname, java.lang.string qname, Attributes atts) : invocato dal parser per notificare l inizio di un elemento nel documento XML; qname: nome completo di prefisso; localname: vuoto se il namespace non è speficato 17

18 org.xml.sax.contenthandler/2 public void endelement(java.lang.string namespaceuri, java.lang.string localname, java.lang.string qname): invocato dal parser per notificare la fine di un elemento public void characters(char[] ch,int start,int length): invocato per riportare all applicazione caratteri del corpo di un elemento; il parser può fornire tutti i caratteri in un blocco solo o in più chiamate; 18

19 SAX parsing/6 org.xml.sax.errorhandler [I]: permette all applicazione di implementare la gestione personalizzata degli errori di parsing; se l applicazione non registra questa interfaccia, warning ed errori rimediabili non sono segnalati; errori fatali lanciano l eccezione SAXParseException; metodi: public void warning(saxparseexception exception): l applicazione viene notificata di un warning; es. una dichiarazione prevede un certo elemento, che non è dichiarato 19

20 SAX parsing/7 public void error(saxparseexception exception): public void fatalerror(saxparseexception exception) 20

21 Document Object Model

22 Document Object Model JAXP: Java API for XML JAXP incapsula varie tecnologie per implementare parser XML; abbiamo visto SAX DOM: raccomandazione del W3C che descrive un modello ad oggetti, neutrale rispetto ai linguaggi di programmazione, per immagazzinare documenti di tipo gerarchico in memoria Le interfacce di DOM forniscono modalità di accesso generiche a tutti i tipi di contenuto del documento 22

23 DOM/2 Le interfacce di DOM sono specificate tramite la notazione IDL (Interface Definition Language) Le interfacce di DOM sono suddivise in due gruppi: Fundamental e Extended Tutte le interfacce Fundamental sono derivate dall interfaccia Node Dato che la gerarchia di oggetti DOM memorizza riferimenti tra i vari nodi di un documento, è indispensabile leggere e sottoporre a parsing tutto il documento (quindi tutto il documento deve essere mantenuto in memoria) 23

24 DOM/3 Questo modello di utilizzo della memoria rende DOM poco adatto per applicazioni che di trasformazione dei dati o che richiedano il parsing incrementale dei dati DOM consente un accesso diretto e casuale agli elementi dei documenti; applicazioni: editing di documenti XML, ricerca di dati, navigazione tra i dati 24

25 Architettura DOM 25

26 Architettura DOM/2 Usare javax.xml.parsers.documentbuilderfactory per ottenere una istanza di DocumentBuilder e produrre un oggetto Document Packages: org.w3c.dom: definisce l interfaccia di programmazione DOM per documenti XML javax.xml.parsers: definisce DocumentBuilderFactory, DocumentBuilder 26

27 Parsing con DOM Dal package javax.xml.parsers, utilizziamo: DocumentBuilderFactory: classe per creare parser DOM DocumentBuilder: incapsula un parser DOM Metodo parse(): restituisce un oggetto Document, che incapsula la struttura gerarchica risultato del parsing Si può operare sull oggetto Document per accedere ai dati XML 27

28 Parsing con DOM/2 Otteniamo la factory : DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Settiamo i parametri del parser che la factory ci fornirà: dbf.setvalidating( ) Otteniamo l oggetto che incapsula il parser DOM: DocumentBuilder db = dbf.newdocumentbuilder(); 28

29 Parsing con DOM/3 Settiamo il gestore che riceverà eventuali segnalazioni di errore nel parsing: db.seterrorhandler(errorhandler); errorhandler implementa l interfaccia org.xml.sax.errorhandler [la stessa che usiamo per SAX] Facciamo eseguire il parsing: Document document = db.parse(inputsource); inputsource può essere un oggetto java.io.file, java.io.inputstream, java.lang.string [uri], 29

30 Parsing con DOM/4 Se usiamo java.io.file all interno di una servlet o pagina JSP, occorre ottenere dal container la posizione assoluta del file [vedi esempio templatedom] java.io.inputstream: per leggere stream di bytes [per scrivere: OutputStream] [JDK 1.0] java.io.reader: per leggere stream di caratteri; supporta caratteri unicode (16 bit); [JDK 1.1] 30

31 org.w3c.dom.document A questo punto possiamo lavorare con l oggetto restituito dal parser DOM; è un oggetto che implementa l interfaccia org.w3c.dom.document Document rappresenta l intero documento XML ed incapsula la radice dell albero; ogni nodo può rappresentare un elemento, un attributo, un commento, un pezzo di testo le interfacce DOM forniscono le API per accedere ai nodi dell albero 31

32 org.w3c.dom.node Document estende l interfaccia Node, che rappresenta la radice della gerarchia di classi DOM; non viene mai istanziata direttamente; può essere utilizzata per estrarre informazioni da qualsiasi oggetto DOM senza conoscerne il tipo L attributo nodetype di Node contiene un valore che indica il tipo; i principali valori sono: Tipo di nodo ELEMENT_NODE Element ATTRIBUTE_NODE Attr Interfaccia DOM 32

33 org.w3c.dom.node/2 TEXT_NODE Text CDATA_SECTION_NODE CDATASection DOCUMENT_NODE Document Consideriamo il documento: <esempio id= prova ><nodocontesto>prova 123</nodoConTesto></esempio> Questo viene interpretato e memorizzato da un parser DOM nella struttura: 33

34 org.w3c.dom.node/3 Document nodetype = DOCUMENT_NODE nodename = #document nodevalue = (null) Element nodetype = ELEMENT_NODE nodename = esempio nodevalue = (null) firstchild attributes Attr nodetype = ATTRIBUTE_NODE nodename = id nodevalue = prova Element nodetype = ELEMENT_NODE nodename = nodocontesto nodevalue = (null) firstchild Text nodetype = TEXT_NODE nodename = #text nodevalue = prova

35 org.w3c.dom.node/4 Ogni oggetto derivato dall oggetto Node contiene dei riferimenti al proprio nodo padre, ai nodi figli ed i nodi fratelli. Principali metodi di Node: public short getnodetype(): restituisce il tipo di nodo (Node.ATTRIBUTE_NODE, Node.ELEMENT_NODE ) public String getnodename(): restituisce il nome del nodo; dipende dal tipo di nodo (es. se è TEXT_NODE, restituisce #text ) 35

36 org.w3c.dom.node/5 public Node getfirstchild(): restituisce il primo nodo figlio; se non esiste, restituisce null public Node getlastchild(): restituisce l ultimo nodo figlio; se non esiste, restituisce null public NodeList getchildnodes(): restituisce tutti i nodi figli; se non ci sono, Nodelist non contiene nodi public boolean haschildnodes() public Node getparentnode(): restituisce il nodo padre; se non esiste, restituisce null 36

37 org.w3c.dom.node/6 public String getnodevalue(): valore del nodo, dipende dal tipo di nodo; se è un nodo Text, restituisce il contenuto che è parte del corpo del nodo padre; restituisce null se il nodo è un elemento, attributo public NamedNodeMap getattributes(): restituisce gli attributi del nodo, se questo è un Element E poi i metodi per modificare i nodi: public void setnodevalue(java.lang.string nodevalue): setta il valore del nodo 37

38 org.w3c.dom.node/7 public Node appendchild(node newchild): aggiunge alla lista dei nodi figli un altro nodo public Node replacechild(node newchild,node oldchild): sostituisce un nodo figlio con un altro public Node removechild(node oldchild): rimuove un nodo figlio 38

39 org.w3c.dom.document L interfaccia Document rappresenta l intero documento XML (la radice) Attraverso Document si possono creare nodi: Element createelement(string tagname): Attr createattribute(string name) Text createtextnode(string data) 39

40 Esempio DocumentBuilder builder = factory.newdocumentbuilder(); document = builder.newdocument(); Element root = (Element) document.createelement("root"); document.appendchild(root); root.appendchild( document.createtextnode( testo 1234") ); 40

41 Validazione XML XML: Extensible Markup Language XML: linguaggio per la creazione di altri linguaggi XML: progettazione del proprio linguaggio di marcatura personalizzato, per formattare i propri documenti (nuovo linguaggio = applicazione XML) Per limitare i documenti XML a determinati contenuti e strutture, occorre definire il contenuto e la struttura di ciascun elemento incluso nel documento XML Document Type Definition (DTD) XML Schema 41

42 Validazione XML/2 Definizione di un elemento: <!ELEMENT tag, tag è il nome dell'elemento da definire EMPTY se l'elemento è vuoto, oppure descrivere tra parentesi gli elementi e/o il testo che conterrà; oppure ANY (qualsiasi combinazione di elementi del DTD) Esempio: <!ELEMENT tag1 (tag2)> Esempio: <!ELEMENT tag_vuoto EMPTY> Esempio: <!ELEMENT contenitore ANY> 42

43 Validazione XML/3 <!ELEMENT nome_tag (#PCDATA)> : elemento che contiene solo contenuti di testo, no testo di marcatura; PCDATA: parsed character data Non si può specificare il tipo del contenuto (es. Stringa, numero); si può fare in XML Schema 43

44 Validazione XML/3 Elemento con un solo elemento figlio: <!ELEMENT nome_tag (child)> Elemento che contiene una sequenza: serie di altri elementi ordinati <!ELEMENT nome_tag (child1, child2, child3,... childn)> Non si può usare #PCDATA nella sequenza Scelte di elementi: un elemento può contenere un ulteriore elemento o un altro <!ELEMENT nome_tag (child1 child2)> : child1 XOR child2 44

45 Validazione XML/4 Esempio: <!ELEMENT nome_tag ((child1,child2) child3)> Elenco non ordinato: <!ELEMENT nome_tag (child1,child2,child3)* > : l'elemento può possedere un numero qualsiasi di una qualunque delle scelte; la prima scelta può essere #PCDATA Quantificatori: tre simboli speciali usati per specificare quante unità possono apparire in un elemento. Unità: elemento singolo/ una scelta tra due o più elementi (tra parentesi) / sequenza di elementi (tra parentesi) +: almeno una unità? : al più una unità ( 0 o 1) * : qualsiasi numero di unità 45

46 Validazione XML/5 Esempio: <!ELEMENT tag1 (child1,child1,child1+)> : child1 compare almeno tre volte in tag1 Definizione degli attributi di un elemento: <!ATTLIST nome_tag nome_attributo tipo_attributo opzione_attributo> Esempio: <!ELEMENT tag1 (#PCDATA)> <!ATTLIST tag1 attr1 CDATA #IMPLIED> #IMPLIED : attributo opzionale, CDATA: qualsiasi combinazione di caratteri (ma non di tag) #REQUIRED: attributo necessario #FIXED: il valore è costante ed immutabile Scelte di tipi di attributo: (scelta1 scelta2...) 46

47 Parser SAX con validazione Per ottenere tramite JAXP un parser SAX che supporti la validazione: SAXParserFactory factory = SAXParserFactory.newInstance(); factory.setvalidating(true); SAXParser saxparser = factory.newsaxparser(); Specificare l interfaccia che riceverà gli errori di validazione: public class SatParser1 extends DefaultHandler (implementa org.xml.sax.errorhandler) 47

48 Esempio doc. XML <?xml version='1.0'encoding='utf-8'?> <!DOCTYPE channellist SYSTEM "SatXML.dtd"> <channellist xmlns="corsows"> <channel> <id>563</id> <ShortName>RAINews24</ShortName> <Satellite>EUTELSAT 13</Satellite> </channel> </channellist> 48

49 Esempio - DTD <?xml version='1.0'encoding='utf-8'?> <!ELEMENT channellist (channel+)> <!ATTLIST channellist xmlns CDATA #REQUIRED> <!ELEMENT channel (id,shortname,satellite,ecmpid,pcrpid,videopid, AudioPID,DataPID*,TransportStream,NetworkID, commento?)> <!ELEMENT id (#PCDATA)> <!ELEMENT ShortName (#PCDATA)> <!ELEMENT Satellite (#PCDATA)>. 49