Application: gvSIG desktop » gvSIG geoprocess

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2012 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 2

 * 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.geoprocess.algorithm.union;

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

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

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.geom.Geometry;

import org.gvsig.geoprocess.algorithm.base.core.GeometryOperation;

import org.gvsig.geoprocess.algorithm.base.core.ScalableUnionOperation;

import org.gvsig.geoprocess.algorithm.difference.DifferenceOperation;

import org.gvsig.geoprocess.algorithm.intersection.IntersectionOperation;

import org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess;

import org.gvsig.geoprocess.lib.sextante.dataObjects.FlyrVectIVectorLayer;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.dataObjects.IVectorLayer;

import es.unex.sextante.exceptions.GeoAlgorithmExecutionException;

import es.unex.sextante.exceptions.NullParameterValueException;

import es.unex.sextante.exceptions.RepeatedParameterNameException;

import es.unex.sextante.exceptions.WrongParameterIDException;

import es.unex.sextante.exceptions.WrongParameterTypeException;

import es.unex.sextante.outputs.OutputVectorLayer;

import org.gvsig.tools.namestranslator.NamesTranslator;

/**

 * Union algorithm

 *

 * @author <a href="mailto:nachobrodin@gmail.com">Nacho Brodin</a>

 */

public class UnionAlgorithm extends AbstractSextanteGeoProcess {

    public static final String RESULT1 = "RESULT1";

    public static final String RESULT2 = "RESULT2";

    public static final String LAYER1 = "LAYER1";

    public static final String LAYER2 = "LAYER2";

    public static final String SELECTGEOM_INPUT = "SELECTGEOM_INPUT";

    public static final String SELECTGEOM_OVERLAY = "SELECTGEOM_OVERLAY";

    private NamesTranslator nameTranslator;

    /*

         * (non-Javadoc)

         * @see es.unex.sextante.core.GeoAlgorithm#defineCharacteristics()

     */

