001/*
002 * Copyright (c) 2014-2015 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: crawl $'
006 * '$Date: 2015-12-16 21:30:37 +0000 (Wed, 16 Dec 2015) $' 
007 * '$Revision: 34341 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029package org.kepler.gis.actor.kml;
030
031import java.io.File;
032import java.io.IOException;
033import java.util.ArrayList;
034import java.util.Arrays;
035import java.util.LinkedList;
036import java.util.List;
037
038import de.micromata.opengis.kml.v_2_2_0.Document;
039import de.micromata.opengis.kml.v_2_2_0.Feature;
040import de.micromata.opengis.kml.v_2_2_0.Kml;
041import de.micromata.opengis.kml.v_2_2_0.NetworkLink;
042import ptolemy.actor.lib.Transformer;
043import ptolemy.actor.parameters.PortParameter;
044import ptolemy.data.ArrayToken;
045import ptolemy.data.StringToken;
046import ptolemy.data.Token;
047import ptolemy.data.type.ArrayType;
048import ptolemy.data.type.BaseType;
049import ptolemy.kernel.CompositeEntity;
050import ptolemy.kernel.util.IllegalActionException;
051import ptolemy.kernel.util.NameDuplicationException;
052import ptolemy.kernel.util.SingletonAttribute;
053
054/** An actor that combines KML files into a single KML file.
055 *  The input is an array of KML files.
056 *  
057 *  @author Daniel Crawl
058 *  @version $Id: KMLCombineFiles.java 34341 2015-12-16 21:30:37Z crawl $ 
059 */
060public class KMLCombineFiles extends Transformer {
061
062    public KMLCombineFiles(CompositeEntity container, String name)
063            throws IllegalActionException, NameDuplicationException {
064        super(container, name);
065        
066        input.setTypeEquals(new ArrayType(BaseType.STRING));
067        input.setMultiport(true);
068        
069        filename = new PortParameter(this, "filename");
070        filename.setTypeEquals(BaseType.STRING);
071        filename.getPort().setTypeEquals(BaseType.STRING);
072        filename.setStringMode(true);
073        new SingletonAttribute(filename.getPort(), "_showName");
074        filename.setToken("output.kmz");
075
076        output.setTypeEquals(BaseType.STRING);
077        
078    }
079    
080    @Override
081    public void fire() throws IllegalActionException {
082        
083        super.fire();
084        
085        filename.update();
086        String outputFileStr = ((StringToken)filename.getToken()).stringValue();
087        if(outputFileStr.trim().isEmpty()) {
088            throw new IllegalActionException(this, "Must specify output file name.");
089        }
090        
091        
092        List<Token> tokens = new LinkedList<Token>();
093        
094        for(int i = 0; i < input.getWidth(); i++) {
095            ArrayToken arrayToken = (ArrayToken)input.get(i);
096            tokens.addAll(Arrays.asList(arrayToken.arrayValue()));
097        }
098        
099        List<Kml> kmls = new ArrayList<Kml>();
100        Kml indexKml = new Kml();
101        Document indexDoc = indexKml.createAndSetDocument();
102        
103        for(Token token : tokens) {
104            String inputFileStr = ((StringToken)token).stringValue();
105            File file = new File(inputFileStr);
106            String fileName = file.getName();
107            
108            if(!file.exists()) {
109                System.out.println("WARNING: input does not exist: " + inputFileStr);
110                continue;
111            }
112                        
113            Kml kml = Kml.unmarshal(file);
114            
115            if(kml == null) {
116                System.err.println("WARNING: could not unmarshal KML: " + file);
117                continue;
118            }
119            
120            kmls.add(kml);
121            
122            final Feature feature = kml.getFeature();
123            
124            String name = feature.getName();
125            if(name == null) {
126                feature.setName(fileName);
127                name = fileName;
128            }
129            
130            String id = feature.getId();
131            if(id == null) {
132                feature.setId(name);
133            }
134            
135            NetworkLink networkLink = indexDoc.createAndAddNetworkLink();
136            networkLink.createAndSetLink().setHref(name);
137            networkLink.setName(name);
138        }
139        
140        try {
141            indexKml.marshalAsKmz(outputFileStr, kmls.toArray(new Kml[kmls.size()]));
142        } catch (IOException e) {
143            throw new IllegalActionException(this, e, "Error writing KMZ.");
144        }
145        
146        output.broadcast(new StringToken(outputFileStr));
147        
148    }
149    
150    /** The name of the output file. */
151    public PortParameter filename;
152}