En esta parte vamos a parsear la respuesta XML utilizando las capacidades built-in del XML para parseo de XML.

1.- Analizamos las respuestas XML

El TMDb API soporta tanto XML como formatos JSON para las respuestas HTTP. Vamos a utilizar XML para nuestra aplicación. Veamos como algunas respuestas de ejemplo para queries de búsqueda como estas:

Movies search for “Transformers” and (year) “2007” à archivo “Transformes+2007.xml”

Person search for “Brad Pitt” à archivo “Bradd+Pitt.xml”

Lass respuestas son documentos XML típicos que pueden ser parseados utilizando los procedimientos estándar SAX o DOM. La especificación SAX define una aproximación basada en eventos donde los parsers implementados escanean a través de los datos XML y utilizan manejadores call-back cuando quiera que ciertas partes del documento han sido encontradas. Por otro lado , la especificación DOM define una aproximación basada en árbol para navegar por el documento XML.

En general, el uso de SAX es más trabajoso de implementar porque hay que desarrollar todos los método callback que manejan los eventos, mientras la aproximación DOM requiere de más memoria. Por esta razón, vamos a elegir SAX para la implementación de nuestros parsers XML, ya que nuestra aplicación funcionará en un entorno hardware con restricciones como es un dispositivo móvil.

2.- Creación de clases de modelo

Antes de proceder con el parseo de XML, vamos a crear algunas clases modelo con las cuales mapearemos los elementos XML a clases Java. Simplemente mirando las respuestas XML, se pueden derivar las siguientes clases modelo:

package com.javacodegeeks.android.apps.moviesearchapp.model;
import java.util.ArrayList;
public class Person {
	public String score;
	public String popularity;
	public String name;
	public String id;
	public String biography;
	public String url;
	public String version;
	public String lastModifiedAt;
	public ArrayList<Image> imagesList;
}

package com.javacodegeeks.android.apps.moviesearchapp.model;
import java.util.ArrayList;
public class Movie {
	public String score;
	public String popularity;
	public boolean translated;
	public boolean adult;
	public String language;
	public String originalName;
	public String name;
	public String type;
	public String id;
	public String imdbId;
	public String url;
	public String votes;
	public String rating;
	public String certification;
	public String overview;
	public String released;
	public String version;
	public String lastModifiedAt;
	public ArrayList<Image> imagesList;

	public String retrieveThumbnail() {
		if (imagesList!=null && !imagesList.isEmpty()) {
			for (Image movieImage : imagesList) {
				if (movieImage.size.equalsIgnoreCase(Image.SIZE_THUMB) &&	movieImage.type.equalsIgnoreCase(Image.TYPE_POSTER)) {
					return movieImage.url;
				}
			}
		}
		return null;
	}
}

package com.javacodegeeks.android.apps.moviesearchapp.model;

public class Image {
	public static final String SIZE_ORIGINAL = "original";
	public static final String SIZE_MID = "mid";
	public static final String SIZE_COVER = "cover";
	public static final String SIZE_THUMB = "thumb";
	public static final String TYPE_PROFILE = "profile";
	public static final String TYPE_POSTER = "poster";
	public String type;
	public String url;
	public String size;
	public int width;
	public int height;
}

No hay nada raro en estas clases. En la clase Movie proporcionamos el método retrieveThumbnail el cual hace loop por las Images disponibles y retorna una de tamaño “thumb” y tipo “poster”.

3.- Haciendo el parser

Procederemos con la creación de una clase llamada XmlParser la cual utiliza SAX para parsear las respuestas XML. La clase utiliza dos handlers de código nuestro (PersonalHandler y MovieHandler) para realizar el parseo. El código para la clase es el siguiente:

package com.javacodegeeks.android.apps.moviesearchapp.services;
import java.io.StringReader;
import java.util.ArrayList;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import com.javacodegeeks.android.apps.moviesearchapp.handlers.MovieHandler;
import com.javacodegeeks.android.apps.moviesearchapp.handlers.PersonHandler;
import com.javacodegeeks.android.apps.moviesearchapp.model.Movie;
import com.javacodegeeks.android.apps.moviesearchapp.model.Person;

public class XmlParser {
	private XMLReader initializeReader() throws ParserConfigurationException, SAXException {
		SAXParserFactory factory = SAXParserFactory.newInstance();
		// create a parser
		SAXParser parser = factory.newSAXParser();
		// create the reader (scanner)
		XMLReader xmlreader = parser.getXMLReader();
		return xmlreader;
	}

