Application: gvSIG desktop » gvSIG data provider for GPE

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * 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 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.gpe.exportto.kml;

import java.awt.geom.Rectangle2D;

import java.io.File;

import java.io.FileOutputStream;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import org.cresques.cts.ICoordTrans;

import org.cresques.cts.IProjection;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.exportto.ExporttoService;

import org.gvsig.exportto.ExporttoServiceException;

import org.gvsig.exportto.ExporttoServiceFinishAction;

import org.gvsig.exportto.swing.prov.file.AbstractExporttoFileService;

import org.gvsig.fmap.crs.CRSFactory;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.exception.ProviderNotRegisteredException;

import org.gvsig.fmap.dal.exception.ValidateDataParametersException;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.FeatureSet;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.feature.FeatureType;

import org.gvsig.fmap.dal.feature.NewFeatureStoreParameters;

import org.gvsig.fmap.dal.spi.DataManagerProviderServices;

import org.gvsig.fmap.geom.DataTypes;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.geom.exception.CreateEnvelopeException;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.fmap.mapcontext.MapContextException;

import org.gvsig.fmap.mapcontext.layers.vectorial.FLyrVect;

import org.gvsig.fmap.mapcontext.rendering.legend.ILegend;

import org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.gpe.exportto.generic.util.CoordinatesSequenceBbox;

import org.gvsig.gpe.exportto.generic.util.GeometryToGPEWriter;

import org.gvsig.gpe.exportto.kml.style.KmlStyle;

import org.gvsig.gpe.exportto.kml.style.StyleUtils;

import org.gvsig.gpe.lib.api.GPELocator;

import org.gvsig.gpe.lib.api.writer.IGPEWriterHandler;

import org.gvsig.gpe.lib.api.writer.IGPEWriterHandlerImplementor;

import org.gvsig.gpe.prov.kml.utils.Kml2_1_Tags;

import org.gvsig.gpe.prov.kml.writer.GPEKmlWriterHandlerImplementor;

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.task.AbstractMonitorableTask;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.xmlpull.lib.api.stream.IXmlStreamWriter;

