Application: gvSIG desktop » gvSIG geoprocess

/*

 * gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2010 Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 */

package org.gvsig.sextante.app.algorithm.buffer;

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

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

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

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

import org.gvsig.sextante.app.algorithm.base.panel.AlgorithmOutputPanel;

import org.gvsig.sextante.app.extension.core.gvGeoAlgorithm;

import org.gvsig.sextante.app.extension.core.gvVectorLayer;

import es.unex.sextante.additionalInfo.AdditionalInfoNumericalValue;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.dataObjects.IVectorLayer;

import es.unex.sextante.exceptions.GeoAlgorithmExecutionException;

import es.unex.sextante.exceptions.OptionalParentParameterException;

import es.unex.sextante.exceptions.RepeatedParameterNameException;

import es.unex.sextante.exceptions.UndefinedParentParameterNameException;

import es.unex.sextante.outputs.OutputVectorLayer;

/**

 * Geoprocess that computes a buffer area around each feature's geometry of the

 * input layer. <br>

 * All the points interior to this buffer area has to be at a distance inferior

 * to "buffer distance" to the original geometry. This buffer distance could be

 * constant, or it could be a function of the value of a feature attribute.<br>

 * 

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

 */

public class BufferAlgorithm extends gvGeoAlgorithm {

        public static final String  RESULT            = "RESULT";

        public static final String  LAYER             = "LAYER";

        public static final String  SELECTED_GEOM     = "SELECTED_GEOM";

        public static final String  DISTANCE          = "DISTANCE";

        public static final String  FIELD             = "FIELD";

        public static final String  DISSOLVE          = "DISSOLVE";

        public static final String  ROUND_BORDER      = "ROUND_BORDER";

        public static final String  AREA              = "AREA";

        public static final String  RING_NUMBER       = "RING_NUMBER";

        /*

         * (non-Javadoc)

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

         */

        public void defineCharacteristics(){

                setName(Sextante.getText( "Buffer"));

                setGroup(Sextante.getText( "gvSIG_Algorithms"));

                setGeneratesUserDefinedRasterOutput(false);

                String [] sOptions = {Sextante.getText( "Out"),

                                                                Sextante.getText( "In"),

                                                                Sextante.getText( "InAndOut")};

                try {

                        m_Parameters.addInputVectorLayer(LAYER, 

                                                                                                Sextante.getText( "Input_layer"), 

                                                                                                IVectorLayer.SHAPE_TYPE_WRONG, 

                                                                                                true);

                        m_Parameters.addBoolean(SELECTED_GEOM, Sextante.getText("Selected_geometries"), false);

                        m_Parameters.addNumericalValue(DISTANCE, Sextante.getText("Distance"), 0, AdditionalInfoNumericalValue.NUMERICAL_VALUE_DOUBLE);

                        m_Parameters.addTableField(FIELD, Sextante.getText("Field"), "LAYER");

                        m_Parameters.addBoolean(DISSOLVE, Sextante.getText("Dissolve_entities"), false);

                        m_Parameters.addBoolean(ROUND_BORDER, Sextante.getText("Round_border"), true);

                        m_Parameters.addSelection(AREA, Sextante.getText("Builds_influence_area"), sOptions);

                        m_Parameters.addSelection(RING_NUMBER, Sextante.getText("Number_of_rings"), new String[]{"1", "2", "3"});

                        setExternalParameters((Object)new AlgorithmOutputPanel());

                } catch (RepeatedParameterNameException e) {

                        Sextante.addErrorToLog(e);

                } catch (UndefinedParentParameterNameException e) {

                        Sextante.addErrorToLog(e);

                } catch (OptionalParentParameterException e) {

                        Sextante.addErrorToLog(e);

                }

                addOutputVectorLayer(RESULT,

                                                                Sextante.getText( "Difference"),

                                                                OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

        }

        /*

         * (non-Javadoc)

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

         */

        public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

                IVectorLayer layer = m_Parameters.getParameterValueAsVectorLayer(LAYER);

                boolean selectedGeom = m_Parameters.getParameter(SELECTED_GEOM).getParameterValueAsBoolean();

                double dist = m_Parameters.getParameter(DISTANCE).getParameterValueAsDouble();

                int attributePosition = m_Parameters.getParameterValueAsInt(FIELD);

                boolean dissolve = m_Parameters.getParameter(DISSOLVE).getParameterValueAsBoolean();

                boolean round_border = m_Parameters.getParameter(ROUND_BORDER).getParameterValueAsBoolean();

                int inflArea = m_Parameters.getParameterValueAsInt(AREA);

                int rings = m_Parameters.getParameterValueAsInt(RING_NUMBER);

                FeatureStore storeLayer = null;

                if(layer instanceof gvVectorLayer)

                        storeLayer = ((gvVectorLayer)layer).getFeatureStore();

                else

                        return false;

                try {

                        FeatureSet features = null;

                        features = storeLayer.getFeatureSet();

                        FeatureType featureType = features.getDefaultFeatureType();

                        //Object to compute the distance

                        IDistance distance = null;

                        if(dist == 0)

                                distance = new FieldDistance(attributePosition);

                        else 

                                distance = new ConstantDistance();

                        //Object to compute the buffer operation

                        BufferOperation operation = null;

                        switch (inflArea) {

                        case 0:

                                operation = new OutBufferOperation(distance, layer, dist);

                                break;

                        case 1:

                                operation = new InBufferOperation(distance, layer, dist);

                                break;

                        case 2:

                                operation = new InOutBufferOperation(distance, layer, dist);

                                break;

                        }

                        operation.setTypeOfCap(round_border ? BufferOperation.CAP_ROUND : BufferOperation.CAP_SQUARE);

                        operation.setNumberOfRadialBuffers(rings + 1);

                        //Builds the output FeatureStore

                        FeatureStore outFeatStore = buildOutPutStore(featureType, org.gvsig.fmap.geom.Geometry.TYPES.SURFACE, Sextante.getText("Buffer"), RESULT);

                        //Computes the operation

                        operation.computesGeometryOperation(storeLayer, outFeatStore, attrNames, selectedGeom, true);

                } catch (DataException e) {

                        Sextante.addErrorToLog(e);

                        return false;

                }

                if(dissolve) {

                        //TODO: Dissolve operation

                }

                return true;

        }

}