org.openprovenance.prov.sql.ProvSerialiser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of prov-sql Show documentation
Java Objects representing the PROV model, XML serialiser/deserialiser for them, and ORM mapping generated by HyperJaxb.
The newest version!
package org.openprovenance.prov.sql;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.bind.PropertyException;

import org.openprovenance.prov.interop.InteropMediaType;
import org.openprovenance.prov.model.Document;
import org.openprovenance.prov.model.Namespace;

import org.openprovenance.prov.model.exception.UncheckedException;
import org.openprovenance.prov.xml.NamespacePrefixMapper;
import org.w3c.dom.Node;

import java.io.OutputStream;
import java.io.StringWriter;
import java.io.File;
import java.util.Collection;
import java.util.Set;

/** Serialiser of PROV Graphs. */

public class ProvSerialiser implements org.openprovenance.prov.model.ProvSerialiser {

    final static private java.util.Collection myMedia= Set.of(InteropMediaType.MEDIA_APPLICATION_SQL);

    @Override
    public Collection mediaTypes() {
        return myMedia;
    }

    private ObjectFactory2 of=new ObjectFactory2();
	static DocumentBuilder docBuilder;


    /** Note DocumentBuilderFactory is documented to be non thread safe. 
        TODO: code analysis, of potential concurrency issues. */
	static void initBuilder() {
		try {
			DocumentBuilderFactory docBuilderFactory = DocumentBuilderFactory.newInstance();
			docBuilderFactory.setNamespaceAware(true);
			docBuilder = docBuilderFactory.newDocumentBuilder();
		} catch (ParserConfigurationException ex) {
			throw new RuntimeException(ex);
		}
	}

    private static ThreadLocal threadSerialiser =
        new ThreadLocal () {
        protected synchronized ProvSerialiser initialValue () {
            return new ProvSerialiser();
        }
    };

    public static ProvSerialiser getThreadProvSerialiser() {
        return threadSerialiser.get();
    }


    
    static {
        initBuilder();
    }
    protected JAXBContext jc;

    public ProvSerialiser () {
        try {
            jc = JAXBContext.newInstance( ProvFactory.packageList );
        } catch (JAXBException e) {
            throw new UncheckedException(e);
        }
        //System.out.println("JAXBContext => " + jc.getClass());
    }

    public ProvSerialiser (String packageList) throws JAXBException {
        jc = JAXBContext.newInstance( packageList );
        //System.out.println("JAXBContext => " + jc.getClass());
    }

    public void configurePrefixes(Marshaller m) throws PropertyException {
        configurePrefixes(m,new Namespace());
    }

    public void configurePrefixes(Marshaller m, Namespace namespaces) throws PropertyException {
        m.setProperty("com.sun.xml.bind.namespacePrefixMapper",
                             new NamespacePrefixMapper(namespaces));
	//System.out.println("--------------> ");
	//m.setAdapter(new org.w3._2001.xmlschema.Adapter1());
    }

    /** By default we use a document provided by the DocumentBuilder
        factory. If this functionality is required,
        PStructureSerialiser needs to be subclassed and the
        defaultEmptyDocument method overriden. */

    public org.w3c.dom.Document defaultEmptyDocument () {
        return docBuilder.newDocument();
    }
 
        
  

   
    public org.w3c.dom.Document serialiseDocument (Document request) throws JAXBException {
        return (org.w3c.dom.Document) serialiseDocument (defaultEmptyDocument(), request);
    }
    
    public Node serialiseDocument (Node addTo, Document graph)
        throws JAXBException {
        Marshaller m=jc.createMarshaller();
        m.marshal(of.createDocument(graph),addTo);
        return addTo;
    }
    public String serialiseDocument (StringWriter sw, Document graph)
        throws JAXBException {
        Marshaller m=jc.createMarshaller();
        m.marshal(of.createDocument(graph),sw);
        return sw.toString();
    }

    public String serialiseDocument (StringWriter sw, Document graph, boolean format)
        throws JAXBException {
        Marshaller m=jc.createMarshaller();
        m.setProperty("jaxb.formatted.output",format);
        configurePrefixes(m,graph.getNamespace());
        m.marshal(of.createDocument(graph),sw);
        return sw.toString();
    }
    

    public void serialiseDocument (OutputStream out, Document graph, boolean format) {
        try {
            Marshaller m = jc.createMarshaller();
            m.setProperty("jaxb.formatted.output", format);
            configurePrefixes(m, graph.getNamespace());
            m.marshal(of.createDocument(graph), out);
        } catch (JAXBException e) {
            throw new UncheckedException(e);
        }
    }

    @Override
    public void serialiseDocument(OutputStream out, Document document, String mediaType, boolean formatted) {
        serialiseDocument(out, document, formatted);
    }

    public void serialiseDocument (File file, Document graph, boolean format)
	        throws JAXBException {
	Marshaller m=jc.createMarshaller();
	m.setProperty("jaxb.formatted.output",format);
	configurePrefixes(m,graph.getNamespace());
	m.marshal(of.createDocument(graph),file);
    }


}