/**

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public class ExporttoKMLService extends AbstractMonitorableTask implements

    ExporttoService {

    private static Logger logger = LoggerFactory.getLogger(ExporttoKMLService.class);

    private FeatureStore featureStore = null;

    private FLyrVect vectorLayer = null;

    private List<ICoordTrans> transfList = new ArrayList<ICoordTrans>();

    private String mimeType = null;

    private File outFile = null;

    private boolean useLabels = false;

    private boolean attsAsBalloon = false;

    private boolean reprojectTo4326 = false;

    private IProjection targetproj = null;

    private NewFeatureStoreParameters newFeatureStoreParameters;

    private ExporttoServiceFinishAction exporttoServiceFinishAction;

    public ExporttoKMLService(

        File kmlFile,

        FeatureStore fstore,

        FLyrVect vlayer,

        String mtype,

        boolean doLabels,

        boolean balloon,

        boolean reproject4326) {

        super("Export to KML");

        outFile = kmlFile;

        featureStore = fstore;

        vectorLayer = vlayer;

        mimeType = mtype;

        useLabels = doLabels;

        attsAsBalloon = balloon;

        reprojectTo4326 = reproject4326;

        ICoordTrans ct = vlayer.getCoordTrans(); 

        if (reprojectTo4326) {

            targetproj = CRSFactory.getCRS("EPSG:4326");

            if (ct == null) {

                transfList.add(vlayer.getProjection().getCT(targetproj));

            } else {

                transfList.add(ct);

                transfList.add(ct.getPDest().getCT(targetproj));

            }

        } else {

            if (ct == null) {

                targetproj = vectorLayer.getProjection();

            } else {

                targetproj = ct.getPDest();

                transfList.add(ct);

            }

        }

    }

    public NewFeatureStoreParameters getNewFeatureStoreParameters() {

        return newFeatureStoreParameters;

    }

    public void addParameters(

        NewFeatureStoreParameters newFeatureStoreParameters) {

        newFeatureStoreParameters.setDynValue("CRS", targetproj);

    }

    public String getFileExtension() {

        return "kml";

    }

    public void export(FeatureSet featureSet) throws ExporttoServiceException {

        IGPEWriterHandler wh = null;

        FileOutputStream fos = null;

        String srs = targetproj.getAbrev();

        String[] fldNames = null;

        Envelope env = null;

        long count = 0;

        try {

            count = featureSet.getSize();

            this.taskStatus.setRangeOfValues(0, count);

            fldNames = getAttributes(featureStore.getDefaultFeatureType());

            env = this.featureStore.getEnvelope();

        } catch (DataException e) {

            throw new ExporttoServiceException(e);

        }

        try {

            env = reproject(env);

        } catch (CreateEnvelopeException cee) {

            throw new ExporttoServiceException(cee);

        }

        Rectangle2D rect = new Rectangle2D.Double(

            env.getMinimum(0),

            env.getMinimum(1),

            env.getLength(0),

            env.getLength(1));

        File fixedFile = outFile;

        try {

            if (!outFile.getAbsolutePath().toLowerCase().endsWith(

                "." + this.getFileExtension().toLowerCase())) {

                fixedFile = new File(outFile.getAbsolutePath() + "." + getFileExtension());

            }

            wh = GPELocator.getGPEManager().createWriterByMimeType(mimeType);

            fos = new FileOutputStream(fixedFile);

            wh.setOutputStream(fos);

            wh.initialize();

            // ==========================================

            wh.startLayer(null, null, fixedFile.getName(), null, srs);

            // ==============     Styles    =============

            Map<ISymbol, KmlStyle> symsty = null;

            IXmlStreamWriter xmlw = getXmlStreamWriter(wh);

            if (true && xmlw != null) {

                symsty = StyleUtils.getSymbolStyles(

                    vectorLayer,

                    featureSet,

                    attsAsBalloon,

                    fldNames);

                Iterator<KmlStyle> iter = symsty.values().iterator();

                KmlStyle sty = null;

                while (iter.hasNext()) {

                    sty = iter.next();

                    writeStyle(xmlw, sty);

                }

            }

            // ==========================================

            wh.startBbox(null, new CoordinatesSequenceBbox(rect), srs);

            wh.endBbox();

            // ============= Writing feature ============

            writeFeatures(wh, xmlw, featureSet, fldNames, symsty,

                (IVectorLegend) vectorLayer.getLegend());

            // ==========================================

            wh.endLayer();

            // ==========================================

            wh.close();

            fos.close();

        } catch (Exception exc) {

            throw new ExporttoServiceException(exc);

        }

        this.taskStatus.setCurValue(count);

        this.taskStatus.terminate();

        this.finishAction(fixedFile, this.targetproj);

    }

    private Envelope reproject(Envelope env) throws CreateEnvelopeException {

        int sz = transfList.size(); 

        if (sz == 0) {

            return env;

        } else {

            Envelope resp = env;

            try {

                for (int i=0; i<sz; i++) {

                    resp = resp.convert(transfList.get(i));

                }

            } catch (Exception exc) {

                // If this process fails, we'll use "emergency values":

                GeometryManager gm = GeometryLocator.getGeometryManager();

                double[] min = new double[2];

                double[] max = new double[2];

                if (targetproj.isProjected()) {

                    min = new double[]{-20000000, -20000000};

                    max = new double[]{ 20000000,  20000000};

                } else {

                    min = new double[]{-180, -90};

                    max = new double[]{ 180,  90};

                }

                resp = gm.createEnvelope(

                    min[0], min[1],

                    max[0], max[1],

                    Geometry.SUBTYPES.GEOM2D);

            }

            return resp;

        }

    }

    private void writeStyle(IXmlStreamWriter xmlw, KmlStyle sty) throws IOException {

        xmlw.writeStartElement(Kml2_1_Tags.STYLE);

        xmlw.writeStartAttribute(Kml2_1_Tags.ID);

        xmlw.writeValue(sty.getId());           

        xmlw.writeEndAttributes();    

        sty.writeXml(xmlw);

        xmlw.writeEndElement();        

    }

    private IXmlStreamWriter getXmlStreamWriter(IGPEWriterHandler wh) {

        IGPEWriterHandlerImplementor imple = wh.getImplementor();

        if (!(imple instanceof GPEKmlWriterHandlerImplementor)) {

            /*

             * Unexpected class

             */

            return null;

        }

        GPEKmlWriterHandlerImplementor kmlimple = null;

        kmlimple = (GPEKmlWriterHandlerImplementor) imple;

        IXmlStreamWriter xmlw = kmlimple.getXMLStreamWriter();   

        return xmlw;

    }

    private void finishAction(File kmlfile, IProjection proj)

    throws ExporttoServiceException {

        if (exporttoServiceFinishAction != null) {

            /*

             * Export is done. We notify with a SHPStoreParameters,

             * not with the NewSHPParameters we have used:

             */

            DataManagerProviderServices dataman =

                (DataManagerProviderServices) DALLocator.getDataManager();

            DataStoreParameters dsp = null;

            try {

                dsp = dataman.createStoreParameters("GPE");

            } catch (Exception e) {

                throw new ExporttoServiceException(

                    "Cannot add resulting kml file to view", e);

            }

            dsp.setDynValue("File", kmlfile);

            dsp.setDynValue("CRS", proj);

            try {

                dsp.validate();

            } catch (ValidateDataParametersException e) {

                throw new ExporttoServiceException(e);

            }

            exporttoServiceFinishAction.finished(kmlfile.getName(), dsp);

        }

    }    

    private String[] getAttributes(FeatureType ftype) {

        FeatureAttributeDescriptor[] atts =  ftype.getAttributeDescriptors();

        FeatureAttributeDescriptor desc = null;

        List<String> list = new ArrayList<String>();

        for (int i=0; i<atts.length; i++) {

            desc = atts[i];

            if (desc.getDataType().getType() != DataTypes.GEOMETRY) {

                list.add(desc.getName());

            }

        }

        return list.toArray(new String[0]);

    }

    private void writeFeatures(

        IGPEWriterHandler gwh,

        IXmlStreamWriter xmlw,

        FeatureSet fset,

        String[] fieldNames,

        Map<ISymbol, KmlStyle> symsty,

        IVectorLegend lege) throws Exception {

        GeometryToGPEWriter gw = new GeometryToGPEWriter(gwh);

        DisposableIterator diter = fset.fastIterator();

        Feature feat = null;

        long count = 0;

        this.taskStatus.setCurValue(count);

        ISymbol sym = null;

        while (diter.hasNext()) {

            feat = (Feature) diter.next();

            try {

                sym = lege.getSymbolByFeature(feat);

            } catch (MapContextException mce) {

                logger.info("While getting legend symbol.", mce);

            }

            writeFeature(feat, gwh, xmlw, gw, count, fieldNames, symsty.get(sym));

            count++;

            this.taskStatus.setCurValue(count);

        }

        diter.dispose();

    }

    private void writeFeature(

        Feature feat,

        IGPEWriterHandler gwh,

        IXmlStreamWriter xmlw,

        GeometryToGPEWriter gw,

        long index,

        String[] fieldNames,

        KmlStyle ksty) throws IOException {

        String strindex = String.valueOf(index); 

        if (this.useLabels) {

            String lbl = getLabelForFeature(feat);

            gwh.startFeature(strindex, "FEATURE", lbl);

        } else {

            gwh.startFeature(strindex, "FEATURE", "");

        }

        // =========================

        // Style

        if (ksty != null) {

            xmlw.writeStartElement(Kml2_1_Tags.STYLEURL);

            xmlw.writeValue("#" + ksty.getId());           

            xmlw.writeEndElement();     

        }

        // ===== Balloon ============

        if (this.attsAsBalloon) {

            writeBalloon(xmlw, feat, fieldNames);

        }

        // ============= Geometry

        Geometry geom = feat.getDefaultGeometry();

        /*

         * This has no effect if reprojection is not necessary

         */

        geom = reproject(geom);

        gw.writeGeometry(geom, useLabels);

        // ============= Attributes

        Object val = null;

        String fldname = null;

        for (int i=0; i<fieldNames.length; i++) {

            val = feat.get(fieldNames[i]);

            fldname = fieldNames[i].replace(' ', '_');

            gwh.startElement("", fldname, val == null ? "" : val.toString());

            gwh.endElement();

        }

        // =========================

        gwh.endFeature();

    }

    private void writeBalloon(IXmlStreamWriter xmlw, Feature feat, String[] fieldNames)

    throws IOException {

        xmlw.writeStartElement(Kml2_1_Tags.EXTENDED_DATA);

        String fldrep = null;

        Object val = null;

        for (int i=0; i<fieldNames.length; i++) {

            fldrep = fieldNames[i].replace(' ', '_');

            xmlw.writeStartElement(Kml2_1_Tags.DATA);

            // Att =====================================================

            xmlw.writeStartAttribute(null, "name");

            xmlw.writeValue(fldrep);

            xmlw.writeEndAttributes();

            // Value =====================================================

            xmlw.writeStartElement(Kml2_1_Tags.VALUE);

            val = feat.get(fieldNames[i]);

            xmlw.writeValue(val == null ? "" : val.toString());

            xmlw.writeEndElement();

            // =============================================

            xmlw.writeEndElement();

        }

        xmlw.writeEndElement();

        /*

         *

<ExtendedData>

      <Data name="holeNumber">

        <value>1</value>

      </Data>

      <Data name="holeYardage">

        <value>234</value>

      </Data>

      <Data name="holePar">

        <value>4</value>

      </Data>

    </ExtendedData>

         * 

         */

    }

    private String getLabelForFeature(Feature feat) {

        if (this.vectorLayer.isLabeled()) {

            String[] flds = vectorLayer.getLabelingStrategy().getUsedFields();

            int n = Math.min(flds.length, 2);

            if (n == 0) {

                return "";

            } else {

                String resp = "";

                Object val = null; 

                if (n == 1) {

                    val = feat.get(flds[0]);

                    resp = (val == null) ? "" : val.toString();

                } else {

                    // n == 2

                    val = feat.get(flds[0]);

                    resp = (val == null) ? "" : val.toString();

                    val = feat.get(flds[1]);

                    resp = (val == null) ? resp : resp + ", " + val.toString();

                }

                return resp;

            }

        } else {

            return "";

        }

    }

    public void setFinishAction(

        ExporttoServiceFinishAction exporttoServiceFinishAction) {

        this.exporttoServiceFinishAction = exporttoServiceFinishAction;

    }

    private Geometry reproject(Geometry geom) {

        int sz = transfList.size(); 

        if (sz == 0) {

            return geom;

        } else {

            Geometry resp = geom.cloneGeometry();

            for (int i=0; i<sz; i++) {

                resp.reProject(transfList.get(i));

            }

            return resp;

        }

    }

}