es.us.isa.bpmn.handler.AbstractModelHandler Maven / Gradle / Ivy

Go to download
package es.us.isa.bpmn.handler;


import com.sun.xml.bind.IDResolver;
import org.xml.sax.SAXException;

import javax.xml.bind.*;
import java.io.*;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Callable;

/**
 * Clase abstracta a partir de la cual heredan las clases que permiten exportar e importar a XML. 
 * 
 * Cuando se importa de xml se obtiene la informacion que contiene en instancias de clases generadas con Jaxb (clases Jaxb) y a partir de 
 * esas instancias se puede obtener instancias de clases que modelen esa informacion (clases del modelo), es decir:
 * 
 * codigo xml -> instancias de clases Jabx -> clases del modelo
 * 
 * Esto permite que si cambia la sintaxis del xml (con lo cual cambian las clases Jaxb), los proyectos que utilicen las clases del modelo 
 * no sufren cambios. 
 * 
 * Esta clase tiene las siguientes funciones:
 * - Carga un xml y obtiene las clases del modelo.
 * - A partir de las clases del modelo genera un xml.
 *
 * @author resinas
 * @author Edelia
 *
 */
@SuppressWarnings("rawtypes")
public abstract class AbstractModelHandler implements ModelHandler {
	
	private JAXBContext jc;
	
	// XML Root element
	private JAXBElement element;

    private Map elementIds;

	/**
	 * Constructor de la clase.
	 * Realiza las inicializaciones implementadas en las subclases mediante iniLoader.
	 * 
	 * @throws JAXBException
	 */
	public AbstractModelHandler() {
		super();
        elementIds = new HashMap();
        xmlConfig(this.iniLoader());
	}

    public AbstractModelHandler(JAXBElement element) {
        this();
        this.element = element;
    }

    /**
	 * Configuracion para importar y exportar XML.
	 * Este metodo debe ser invocado en el iniLoader de la subclase, para especificar las clases Jaxb y la clase factory utilizadas. 
	 * 
	 * @param classList Arreglo con las clases para leer y guardar como xml 
	 */
	private void xmlConfig(Class[] classList) {
		try {
			this.jc = JAXBContext.newInstance( classList );
		} catch (JAXBException e) {
            throw new RuntimeException("Unable to load xml context: " + e);
        }
    }

	/**
	 * Devuelve el valor del atributo element
	 * Objeto JAXBElement que se obtiene del unmarshall de un xml
	 * 
	 * @return Valor del atributo
	 */
	protected JAXBElement getElement() {
		return this.element;
	}

    protected Map getElementIds() {
        return elementIds;
    }

    @Override
    public Object getElement(String id) {
        return elementIds.get(id);
    }

	/**
	 * Realiza las inicializaciones propias de la clase que implementa a ModelHandler. 
	 * En esta inicializacion hay que incluir la llamada a xmlConfig para configurar las clases Jaxb y la clase factory.
	 * 
	 * @throws JAXBException
	 */
	protected abstract Class[] iniLoader();
	
	/**
	 * Preprocessing of the model before saving it
	 */
	protected abstract void beforeSave();
	
	/**
	 * Postprocessing of the loaded model.
	 */
	protected abstract void afterLoad();


    /**
	 * Genera las instancias de clases del modelo a partir del xml en un stream
     * 
     * @param stream 
     * @throws JAXBException
     */
	public void load(InputStream stream) throws JAXBException {
        Unmarshaller unmarshaller = jc.createUnmarshaller();
        unmarshaller.setProperty(com.sun.xml.bind.IDResolver.class.getName(), new MyIDResolver());

        this.element =  (JAXBElement) unmarshaller.unmarshal(stream);

        this.afterLoad();
    }


    /**
	 * Salva el xml a un stream, a partir de las instancias de clases del modelo
	 * 
	 * @param stream
	 */
	public void save(OutputStream stream)  {
        this.beforeSave();

        try {
            Marshaller m = jc.createMarshaller();
            m.marshal(element, stream);
        } catch (JAXBException e) {
            e.printStackTrace();
            throw new RuntimeException("Unable to serialize BPNM model", e);
        }
	}

    public class MyIDResolver extends IDResolver {

        @Override
        public void startDocument(ValidationEventHandler eventHandler) throws SAXException {
            if(elementIds != null)
                elementIds.clear();
        }

        @Override
        public void bind(String s, Object o) throws SAXException {
            elementIds.put(s, o);
        }

        @Override
        public Callable resolve(final String s, Class aClass) throws SAXException {
            return new Callable