	public ArrayList<Person> parsePeopleResponse(String xml) {
		try {
			XMLReader xmlreader = initializeReader();
			PersonHandler personHandler = new PersonHandler();
			// assign our handler
			xmlreader.setContentHandler(personHandler);
			// perform the synchronous parse
			xmlreader.parse(new InputSource(new StringReader(xml)));
			return personHandler.retrievePersonList();
		}
		catch (Exception e) {
			e.printStackTrace();
			return null;
		}
	}

	public ArrayList<Movie> parseMoviesResponse(String xml) {
		try {
			XMLReader xmlreader = initializeReader();
			MovieHandler movieHandler = new MovieHandler();
			// assign our handler
			xmlreader.setContentHandler(movieHandler);
			// perform the synchronous parse
			xmlreader.parse(new InputSource(new StringReader(xml)));
			return movieHandler.retrieveMoviesList();
		}
		catch (Exception e) {
			e.printStackTrace();
			return null;
		}
	}
}

En cada método , tenemos que recuperar una referencia de la clase factory parser SAX utilizando el método estático de la SAXParserFactory. Ese método retorna la implementación apropiada para Android. Entonces, el objeto SAXParser se crea utilizando el método new SAXParser, que crea una nueva instancia de una SAXParser utilizando los parámetros de Factory configurados actualmente.

La clase SAXParser define el API que envuelve una implementación de la clase XMLReader. XMLReader es un interfaz para leer un documento XML utilizando callbacks. Los callbacks están definidos generalmente via clases que extienden la clase DefaultHandler, que es la clase por defecto base para los event handlers de SAX2. Creamos dos handlers, uno para parseo de las respuestas de búsqueda de personas (PersonHandler) y uno para parsear las respuestas de búsqueda de películas (MovieHandler). El código para la clase PersonHandler es este (el código para la clase MovieHandler es casi el mismo):

package com.javacodegeeks.android.apps.moviesearchapp.handlers;
import java.util.ArrayList;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
import com.javacodegeeks.android.apps.moviesearchapp.model.Image;
import com.javacodegeeks.android.apps.moviesearchapp.model.Person;

public class PersonHandler extends DefaultHandler {
	private StringBuffer buffer = new StringBuffer();
	private ArrayList<Person> personList;
	private Person person;
	private ArrayList<Image> personImagesList;
	private Image personImage;

	@Override
	public void startElement(String namespaceURI, String localName,String qName, Attributes atts) throws SAXException {
		buffer.setLength(0);
		if (localName.equals("people")) {
			personList = new ArrayList<Person>();
		} else if (localName.equals("person")) {
			person = new Person();
		} else if (localName.equals("images")) {
			personImagesList = new ArrayList<Image>();
		} else if (localName.equals("image")) {
			personImage = new Image();
			personImage.type = atts.getValue("type");
			personImage.url = atts.getValue("url");
			personImage.size = atts.getValue("size");
			personImage.width = Integer.parseInt(atts.getValue("width"));
			personImage.height = Integer.parseInt(atts.getValue("height"));
		}
	}

	@Override
	public void endElement(String uri, String localName, String qName)throws SAXException {
		if (localName.equals("person")) {
			personList.add(person);
		} else if (localName.equals("score")) {
			person.score = buffer.toString();
		} else if (localName.equals("popularity")) {
			person.popularity = buffer.toString();
		} else if (localName.equals("name")) {
			person.name = buffer.toString();
		} else if (localName.equals("id")) {
			person.id = buffer.toString();
		} else if (localName.equals("biography")) {
			person.biography = buffer.toString();
		} else if (localName.equals("url")) {
			person.url = buffer.toString();
		} else if (localName.equals("version")) {
			person.version = buffer.toString();
		} else if (localName.equals("last_modified_at")) {
			person.lastModifiedAt = buffer.toString();
		} else if (localName.equals("image")) {
			personImagesList.add(personImage);
		} else if (localName.equals("images")) {
			person.imagesList = personImagesList;
		}
	}

	@Override
	public void characters(char[] ch, int start, int length) {
		buffer.append(ch, start, length);
	}

	public ArrayList<Person> retrievePersonList() {
		return personList;
	}

}

