3.3 Parsers SAX con JAXP

Transcripción

1 3.3 Parsers SAX con JAXP

2 Introducción (1) Un parser XML permite comprobar que el documento está bien formado y acceder a los datos Si además el parser es validante, permite validar el documento (usando su DTD o similar) Dos tipos de parsers SAX Simple API for XML Es un pequeño framework basado en eventos El programador proporciona uno o varios objetos callback a los que el parser llamará cada vez que ocurra un evento de interés (apertura de un tag, cierre de un tag, un error, etc.) DOM Document Object Model Construye una representación (un árbol) en memoria del documento El programador puede acceder a los datos del documento recorriendo el árbol

3 Introducción (2) Las APIs de SAX y DOM están estandarizadas y existen un gran número de implementaciones para distintos lenguajes (C++, Java, etc.) Ej.: Apache Software Foundation proporciona Crimson (SAX y DOM sólo para Java), Xerces (SAX y DOM) y Xalan (XSL) En el caso de Java, familia de paquete org.xml.sax y org.w3c.dom (básicamente contienen interfaces y clases abstractas) Lo que no está estandarizado es cómo crear instancias de los parsers Qué es JAXP? Java API for XML Processing Formará parte de J2SE 1.4 Familia de paquetes java.xml.{parsers, transform

4 Qué es JAXP? (cont) Introducción (y 3) Define un API para trabajar con parsers SAX, DOM y transformaciones XSL Proporciona factorías para crear instancias de parses y transformadores XSL de manera portable Existen un gran número de implementaciones que proporcionan adaptadores para JAXP Ej.: Crimson, Xerces y Xalan Sun proporciona una implementación de JAXP para versiones anteriores a J2SE 1.4 Incluye las APIs org.xml.sax, org.w3c.dom y javax.xml.{parsers, transform Incluye Crimson y Xalan como implementaciones por defecto Se pueden usar otras implementaciones vía configuración

5 Continuación del ejemplo Objetivo Construir una sencilla aplicación de administración que permita insertar información sobre películas en la BD Para que el ejemplo sea sencillo La fachada de administración no insertará los datos en la BD, sino que los imprimirá en System.out La aplicación de administración será un simple comando que se ejecuta desde una shell, y que recibe como parámetro la URI del documento XML con los datos de las películas En este apartado Construiremos la infraestructura básica de la aplicación La estrategia de parsing será redefinible Proporcionaremos una implementación con SAX Y en el siguiente apartado, una implementación DOM

6 Estrategia de inserción en la BD (1) Estrategia 1: cada vez que tengamos los datos completos de una película (evento </movie>), la insertamos en la BD Demasiadas transacciones (e invocaciones remotas en una arquitectura en 3 capas) en caso de haya un elevado número de películas Estrategia 2: cada vez que tengamos los datos completos de una película (evento </movie>), la insertamos en una lista, y cuando se termine de parsear el fichero (evento </movies>), insertamos todas las películas de la lista en la BD Si hay muchas películas, problemas de memoria en el cliente y transacción demasiado grande (y gran cantidad de datos transferidos en la invocación remota en una arquitectura en 3 capas)

7 Estrategia de inserción en la BD (y 2) Los problemas de las dos anteriores estrategias son especialmente ciertos en aplicaciones en los que muchos threads parsean documento XML (no es el caso del ejemplo) Estrategia 3: Idem 2, pero cada vez que la lista tiene k elementos, vaciamos la lista a la BD Cuando se termine de parsear el fichero, vaciamos la lista si tenía algún elemento Solución eficiente Es la que usaremos k será configurable Si ocurre un error durante este proceso (error de parsing, inserción en la BD, etc.), abortaremos la ejecución, informando de cuál fue la última película insertada satisfactoriamente En una aplicación real podría ser conveniente continuar y registrar en un log los problemas que ha habido

8 Estructura de paquetes es.udc.fbellas.j2ee.util.xml es.udc.fbellas.j2ee.xmltutorial.movies controller moviesadder model dom sax movie vo moviesadminfacade delegate shell

9 es.udc.fbellas.j2ee.xmltutorial.movies.model.movie.vo MovieVO - movieidentifier : Long - title : String - runtime : int - releasedate : Calendar - directornames : List - actornames : List - genres : List - synopsis : String <<Interface>> Serializable (from io) + MovieVO(...) + getmovieidentifier() : Long + gettitle() : String + settitle(title : String) : void + getruntime() : int + setruntime(runtime : int) : void + getreleasedate() : Calendar + setreleasedate(releasedate : Calendar) : void + getdirectornames() : List + setdirectornames(directornames : List) : void + getactornames() : List + setactornames(actornames : List) : void + getgenres() : List + setgenres(genres : List) : void + getsynopsis() : String + setsynopsis(synopsis : String) : void + tostring() : String

10 es.udc.fbellas.j2ee.xmltutorial.movies.model.moviesadminfacade.delegate MoviesAdministrationFacadeDelegate + MoviesAdministrationFacadeDelegate() + addmovies(listofmovies : List) : void

11 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder MoviesAdderFactory - MoviesAdderFactory() <<static>> + getmoviesadder() : MoviesAdder <<instantiate>> <<Interface>> MoviesAdder + setmoviesblocksize(moviesblocksize : int) : void + addmovies(xmldocumenturi : String) : void <<use>> ConfigurationParametersManager (from configuration)

12 es.udc.fbellas.j2ee.xmltutorial.movies.shell AddMovies <<static>> + main(args : String[]) : void <<use>> <<use>> MoviesAdderFactory (from moviesadder) <<Interface>> MoviesAdder (from moviesadder)

13 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax Visión global <<Interface>> MoviesAdder (from moviesadder) DefaultErrorHandler (from xml) <<instantiate>> SAXMoviesAdder - moviesblocksize : int + SAXMoviesAdder() <<instantiate>> MoviesContentHandler

14 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.saxmoviesadder (1) package es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder. sax; import javax.xml.parsers.saxparserfactory; import javax.xml.parsers.saxparser; import org.xml.sax.xmlreader; import org.xml.sax.saxexception; import es.udc.fbellas.j2ee.util.xml.defaulterrorhandler; import es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder. MoviesAdder; import es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder. MoviesAdderException; public class SAXMoviesAdder implements MoviesAdder { private int moviesblocksize; public void setmoviesblocksize(int moviesblocksize) { this.moviesblocksize = moviesblocksize;

15 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.saxmoviesadder (2) public void addmovies(string xmldocumenturi) throws MoviesAdderException { ElementHandlerContext context = new ElementHandlerContext(moviesBlockSize); try { /* Get a SAX parser factory. */ SAXParserFactory saxparserfactory = SAXParserFactory.newInstance(); /* Enable validation. */ saxparserfactory.setvalidating(true); /* * Create a SAX parser instance and use it to parse the * document. */ SAXParser saxparser = saxparserfactory.newsaxparser(); XMLReader xmlreader = saxparser.getxmlreader(); xmlreader.seterrorhandler(new DefaultErrorHandler()); xmlreader.setcontenthandler(new MoviesContentHandler(context)); xmlreader.parse(xmldocumenturi);

16 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.saxmoviesadder (y 3) catch (SAXException e) { Exception encapsulatedexception = e.getexception(); if (encapsulatedexception!= null) { // InternalErrorException or // model exception throw new MoviesAdderException( context.getlastinsertedmovietitle(), encapsulatedexception); else { // Parsing exception throw new MoviesAdderException( context.getlastinsertedmovietitle(), e); catch (Exception e) { // ParserConfigurationException or // IOException throw new MoviesAdderException( context.getlastinsertedmovietitle(), e);

17 Comentarios (1) javax.xml.parsers.saxparserfactory <<instantiate>> javax.xml.parsers.saxparser <<instantiate>> <<interface>> org.xml.sax.xmlreader <<use>> <<use>> <<interface>> org.xml.sax.errorhandler <<interface>> org.xml.sax.contenthandler

18 Comentarios (2) javax.xml.parsers.saxparserfactory Factoría abstracta El programador obtiene una factoría concreta con el método estático newinstance La documentación JavaDoc documenta varias formas de especificar el nombre de la clase concreta de la factoría Ej.: Definir la propiedad javax.xml.parsers.saxparserfactory=<nombreclase Concreta> en el fichero $JAVA_HOME/lib/javax.properties Si no se especifica ninguna, por defecto, devuelve una dependiente del sistema La factoría concreta no tiene porque ser thread-safe Por tanto, en un entorno multi-thread, cada thread necesita crear su propia factoría Obsérvese que el código de SAXMoviesAdder es, en consecuencia, thread-safe

19 Comentarios (y 3) javax.xml.parsers.saxparserfactory (cont) Permite configurar determinados aspectos globales de los parsers que creará Ej.: saxparserfactory.setvalidating(true) org.xml.sax.xmlreader Permite parsear el documento XML Antes es preciso establecer gestores de eventos Gestor de errores Clase que implementa org.xml.sax.errorhandler Gestor de eventos de contenido (apertura de tag, cierre de tag, etc.) Clase que implementa org.xml.sax.contenthandler

20 org.xml.sax.errorhandler public interface ErrorHandler { public void warning(saxparseexception exception) throws SAXException; public void error(saxparseexception exception) throws SAXException; public void fatalerror(saxparseexception exception) throws SAXException;

21 Comentarios org.xml.sax.saxparseexception es una subclase de org.xml.sax.saxexception que contiene Un mensaje descriptivo Información sobre la localización del error (org.xml.sax.locator) Opcionalmente, una excepción encapsulada Cada vez que el parsing encuentra un error llama al método correspondiente Si el método devuelve SAXParseException, la ejecución del parser termina XMLReader.parse devuelve la excepción Tipos de errores Warnings y errores: algo no es conforme al DTD Errores fatales: el documento no está bien formado

22 es.udc.fbellas.j2ee.util.xml.defaulterrorhandler public class DefaultErrorHandler implements ErrorHandler { public void warning(saxparseexception exception) throws SAXException { throw exception; public void error(saxparseexception exception) throws SAXException { throw exception; public void fatalerror(saxparseexception exception) throws SAXException { throw exception;

23 org.xml.sax.contenthandler public interface ContentHandler { public void setdocumentlocator(locator locator); public void startdocument() throws SAXException; public void enddocument() throws SAXException; public void startelement(string namespaceuri, String localname, String qualifiedname, Attributes attributes) throws SAXException; public void endelement(string namespaceuri, String localname, String qualifiedname) throws SAXException; public void characters(char[] chars, int start, int length) throws SAXException; // Otros métodos...

24 Comentarios La transparencia anterior sólo muestra los métodos que más se usan startelement y endelement incluyen información sobre espacios de nombres Nuestros documentos no usan espacios de nombres characteres El parser nos informa del texto de un elemento de tipo #PCDATA El parser puede necesitar llamar a este método varias veces para un elemento dado Para facilitar la implementación de la interfaz ContentHandler es.udc.fbellas.j2ee.util.xml.defaultcontenthandler proporciona una implementación vacía de todos los métodos Un ContentHandler específico puede extender de DefaultContentHandler y redefinir los métodos que le interese

25 Implementación de un ContentHandler Implementación directa Los métodos startelement, endelement y characters suelen tener muchos if para contemplar todos los elementos La implementación termina siendo grande y difícil de mantener En el ejemplo se ha aplicado el patrón Strategy para procesar los eventos Se ha definido el interfaz ElementHandler, con operaciones para los eventos de interés (apetura de tag, cierre de tag, etc.) Existe un ElementHandler concreto para cada tipo de elemento (movie, director, actor, etc.) Todos ElementHandlers necesitan compartir información El MovieVO actual La lista de MovieVOs El título de la última película insertada en la BD Etc. Compartirán un mismo ElementHandlerContext

26 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax (1) <<Interface>> MoviesAdder (from moviesadder) <<instantiate>> DefaultErrorHandler (from xml) SAXMoviesAdder - moviesblocksize : int + SAXMoviesAdder() <<instantiate>> <<instantiate>> MoviesContentHandler - elementhandlers : Map - elementlocalnameforcharacters : String - context : ElementHandlerContext ElementHandlerContext - locator : Locator - lastinsertedmovietitle : String - currentmovievo : MovieVO - moviesblocksize : int - currentlistofmovievos : List - facade : MoviesAdministrationFacadeDelegate + MoviesContentHandler(context : ElementHandlerContext) 1..n ElementHandler - context : ElementHandlerContext + ElementHandlerContext(moviesBlockSize : int) + getlocator() : Locator + setlocator(locator : Locator) : void + getlastinsertedmovietitle() : String + getcurrentmovievo() : MovieVO + setcurrentmovievo(currentmovievo : MovieVO) : void + addcurrentmovievotolist() : void + flushlistofmovievos() : void + ElementHandler(context : ElementHandlerContext) # getcontext() : ElementHandlerContext + startelement(attributes : Attributes) : void + endelement() : void + characters(chars : char[], start : int, length : int) : void

27 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax (y 2) ElementHandler ActorElementHandler MovieElementHandler + ActorElementHandler(context : ElementHandlerContext) + MovieElementHandler(context : ElementHandlerContext) DirectorElementHandler SynopsisElementHandler + DirectorElementHandler(context : ElementHandlerContext) + SynopsisElementHandler(context : ElementHandlerContext) GenreElementHandlerContext + GenreElementHandlerContext(context : ElementHandlerContext)

28 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.moviescontenthandler (1) public class MoviesContentHandler extends DefaultContentHandler { private Map elementhandlers; private String elementlocalnameforcharacters; private ElementHandlerContext context; public MoviesContentHandler(ElementHandlerContext context) { this.context = context; elementhandlers = new HashMap(); elementhandlers.put("movies", new ElementHandler(context)); elementhandlers.put("movie", new MovieElementHandler(context)); elementhandlers.put("director", new DirectorElementHandler(context)); elementhandlers.put("actor", new ActorElementHandler(context)); elementhandlers.put("genre", new GenreElementHandler(context)); elementhandlers.put("synopsis", new SynopsisElementHandler(context));

29 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.moviescontenthandler (2) public void setdocumentlocator(locator locator) { context.setlocator(locator); public void startelement(string namespaceuri, String localname, String qualifiedname, Attributes attributes) throws SAXException { elementlocalnameforcharacters = localname; getelementhandler(localname).startelement(attributes); public void endelement(string namespaceuri, String localname, String qualifiedname) throws SAXException { getelementhandler(localname).endelement();

30 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.moviescontenthandler (y 3) public void characters(char[] chars, int start, int length) throws SAXException { getelementhandler(elementlocalnameforcharacters). characters(chars, start, length); public void enddocument() throws SAXException { context.flushlistofmovievos(); private ElementHandler getelementhandler(string elementlocalname) { return (ElementHandler) elementhandlers.get(elementlocalname);

31 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.elementhandler public class ElementHandler { private ElementHandlerContext context; public ElementHandler(ElementHandlerContext context) { this.context = context; protected ElementHandlerContext getcontext() { return context; public void startelement(attributes attributes) throws SAXException { public void endelement() throws SAXException { public void characters(char[] chars, int start, int length) throws SAXException {

32 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.movieelementhandler (1) public class MovieElementHandler extends ElementHandler { public MovieElementHandler (ElementHandlerContext context) { super(context); public void startelement(attributes attributes) throws SAXException { /* Get attribute values. */ String title = attributes.getvalue("", "title"); String runtimeasstring = attributes.getvalue("", "runtime"); String releasedayasstring = attributes.getvalue("", "releaseday"); String releasemonthasstring = attributes.getvalue("", "releasemonth"); String releaseyearasstring = attributes.getvalue("", "releaseyear"); NOTA: El primer parámetro de Attributes.getValue es la URI del espacio de nombres Especificamos dado que no usamos espacios de nombres

33 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.movieelementhandler (2) /* * Convert string values into their true types, and validate if * necessary. * * NOTE: Release date is not fully validaded. */ int runtime = validateruntime(runtimeasstring); int releaseday = Integer.parseInt(releaseDayAsString); int releasemonth = Integer.parseInt(releaseMonthAsString); int releaseyear = Integer.parseInt(releaseYearAsString); Calendar releasedate = Calendar.getInstance(); releasedate.set(calendar.day_of_month, releaseday); releasedate.set(calendar.month, Calendar.JANUARY + releasemonth - 1); releasedate.set(calendar.year, releaseyear);

34 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.movieelementhandler (3) /* * Create a MovieVO with the above values and set it as the * current MovieVO. */ MovieVO movievo = new MovieVO(new Long(-1), title, runtime, releasedate, new ArrayList(), new ArrayList(), new ArrayList(), ""); getcontext().setcurrentmovievo(movievo); public void endelement() throws SAXException { getcontext().addcurrentmovievotolist();

35 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.movieelementhandler (y 4) private int validateruntime(string runtime) throws SAXParseException { try { int runtimeasint = Integer.parseInt(runtime); if ( runtimeasint <= 0) { throw new NumberFormatException(); return runtimeasint; catch (NumberFormatException e) { throw new SAXParseException( "'runtime' must be an integer > 0", getcontext().getlocator());

36 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.directorelementhandler public class DirectorElementHandler extends ElementHandler { public DirectorElementHandler (ElementHandlerContext context) { super(context); public void startelement(attributes attributes) throws SAXException { String name = attributes.getvalue("", "name"); getcontext().getcurrentmovievo().getdirectornames().add(name); ActorElementHandler y GenreElementHandler se implementan de forma análoga

37 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.synopsiselementhandler public class SynopsisElementHandler extends ElementHandler { private StringBuffer synopsisbuffer; public SynopsisElementHandler (ElementHandlerContext context) { super(context); public void startelement(attributes attributes) throws SAXException { synopsisbuffer = new StringBuffer(); public void endelement() throws SAXException { getcontext().getcurrentmovievo(). setsynopsis(synopsisbuffer.tostring()); public void characters(char[] chars, int start, int length) throws SAXException { synopsisbuffer.append(chars, start, length);

38 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.elementhandlercontext (1) public class ElementHandlerContext { private Locator locator; private String lastinsertedmovietitle; private MovieVO currentmovievo; private int moviesblocksize; private List currentlistofmovievos; private MoviesAdministrationFacadeDelegate moviesadministrationfacadedelegate; public ElementHandlerContext(int moviesblocksize) { this.moviesblocksize = moviesblocksize; currentlistofmovievos = new ArrayList(); // Varios métodos get/set... public void addcurrentmovievotolist() throws SAXParseException { currentlistofmovievos.add(currentmovievo); if (currentlistofmovievos.size() == moviesblocksize) { flushlistofmovievos();

39 es.udc.fbellas.j2ee.xmltutorial.movies.controller.moviesadder.sax.elementhandlercontext (y 2) public void flushlistofmovievos() throws SAXParseException { try { if (moviesadministrationfacadedelegate == null) { moviesadministrationfacadedelegate = new MoviesAdministrationFacadeDelegate(); moviesadministrationfacadedelegate.addmovies( currentlistofmovievos); currentlistofmovievos.clear(); lastinsertedmovietitle = currentmovievo.gettitle(); catch (InternalErrorException e) { throw new SAXParseException("", locator, e);

40 Gestión de excepciones (1) La única manera de detener el proceso de parsing cuando se detecta un error es Lanzando SAXParseException, y Usando un ErrorHandler al estilo de DefaultErrorHandler En el ejemplo se ha seguido el siguiente convenio Lanzar SAXParseException sin excepción encapsulada cuando es un error de parsing que no es posible especificar con el DTD (ej.: runtime no válido) Lanzar SAXParseException con mensaje cuando hay un problema con la fachada de administración, y con la excepción correspondiente encapsulada El parser lanzará SAXParseException si el documento no está bien formado o no es válido No encapsulada excepción

41 Gestión de excepciones (y 2) Observar la última parte del código de SAXMoviesAdder En caso de problemas, se lanza una excepción MoviesAdderException Indica el título de la última película insertada satisfactoriamente (null si no se insertó ninguna) Encapsula una excepción, que puede ser: Instancia directa de SAXException Sólo llevará mensaje asociado Sólo puede ocurrir en el siguiente apartado (DOM) SAXParseException Sólo llevará mensaje asociado e información sobre ubicación IOException: error de entrada/salida Otra excepción (InternalErrorException o una excepción específica del modelo) Echar un vistazo a es.udc.fbellas.j2ee.xmltutorial.movies.shell.addmovies