KMZWriter.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * KMZWriter.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007 by the members listed in the COPYING,        *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.vis.kml;

import java.io.BufferedWriter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.util.HashMap;
import java.util.Map;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

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

import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.matsim.core.api.internal.MatsimSomeWriter;

import net.opengis.kml.v_2_2_0.KmlType;
import net.opengis.kml.v_2_2_0.LinkType;
import net.opengis.kml.v_2_2_0.NetworkLinkType;
import net.opengis.kml.v_2_2_0.ObjectFactory;

public class KMZWriter implements MatsimSomeWriter {

    private static final Logger log = Logger.getLogger(KMZWriter.class);

    private BufferedWriter out = null;

    private ZipOutputStream zipOut = null;

    private final Map<String, String> nonKmlFiles = new HashMap<String, String>();

    private final static Marshaller marshaller;

    private final static ObjectFactory kmlObjectFactory = new ObjectFactory();

    static {
        try {
            JAXBContext jaxbContext = JAXBContext.newInstance("net.opengis.kml.v_2_2_0");
            marshaller = jaxbContext.createMarshaller();
            marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);
        } catch (JAXBException e) {
            throw new RuntimeException(e);
        }
    }

    public KMZWriter(final String outFilename) {
        log.setLevel( Level.INFO ) ;
        
        String filename = outFilename;
        if (filename.endsWith(".kml") || filename.endsWith(".kmz")) {
            filename = filename.substring(0, filename.length() - 4);
        }

        try {
            this.zipOut = new ZipOutputStream(new FileOutputStream(filename + ".kmz"));
            this.out = new BufferedWriter(new OutputStreamWriter(this.zipOut, "UTF8"));
        } catch (IOException e) {
            e.printStackTrace();
        }

        // generate the first KML entry in the zip file that links to the (later
        // added) main-KML.
        // this is required as GoogleEarth will only display the first-added KML in
        // a kmz.
        KmlType docKML = kmlObjectFactory.createKmlType();
        NetworkLinkType nl = kmlObjectFactory.createNetworkLinkType();

        LinkType link = kmlObjectFactory.createLinkType();
        link.setHref("main.kml");
        nl.setLink(link);
        docKML.setAbstractFeatureGroup(kmlObjectFactory.createNetworkLink(nl));

        writeKml("doc.kml", docKML);
    }

    public void writeLinkedKml(final String filename, final KmlType kml) {
        if (filename.equals("doc.kml")) {
            throw new IllegalArgumentException(
                    "The filename 'doc.kml' is reserved for the primary kml.");
        }
        if (filename.equals("main.kml")) {
            throw new IllegalArgumentException(
                    "The filename 'main.kml' is reserved for the main kml.");
        }
        writeKml(filename, kml);
    }

    public void writeMainKml(final KmlType kml) {
        writeKml("main.kml", kml);
    }

    public void close() {
        try {
            this.out.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public void addNonKMLFile(final String filename, final String inZipFilename) throws IOException {
        if (this.nonKmlFiles.containsKey(filename) && (inZipFilename.compareTo(this.nonKmlFiles.get(filename)) == 0)) {
            log.warn("File: " + filename + " is already included in the kmz as " + inZipFilename);
            return;
        }
        this.nonKmlFiles.put(filename, inZipFilename);
        FileInputStream fis = new FileInputStream(filename);
        try {
            addNonKMLFile(fis, inZipFilename);
        } finally {
            fis.close();
        }
    }

    public void addNonKMLFile(final InputStream data, final String inZipFilename) throws IOException {
        try {
            // Allocate a buffer for reading the input files.
            byte[] buffer = new byte[4096];
            int bytesRead;
            // Create a zip entry and add it to the zip.
            ZipEntry entry = new ZipEntry(inZipFilename);
            this.zipOut.putNextEntry(entry);

            // Read the file the file and write it to the zip.
            while ((bytesRead = data.read(buffer)) != -1) {
                this.zipOut.write(buffer, 0, bytesRead);
            }
            log.debug(entry.getName() + " added to kmz.");
        } finally {
            data.close();
        }
    }

    public void addNonKMLFile(final byte[] data, final String inZipFilename) throws IOException {
        // Create a zip entry and add it to the zip.
        ZipEntry entry = new ZipEntry(inZipFilename);
        this.zipOut.putNextEntry(entry);
        this.zipOut.write(data);
        log.debug(entry.getName() + " added to kmz.");
    }

    private void writeKml(final String filename, final KmlType kml) {
        try {
            ZipEntry ze = new ZipEntry(filename);
            ze.setMethod(ZipEntry.DEFLATED);
            this.zipOut.putNextEntry(ze);

            try {
                marshaller.marshal(kmlObjectFactory.createKml(kml), out);
            } catch (JAXBException e) {
                e.printStackTrace();
            }

            this.out.flush();

        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}