Aquí se utiliza el tipo de parseado SAX , luego el código de arriba te debe ser familiar si has utilizado alguna vez este parser. Nota que en vez de parámetros qName , es la variable localName la que guarda los datos del elemento.

En nuestra clase, definimos las funciones callback necesarias:

• startElement: Invocado cuando se encuentra una etiqueta XML de comienzo de nuevo elemento. Inicializamos el campo apropiado ahí.
• endElement: Invocado cuando se encuentra una etiqueta XML de final del elemento. Entonces los campos correspondientes son rellenados con los datos leidos hasta ese momento.
• characters: Invocado cuando se encuentra un nuevo texto dentro de un elemento. Un buffer interno es rellenado con el contenido del elemento.

Nota que dentro de la respuesta, puede haber varios elementos Person y dentro de cada uno de ellos, varias Images. Particularmente para las imágenes, la información relevante reside dentro de los atributos del elemento y no dentro del nodo de texto. Asi que se usa el método apropiado getValue para extraer la información.

En este punto hemos preparado la infraestructura para realizar el parseo del XML de las respuestas XML utilizando la aproximación SAX.

El MovieHandler es :

package com.jes.android.smfinder;

import java.util.ArrayList;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class MovieHandler extends DefaultHandler {

	private StringBuffer buffer = new StringBuffer();

	private ArrayList<Movie> moviesList;
	private Movie movie;
	private ArrayList<Image> movieImagesList;
	private Image movieImage;

	@Override
	public void startElement(String namespaceURI, String localName,
			String qName, Attributes atts) throws SAXException {

		buffer.setLength(0);

		if (localName.equals("movies")) {
			moviesList = new ArrayList<Movie>();
		}
		else if (localName.equals("movie")) {
			movie = new Movie();
		}
		else if (localName.equals("images")) {
			movieImagesList = new ArrayList<Image>();
		}
		else if (localName.equals("image")) {
			movieImage = new Image();
			movieImage.type = atts.getValue("type");
			movieImage.url = atts.getValue("url");
			movieImage.size = atts.getValue("size");
			movieImage.width = Integer.parseInt(atts.getValue("width"));
			movieImage.height = Integer.parseInt(atts.getValue("height"));
		}

	}

	@Override
	public void endElement(String uri, String localName, String qName)throws SAXException {

		if (localName.equals("movie")) {
			moviesList.add(movie);
		}
		else if (localName.equals("score")) {
			movie.score = buffer.toString();
		}
		else if (localName.equals("popularity")) {
			movie.popularity = buffer.toString();
		}
		else if (localName.equals("translated")) {
			movie.translated = Boolean.valueOf(buffer.toString());
		}
		else if (localName.equals("adult")) {
			movie.adult = Boolean.valueOf(buffer.toString());
		}
		else if (localName.equals("language")) {
			movie.language = buffer.toString();
		}
		else if (localName.equals("original_name")) {
			movie.originalName = buffer.toString();
		}
		else if (localName.equals("name")) {
			movie.name = buffer.toString();
		}
		else if (localName.equals("type")) {
			movie.type = buffer.toString();
		}
		else if (localName.equals("id")) {
			movie.id = buffer.toString();
		}
		else if (localName.equals("imdb_id")) {
			movie.imdbId = buffer.toString();
		}
		else if (localName.equals("url")) {
			movie.url = buffer.toString();
		}
		else if (localName.equals("votes")) {
			movie.votes = buffer.toString();
		}
		else if (localName.equals("rating")) {
			movie.rating = buffer.toString();
		}
		else if (localName.equals("certification")) {
			movie.certification = buffer.toString();
		}
		else if (localName.equals("overview")) {
			movie.overview = buffer.toString();
		}
		else if (localName.equals("released")) {
			movie.released = buffer.toString();
		}
		else if (localName.equals("version")) {
			movie.version = buffer.toString();
		}
		else if (localName.equals("last_modified_at")) {
			movie.lastModifiedAt = buffer.toString();
		}
		else if (localName.equals("image")) {
			movieImagesList.add(movieImage);
		}
		else if (localName.equals("images")) {
			movie.imagesList = movieImagesList;
		}

	}

	@Override
	public void characters(char[] ch, int start, int length) {
		buffer.append(ch, start, length);
	}

	public ArrayList<Movie> retrieveMoviesList() {
		return moviesList;
	}

}