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.lateralbuffer;

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

import org.gvsig.geoprocess.algorithm.buffer.BufferAlgorithm;

import org.gvsig.geoprocess.algorithm.buffer.BufferOperation;

import org.gvsig.geoprocess.algorithm.buffer.ConstantDistance;

import org.gvsig.geoprocess.algorithm.buffer.FieldDistance;

import org.gvsig.geoprocess.algorithm.buffer.IDistance;

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

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.gui.algorithm.GeoAlgorithmParametersPanel;

import es.unex.sextante.outputs.OutputVectorLayer;

/**

 * Lateral buffer algorithm

 * 

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

 */

public class LateralBufferAlgorithm extends BufferAlgorithm {

    public static final String LATERAL       = "LATERAL";

    public static final String IGNOREINVALIDLINES = "IGNORENOTVALIDLINES";

    public static final int    LEFT          = 0;

    public static final int    RIGHT         = 1;

    private int                lateral       = LEFT;

        public void defineCharacteristics() {

        setName(getTranslation("lateral_buffer"));

        setGroup(getTranslation("basic_vect_algorithms"));

        // setGeneratesUserDefinedRasterOutput(false);

        try {

            m_Parameters.addInputVectorLayer(LAYER, getTranslation("Input_layer"), 

                    IVectorLayer.SHAPE_TYPE_WRONG, true);

            m_Parameters.addBoolean(SELECTED_GEOM, getTranslation("Selected_geometries"), false);

            m_Parameters.addNumericalValue(DISTANCE, getTranslation("area_distance"), 0,

                AdditionalInfoNumericalValue.NUMERICAL_VALUE_DOUBLE);

            m_Parameters.addTableField(FIELD, getTranslation("area_field"), "LAYER");

            m_Parameters.addBoolean(DISSOLVE, getTranslation("Dissolve_entities"), false);

            m_Parameters.addSelection(RING_NUMBER, getTranslation("Number_of_rings"),

                new String[] { "1", "2", "3" });

            m_Parameters.addBoolean(ROUND_BORDER, getTranslation("Round_border"), true);

            m_Parameters.addBoolean(IGNOREINVALIDLINES, getTranslation("ignore_invalid_lines"), true);

            m_Parameters.addNumericalValue(LATERAL, getTranslation("select_lateral"), 0,

                    AdditionalInfoNumericalValue.NUMERICAL_VALUE_INTEGER);

        } catch (RepeatedParameterNameException e) {

            Sextante.addErrorToLog(e);

        } catch (UndefinedParentParameterNameException e) {

            Sextante.addErrorToLog(e);

        } catch (OptionalParentParameterException e) {

            Sextante.addErrorToLog(e);

        }

        addOutputVectorLayer(RESULT, getTranslation("lateral_buffer"),

            OutputVectorLayer.SHAPE_TYPE_POLYGON);

        }

        /*

         * (non-Javadoc)

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

         */

        public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

                if(existsOutPutFile(LateralBufferAlgorithm.RESULT, 0)) {

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

            }

                int attributePosition = m_Parameters.getParameterValueAsInt(FIELD);

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

                lateral = m_Parameters.getParameterValueAsInt(LATERAL); //0:left 1:right

                boolean ignoreInvalidLines = m_Parameters.getParameterValueAsBoolean(IGNOREINVALIDLINES);

                //Default inflArea BUFFER_OUTSIDE_POLY

                readParameters();

        if (sextanteInputLayer instanceof FlyrVectIVectorLayer)

                inputStore = ((FlyrVectIVectorLayer) sextanteInputLayer).getFeatureStore();

        else

            return false;

        try {

            // Object to compute the distance

            IDistance distance = null;

            if (distanceValue == 0)

                distance = new FieldDistance(attributePosition);

            else

                distance = new ConstantDistance(distanceValue);

            BufferOperation operation = new LateralBufferOperation(distance, inputStore, this, getTableFieldsStructure(), lateral, ignoreInvalidLines);

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

            operation.setNumberOfRadialBuffers(rings + 1);

            operation.setGeoProcess(this, 100);

                // Builds the output FeatureStore

            outputStore = buildOutPutStore(IVectorLayer.SHAPE_TYPE_POLYGON,

                                        getTranslation("lateral_buffer"), RESULT);

            if(!dissolve) {

                        computesBufferAlgWithoutDissolve(operation);

                } else {

                        computesBufferAlgWithDissolve(operation);

                }

        } catch (DataException e) {

            Sextante.addErrorToLog(e);

            return false;

        }

                return true;

        }

    @Override

    public Class<? extends GeoAlgorithmParametersPanel> getCustomParametersPanelClass() {

        return LateralBufferParametersPanel.class;

    }

}