    public void defineCharacteristics() {

        setName(getTranslation("Union"));

        setGroup(getTranslation("basic_vect_algorithms"));

        // setGeneratesUserDefinedRasterOutput(false);

        try {

            m_Parameters.addInputVectorLayer(LAYER1,

                    getTranslation("Input_layer") + " 1",

                    IVectorLayer.SHAPE_TYPE_WRONG,

                    true);

            m_Parameters.addInputVectorLayer(LAYER2,

                    getTranslation("Input_layer") + " 2",

                    IVectorLayer.SHAPE_TYPE_WRONG,

                    true);

            m_Parameters.addBoolean(SELECTGEOM_INPUT,

                    getTranslation("Selected_geometries_input_layer_union"), false);

            m_Parameters.addBoolean(SELECTGEOM_OVERLAY,

                    getTranslation("Selected_geometries_overlay_layer_union"), false);

        } catch (RepeatedParameterNameException e) {

            Sextante.addErrorToLog(e);

        }

        addOutputVectorLayer(RESULT1, getTranslation("Union_l1"),

                OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

        addOutputVectorLayer(RESULT2, getTranslation("Union_l2"),

                OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

    }

    /*

         * (non-Javadoc)

         * @see es.unex.sextante.core.GeoAlgorithm#processAlgorithm()

     */

    public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

        if (existsOutPutFile(UnionAlgorithm.RESULT1, 0)) {

            throw new GeoAlgorithmExecutionException(getTranslation("file_exists"));

        }

        if (existsOutPutFile(UnionAlgorithm.RESULT2, 0)) {

            throw new GeoAlgorithmExecutionException(getTranslation("file_exists"));

        }

        IVectorLayer layer1 = m_Parameters.getParameterValueAsVectorLayer(LAYER1);

        IVectorLayer layer2 = m_Parameters.getParameterValueAsVectorLayer(LAYER2);

        boolean selectedGeomInput = m_Parameters.getParameter(SELECTGEOM_INPUT).getParameterValueAsBoolean();

        boolean selectedGeomOverlay = m_Parameters.getParameter(SELECTGEOM_OVERLAY).getParameterValueAsBoolean();

        this.nameTranslator = NamesTranslator.createTrimTranslator(11);

        FeatureStore storeLayer1 = null;

        FeatureStore storeLayer2 = null;

        if (layer1 instanceof FlyrVectIVectorLayer

                && layer2 instanceof FlyrVectIVectorLayer) {

            storeLayer1 = ((FlyrVectIVectorLayer) layer1).getFeatureStore();

            storeLayer2 = ((FlyrVectIVectorLayer) layer2).getFeatureStore();

        } else {

            return false;

        }

        try {

            FeatureType featureType1 = storeLayer1.getDefaultFeatureType();

            FeatureSet features2 = null;

            features2 = storeLayer2.getFeatureSet();

            FeatureType featureType2 = features2.getDefaultFeatureType();

            FeatureStore featStoreOut1 = null;

            FeatureStore featStoreOut2 = null;

            //POL-POL

            if (isPolygon(storeLayer1) && isPolygon(storeLayer2)) {

                featStoreOut1 = buildOutPutStoreFromUnion(featureType1,

                        featureType2,

                        layer1.getShapeType(),

                        getTranslation("Union_polygon"),

                        RESULT1);

                computesUnion(storeLayer1, storeLayer2, featStoreOut1, selectedGeomInput, selectedGeomOverlay);

            } else //PTO-PTO

            if (isPoint(storeLayer1) && isPoint(storeLayer2)) {

                featStoreOut1 = buildOutPutStoreFromUnion(featureType1,

                        featureType2,

                        layer1.getShapeType(),

                        getTranslation("Union_point"),

                        RESULT1);

                computesUnion(storeLayer1, storeLayer2, featStoreOut1, selectedGeomInput, selectedGeomOverlay);

            } else //LIN-LIN        

            if (isLine(storeLayer1) && isLine(storeLayer2)) {

                featStoreOut1 = buildOutPutStoreFromUnion(featureType1,

                        featureType2,

                        IVectorLayer.SHAPE_TYPE_POINT,

                        getTranslation("Union_point"),

                        RESULT1);

                computesIntersection(storeLayer1, storeLayer2, featStoreOut1, selectedGeomInput, selectedGeomOverlay, true);

                featStoreOut2 = buildOutPutStoreFromUnion(featureType1,

                        featureType2,

                        IVectorLayer.SHAPE_TYPE_LINE,

                        getTranslation("Union_line"),

                        RESULT2);

                computesDifference(storeLayer1, storeLayer2, featStoreOut2, selectedGeomInput, selectedGeomOverlay, false);

                computesDifference(storeLayer2, storeLayer1, featStoreOut2, selectedGeomInput, selectedGeomOverlay, true);

            } else //POL-LIN

            if ((isPolygon(storeLayer1) && isLine(storeLayer2))

                    || (isLine(storeLayer1) && isPolygon(storeLayer2))) {

                featStoreOut1 = buildOutPutStoreFromUnion(featureType1,

                        featureType2,

                        IVectorLayer.SHAPE_TYPE_LINE,

                        getTranslation("Union_line"), RESULT1);

                computesUnion(storeLayer1, storeLayer2, featStoreOut1, selectedGeomInput, selectedGeomOverlay);

                featStoreOut2 = buildOutPutStoreFromUnion(featureType1,

                        featureType2,

                        IVectorLayer.SHAPE_TYPE_POLYGON,

                        getTranslation("Union_polygon"),

                        RESULT2);

                computesDifference(storeLayer1, storeLayer2, featStoreOut2, selectedGeomInput, selectedGeomOverlay, false);

                computesDifference(storeLayer2, storeLayer1, featStoreOut2, selectedGeomInput, selectedGeomOverlay, true);

            } else //POL-PTO

            if ((isPolygon(storeLayer1) && isPoint(storeLayer2))

                    || (isPoint(storeLayer1) && isPolygon(storeLayer2))) {

                featStoreOut1 = buildOutPutStoreFromUnion(featureType1, featureType2, IVectorLayer.SHAPE_TYPE_POINT,

                        getTranslation("Union_point"), RESULT1);

                computesUnion(storeLayer1, storeLayer2, featStoreOut1, selectedGeomInput, selectedGeomOverlay);

                featStoreOut2 = buildOutPutStoreFromUnion(featureType1, featureType2, IVectorLayer.SHAPE_TYPE_MULTIPOLYGON,

                        getTranslation("Union_polygon"), RESULT2);

                computesUnion(storeLayer1, storeLayer2, featStoreOut2, selectedGeomInput, selectedGeomOverlay);

            } else //PTO-LIN

            if ((isPoint(storeLayer1) && isLine(storeLayer2))

                    || (isLine(storeLayer1) && isPoint(storeLayer2))) {

                featStoreOut1 = buildOutPutStoreFromUnion(featureType1, featureType2, IVectorLayer.SHAPE_TYPE_POINT,

                        getTranslation("Union_point"), RESULT1);

                computesUnion(storeLayer1, storeLayer2, featStoreOut1, selectedGeomInput, selectedGeomOverlay);

                featStoreOut2 = buildOutPutStoreFromUnion(featureType1, featureType2, IVectorLayer.SHAPE_TYPE_MULTILINE,

                        getTranslation("Union_line"), RESULT2);

                computesUnion(storeLayer1, storeLayer2, featStoreOut2, selectedGeomInput, selectedGeomOverlay);

            }

            if (featStoreOut2 == null) {

                featStoreOut2 = buildOutPutStoreFromUnion(featureType1, featureType2, IVectorLayer.SHAPE_TYPE_WRONG,

                        getTranslation("Null_Layer"), RESULT2);

            }

        } catch (ReadException e) {

            throw new GeoAlgorithmExecutionException(e.getMessage());

        } catch (DataException e) {

            throw new GeoAlgorithmExecutionException(e.getMessage());

        }

        if (getTaskMonitor().isCanceled()) {

            return false;

        }

        return true;

    }

    /**

     * Computes union

     *

     * @param storeLayer1

     * @param storeLayer2

     * @param featStoreOut

     * @param selectedGeom

     * @throws DataException

     * @throws WrongParameterTypeException

     * @throws WrongParameterIDException

     * @throws NullParameterValueException

     */

    private void computesUnion(FeatureStore storeLayer1, FeatureStore storeLayer2,

            FeatureStore featStoreOut, boolean selectedGeomInput, boolean selectGeomOverlay) throws DataException, WrongParameterTypeException, WrongParameterIDException, NullParameterValueException {

        computesIntersection(storeLayer1, storeLayer2, featStoreOut, selectedGeomInput, selectGeomOverlay, false);

        computesDifference(storeLayer1, storeLayer2, featStoreOut, selectedGeomInput, selectGeomOverlay, false);

        computesDifference(storeLayer2, storeLayer1, featStoreOut, selectedGeomInput, selectGeomOverlay, true);

    }

    /**

     * Computes intersection

     *

     * @param storeLayer1

     * @param storeLayer2

     * @param featStoreOut

     * @param selectedGeom

     * @param close

     * @throws DataException

     * @throws WrongParameterTypeException

     * @throws WrongParameterIDException

     * @throws NullParameterValueException

     */

    private void computesIntersection(FeatureStore storeLayer1, FeatureStore storeLayer2,

            FeatureStore featStoreOut, boolean selectedGeomInput, boolean selectGeomOverlay, boolean close) throws DataException, WrongParameterTypeException, WrongParameterIDException, NullParameterValueException {

        GeometryOperation intersection = new IntersectionOperation(storeLayer2, this);

        intersection.setTaskStatus(getStatus());

        intersection.computesGeometryOperation(storeLayer1, featStoreOut, attrNames,

                selectedGeomInput, selectGeomOverlay, close);

    }

    /**

     * Computes difference

     *

     * @param storeLayer1

     * @param storeLayer2

     * @param featStoreOut

     * @param selectedGeom

     * @param close

     * @throws DataException

     * @throws WrongParameterTypeException

     * @throws WrongParameterIDException

     * @throws NullParameterValueException

     */

    private void computesDifference(FeatureStore storeLayer1, FeatureStore storeLayer2,

            FeatureStore featStoreOut, boolean selectedGeomInput, boolean selectGeomOverlay, boolean close) throws DataException, WrongParameterTypeException, WrongParameterIDException, NullParameterValueException {

        Geometry unionGeom1 = ScalableUnionOperation.joinLayerGeometries(storeLayer2, selectGeomOverlay);

        GeometryOperation differenceL1_L2 = new DifferenceOperation(unionGeom1, this);

        differenceL1_L2.setTaskStatus(getStatus());

        differenceL1_L2.computesGeometryOperation(storeLayer1, featStoreOut, attrNames,

                selectedGeomInput, selectGeomOverlay, close);

    }

}