org.nmdp.ngs.gtr.GtrWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ngs-gtr Show documentation
Mapping for GTR XSDs.
The newest version!
/*

    ngs-gtr  Mapping for GTR XSDs.
    Copyright (c) 2014-2015 National Marrow Donor Program (NMDP)

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation; either version 3 of the License, or (at
    your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.gnu.org/licenses/lgpl.html

*/
package org.nmdp.ngs.gtr;

import static com.google.common.base.Preconditions.checkNotNull;

import java.net.URL;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;

import javax.xml.XMLConstants;

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

import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;

import org.nmdp.ngs.gtr.jaxb.GTRPublicData;

import org.xml.sax.SAXException;

/**
 * Writer for GTR public data xml.
 */
public final class GtrWriter {

    /**
     * Private no-arg constructor.
     */
    private GtrWriter() {
        // empty
    }


    /**
     * Write the specified GTR public data to the specified writer.
     *
     * @param data GTR public data to write, must not be null
     * @param writer writer to write to, must not be null
     * @throws IOException if an I/O error occurs
     */
    public static void write(final GTRPublicData data, final Writer writer) throws IOException {
        checkNotNull(data);
        checkNotNull(writer);

        try {
            // todo:  may want to cache some of this for performance reasons
            JAXBContext context = JAXBContext.newInstance(GTRPublicData.class);
            Marshaller marshaller = context.createMarshaller();
            SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
            URL schemaURL = GtrReader.class.getResource("/org/nmdp/ngs/gtr/xsd/GTRPublicData.xsd");
            Schema schema = schemaFactory.newSchema(schemaURL);
            marshaller.setSchema(schema);
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            marshaller.marshal(data, writer);
        }
        catch (JAXBException | SAXException e) {
            throw new IOException("could not marshal GTRPublicData", e);
        }
    }

    /**
     * Write the specified GTR public data to the specified file.
     *
     * @param data GTR public data to write, must not be null
     * @param file file to write to, must not be null
     * @throws IOException if an I/O error occurs
     */
    public static void write(final GTRPublicData data, final File file) throws IOException {
        checkNotNull(data);
        checkNotNull(file);
        try (BufferedWriter writer = new BufferedWriter(new FileWriter(file))) {
            write(data, writer);
        }
    }

    /**
     * Write the specified GTR public data to the specified output stream.
     *
     * @param data GTR public data to write, must not be null
     * @param outputStream output stream to write to, must not be null
     * @throws IOException if an I/O error occurs
     */
    public static void write(final GTRPublicData data, final OutputStream outputStream) throws IOException {
        checkNotNull(data);
        checkNotNull(outputStream);
        try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(outputStream))) {
            write(data, writer);
        }
    }
}