org.jpmml.model.JAXBUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmml-model Show documentation
JPMML class model
There is a newer version: 1.6.6
/*
 * Copyright (c) 2014 Villu Ruusmann
 */
package org.jpmml.model;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;

import javax.xml.XMLConstants;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;

import jakarta.xml.bind.Binder;
import jakarta.xml.bind.JAXBContext;
import jakarta.xml.bind.JAXBException;
import jakarta.xml.bind.Marshaller;
import jakarta.xml.bind.Unmarshaller;
import org.dmg.pmml.PMML;
import org.dmg.pmml.PMMLObject;
import org.jpmml.model.filters.ExportFilter;
import org.jpmml.model.filters.ImportFilter;
import org.xml.sax.SAXException;

public class JAXBUtil {

	private JAXBUtil(){
	}

	/**
	 * 
	 * Unmarshals a {@link PMML} class model object.
	 * 
	 *
	 * @param source Input source containing a complete PMML schema version 4.4 document.
	 *
	 * @see ImportFilter
	 */
	static
	public PMML unmarshalPMML(Source source) throws JAXBException {
		return (PMML)unmarshal(source);
	}

	/**
	 * 
	 * Unmarshals any class model object.
	 * 
	 *
	 * @param source Input source containing a complete PMML schema version 4.4 document or any fragment of it.
	 */
	static
	public Object unmarshal(Source source) throws JAXBException {
		Unmarshaller unmarshaller = createUnmarshaller();

		return unmarshaller.unmarshal(source);
	}

	/**
	 * 
	 * Marshals a {@link PMML} class model object.
	 * 
	 *
	 * @see ExportFilter
	 */
	static
	public void marshalPMML(PMML pmml, Result result) throws JAXBException {
		marshal(pmml, result);
	}

	/**
	 * 
	 * Marshals any class model object.
	 * 
	 */
	static
	public void marshal(Object object, Result result) throws JAXBException {
		Marshaller marshaller = createMarshaller();

		marshaller.marshal(object, result);
	}

	static
	public Schema getSchema() throws IOException, SAXException {

		if(JAXBUtil.schema == null){
			SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);

			URL url = (org.dmg.pmml.ObjectFactory.class).getResource("/pmml.xsd");
			if(url == null){
				throw new FileNotFoundException();
			}

			JAXBUtil.schema = schemaFactory.newSchema(url);
		}

		return JAXBUtil.schema;
	}

	static
	public JAXBContext getContext() throws JAXBException {

		if(JAXBUtil.context == null){
			JAXBUtil.context = JAXBContext.newInstance(getObjectFactoryClasses());
		}

		return JAXBUtil.context;
	}

	static
	public void setContext(JAXBContext context){
		JAXBUtil.context = context;
	}

	static
	public Class[] getObjectFactoryClasses(){
		return new Class[]{
			// org.dmg.pmml.*
			org.dmg.pmml.ObjectFactory.class,
			org.dmg.pmml.anomaly_detection.ObjectFactory.class,
			org.dmg.pmml.association.ObjectFactory.class,
			org.dmg.pmml.baseline.ObjectFactory.class,
			org.dmg.pmml.bayesian_network.ObjectFactory.class,
			org.dmg.pmml.clustering.ObjectFactory.class,
			org.dmg.pmml.gaussian_process.ObjectFactory.class,
			org.dmg.pmml.general_regression.ObjectFactory.class,
			org.dmg.pmml.mining.ObjectFactory.class,
			org.dmg.pmml.naive_bayes.ObjectFactory.class,
			org.dmg.pmml.nearest_neighbor.ObjectFactory.class,
			org.dmg.pmml.neural_network.ObjectFactory.class,
			org.dmg.pmml.regression.ObjectFactory.class,
			org.dmg.pmml.rule_set.ObjectFactory.class,
			org.dmg.pmml.scorecard.ObjectFactory.class,
			org.dmg.pmml.sequence.ObjectFactory.class,
			org.dmg.pmml.support_vector_machine.ObjectFactory.class,
			org.dmg.pmml.text.ObjectFactory.class,
			org.dmg.pmml.time_series.ObjectFactory.class,
			org.dmg.pmml.tree.ObjectFactory.class,
			// org.jpmml.model.*
			org.jpmml.model.cells.ObjectFactory.class
		};
	}

	static
	public Marshaller createMarshaller() throws JAXBException {
		JAXBContext context = getContext();

		Marshaller marshaller = context.createMarshaller();
		marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);

		return marshaller;
	}

	static
	public Unmarshaller createUnmarshaller() throws JAXBException {
		JAXBContext context = getContext();

		Unmarshaller unmarshaller = context.createUnmarshaller();

		return unmarshaller;
	}

	static
	public  Binder createBinder(Class domType) throws JAXBException {
		JAXBContext context = getContext();

		Binder binder = context.createBinder(domType);

		return binder;
	}

	static
	public  E clone(E object) throws JAXBException, IOException {
		return clone(getContext(), object);
	}

	@SuppressWarnings("unchecked")
	static
	public  E clone(JAXBContext context, E object) throws JAXBException, IOException {
		DirectByteArrayOutputStream buffer = new DirectByteArrayOutputStream(1024 * 1024);

		Marshaller marshaller = context.createMarshaller();

		try(OutputStream os = buffer){
			marshaller.marshal(object, os);
		}

		Unmarshaller unmarshaller = context.createUnmarshaller();

		try(InputStream is = buffer.getInputStream()){
			return (E)unmarshaller.unmarshal(is);
		}
	}

	private static Schema schema = null;

	private static JAXBContext context = null;
}