ca.nrc.cadc.caom2.xml.ArtifactAccessWriter.java Source code

Java tutorial

Introduction

Here is the source code for ca.nrc.cadc.caom2.xml.ArtifactAccessWriter.java

Source

/*
************************************************************************
*******************  CANADIAN ASTRONOMY DATA CENTRE  *******************
**************  CENTRE CANADIEN DE DONNES ASTRONOMIQUES  **************
*
*  (c) 2018.                            (c) 2018.
*  Government of Canada                 Gouvernement du Canada
*  National Research Council            Conseil national de recherches
*  Ottawa, Canada, K1A 0R6              Ottawa, Canada, K1A 0R6
*  All rights reserved                  Tous droits rservs
*
*  NRC disclaims any warranties,        Le CNRC dnie toute garantie
*  expressed, implied, or               nonce, implicite ou lgale,
*  statutory, of any kind with          de quelque nature que ce
*  respect to the software,             soit, concernant le logiciel,
*  including without limitation         y compris sans restriction
*  any warranty of merchantability      toute garantie de valeur
*  or fitness for a particular          marchande ou de pertinence
*  purpose. NRC shall not be            pour un usage particulier.
*  liable in any event for any          Le CNRC ne pourra en aucun cas
*  damages, whether direct or           tre tenu responsable de tout
*  indirect, special or general,        dommage, direct ou indirect,
*  consequential or incidental,         particulier ou gnral,
*  arising from the use of the          accessoire ou fortuit, rsultant
*  software.  Neither the name          de l'utilisation du logiciel. Ni
*  of the National Research             le nom du Conseil National de
*  Council of Canada nor the            Recherches du Canada ni les noms
*  names of its contributors may        de ses  participants ne peuvent
*  be used to endorse or promote        tre utiliss pour approuver ou
*  products derived from this           promouvoir les produits drivs
*  software without specific prior      de ce logiciel sans autorisation
*  written permission.                  pralable et particulire
*                                       par crit.
*
*  This file is part of the             Ce fichier fait partie du projet
*  OpenCADC project.                    OpenCADC.
*
*  OpenCADC is free software:           OpenCADC est un logiciel libre ;
*  you can redistribute it and/or       vous pouvez le redistribuer ou le
*  modify it under the terms of         modifier suivant les termes de
*  the GNU Affero General Public        la GNU Affero General Public
*  License as published by the          License? telle que publie
*  Free Software Foundation,            par la Free Software Foundation
*  either version 3 of the              : soit la version 3 de cette
*  License, or (at your option)         licence, soit ( votre gr)
*  any later version.                   toute version ultrieure.
*
*  OpenCADC is distributed in the       OpenCADC est distribu
*  hope that it will be useful,         dans lespoir quil vous
*  but WITHOUT ANY WARRANTY;            sera utile, mais SANS AUCUNE
*  without even the implied             GARANTIE : sans mme la garantie
*  warranty of MERCHANTABILITY          implicite de COMMERCIALISABILIT
*  or FITNESS FOR A PARTICULAR          ni dADQUATION  UN OBJECTIF
*  PURPOSE.  See the GNU Affero         PARTICULIER. Consultez la Licence
*  General Public License for           Gnrale Publique GNU Affero
*  more details.                        pour plus de dtails.
*
*  You should have received             Vous devriez avoir reu une
*  a copy of the GNU Affero             copie de la Licence Gnrale
*  General Public License along         Publique GNU Affero avec
*  with OpenCADC.  If not, see          OpenCADC ; si ce nest
*  <http://www.gnu.org/licenses/>.      pas le cas, consultez :
*                                       <http://www.gnu.org/licenses/>.
*
************************************************************************
*/

package ca.nrc.cadc.caom2.xml;

import ca.nrc.cadc.caom2.access.ArtifactAccess;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.net.URI;
import java.util.List;
import org.apache.log4j.Logger;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;

/**
 *
 * @author pdowler
 */
public class ArtifactAccessWriter {
    private static final Logger log = Logger.getLogger(ArtifactAccessWriter.class);

    private final boolean writeEmptyCollections;

    public ArtifactAccessWriter() {
        this(false);
    }

    public ArtifactAccessWriter(boolean writeEmptyCollections) {
        this.writeEmptyCollections = writeEmptyCollections;
    }

    public void write(ArtifactAccess aa, OutputStream ostream) throws IOException {
        write(aa, new OutputStreamWriter(ostream));
    }

    public void write(ArtifactAccess aa, Writer writer) throws IOException {
        Element root = new Element(ArtifactAccessReader.ENAMES.artifactAccess.name());

        Element ae = new Element(ArtifactAccessReader.ENAMES.artifact.name());
        root.addContent(ae);

        addChild(ae, ArtifactAccessReader.ENAMES.uri.name(), aa.getArtifact().getURI().toASCIIString());
        addChild(ae, ArtifactAccessReader.ENAMES.productType.name(), aa.getArtifact().getProductType().getValue());
        addChild(ae, ArtifactAccessReader.ENAMES.releaseType.name(), aa.getArtifact().getReleaseType().getValue());
        if (aa.getArtifact().contentChecksum != null) {
            addChild(ae, ArtifactAccessReader.ENAMES.contentChecksum.name(),
                    aa.getArtifact().contentChecksum.toASCIIString());
        }
        if (aa.getArtifact().contentLength != null) {
            addChild(ae, ArtifactAccessReader.ENAMES.contentLength.name(),
                    aa.getArtifact().contentLength.toString());
        }
        if (aa.getArtifact().contentType != null) {
            addChild(ae, ArtifactAccessReader.ENAMES.contentType.name(), aa.getArtifact().contentType);
        }

        Element pub = new Element(ArtifactAccessReader.ENAMES.isPublic.name());
        pub.setText(Boolean.toString(aa.isPublic));
        root.addContent(pub);

        Element rg = new Element(ArtifactAccessReader.ENAMES.readGroups.name());
        if (!aa.getReadGroups().isEmpty() || writeEmptyCollections) {
            root.addContent(rg);
        }
        addGroups(aa.getReadGroups(), rg);

        Document doc = new Document(root);
        XMLOutputter outputter = new XMLOutputter();
        outputter.setFormat(Format.getPrettyFormat());
        outputter.output(doc, writer);
    }

    private void addChild(Element parent, String ename, String eval) {
        Element uri = new Element(ename);
        uri.setText(eval);
        parent.addContent(uri);
    }

    private void addGroups(List<URI> groups, Element parent) {
        for (URI u : groups) {
            Element uri = new Element(ArtifactAccessReader.ENAMES.uri.name());
            uri.setText(u.toASCIIString());
            parent.addContent(uri);
        }
    }
}