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

import java.util.ArrayList;

import java.util.HashMap;

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

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.geoprocess.lib.sextante.AbstractSextanteGeoProcess;

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

import es.unex.sextante.exceptions.UnsupportedOutputChannelException;

import es.unex.sextante.gui.algorithm.GeoAlgorithmParametersPanel;

import es.unex.sextante.outputs.OutputVectorLayer;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.tools.namestranslator.NamesTranslator;

/**

 * Dissolve algorithm

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

 */

public class DissolveAlgorithm extends AbstractSextanteGeoProcess {

        public static final String        RESULT            = "RESULT";

        public static final String        LAYER             = "LAYER";

        public static final String        FIELD             = "FIELD";

        public static final String        FUNCTIONS         = "FUNCTIONS";

        public static final String        SELECTED_GEOM     = "SELECTED_GEOM";

        public static final String        DISSOLV_ADJ       = "DISSOLV_ADJ";

        public static final String        FUNCTION_LIST     = "FUNCTION_LIST";

        public static final String        Summary[]         = {"Min", "Max", "Sum", "Avg"};

        private boolean                   funcList[]        = new boolean[Summary.length];

        private HashMap<String, String>   funcMap           = new HashMap<String, String>();

    /*

         * (non-Javadoc)

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

     */

        public void defineCharacteristics(){

        setName(getTranslation("Dissolve"));

        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.addBoolean(DISSOLV_ADJ, getTranslation("Selected_geometries"), false);

            m_Parameters.addNumericalValue(FIELD, getTranslation("Field"), 0, AdditionalInfoNumericalValue.NUMERICAL_VALUE_INTEGER);

            m_Parameters.addString(FUNCTION_LIST, getTranslation("Function_list"));

            addOutputVectorLayer(RESULT, getTranslation("Dissolve"), OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

        } catch (RepeatedParameterNameException e) {

            Sextante.addErrorToLog(e);

        }

        //setExternalParameters(new DissolveParametersPanel());

    }

    /*

         * (non-Javadoc)

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

     */

    public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

        //long t1 = System.currentTimeMillis();

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

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

        }

        IVectorLayer layer = m_Parameters.getParameterValueAsVectorLayer(LAYER);

        int indexField = m_Parameters.getParameterValueAsInt(FIELD);

        boolean selectedGeom = m_Parameters.getParameterValueAsBoolean(SELECTED_GEOM);

        boolean dissolvAdj = m_Parameters.getParameterValueAsBoolean(DISSOLV_ADJ);

        String functionList = m_Parameters.getParameterValueAsString(FUNCTION_LIST);

        loadSummary(functionList);

        FeatureStore storeLayer = null;

                if(layer instanceof FlyrVectIVectorLayer)

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

                else

            return false;

        FeatureSet features = null;

        FeatureType featureType = null;

        try {

            features = storeLayer.getFeatureSet();

            featureType = features.getDefaultFeatureType();

        } catch (DataException e) {

            Sextante.addErrorToLog(e);

            return false;

        }

        int layerType = layer.getShapeType();

        switch (layerType) {

            case IVectorLayer.SHAPE_TYPE_POINT:

                layerType = IVectorLayer.SHAPE_TYPE_MULTIPOINT;

                break;

            case IVectorLayer.SHAPE_TYPE_LINE:

                layerType = IVectorLayer.SHAPE_TYPE_MULTILINE;

                break;

            case IVectorLayer.SHAPE_TYPE_POLYGON:

                layerType = IVectorLayer.SHAPE_TYPE_MULTIPOLYGON;

                break;

            default:

                break;

        }

        FeatureStore outFeatStore = buildDissolvedOutPutStore(featureType, layer.getFieldName(indexField),

                        layerType, getTranslation("Dissolve"), RESULT);

        IDissolveRule criteria = null;

        if (dissolvAdj) {

            criteria = new AdjacencyDissolveRule(layer.getFieldName(indexField), funcMap);

        } else {

            criteria = new DissolveRule(layer.getFieldName(indexField), funcMap);

        }

        try {

            DissolveOperationFast operation = new DissolveOperationFast(criteria, this);

            operation.setTaskStatus(getStatus());

            operation.computesGeometryOperation(storeLayer, outFeatStore, attrNames,

                    selectedGeom, false, true);

        } catch (DataException e) {

            Sextante.addErrorToLog(e);

            return false;

        }

        //long t2 = System.currentTimeMillis();

        //System.out.println(t2 - t1);

                if(getTaskMonitor().isCanceled())

            return false;

        return true;

    }

    /**

     * Checks if the parameter is in Summary list

     * @param it

     * @return the position in the list

     */

    private int isInList(String it) {

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

                        if(Summary[i].compareTo(it) == 0)

                return i;

            }

        return -1;

    }

    /**

     * Loads the list of functions to use

     * @param functionList

     */

    private void loadSummary(String functionList) {

        String[] attrList = functionList.split(";");

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

            String[] func = attrList[i].split(",");

            for (int j = 1; j < func.length; j++) {

                int pos = isInList(func[j]);

                                if(pos != -1) {

                    funcList[pos] = true;

                    funcMap.put(Summary[pos], func[0]);

                }

            }

        }

    }

    /**

     * Builds the output FeatureStore

     * @param featureType

     * @return FeatureStore

     */

    @SuppressWarnings("unchecked")

    protected FeatureStore buildDissolvedOutPutStore(FeatureType featureType1,

            String fieldField,

            int shapeType,

            String sextanteLayerName,

            String sextanteLayerLabel) {

        ArrayList<Class> typesList = new ArrayList<Class>();

        ArrayList<String> attr = new ArrayList<String>();

        attr.add("FID");

        typesList.add(Integer.class);

        FeatureAttributeDescriptor desc = featureType1.getAttributeDescriptor(fieldField);

        attr.add(desc.getName());

        typesList.add(desc.getObjectClass());

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

                        if(funcList[i]) {

                String fieldName = funcMap.get(Summary[i]);

                                if(fieldName.length() >= 6)

                    fieldName = fieldName.substring(0, 5);

                attr.add(fieldName + "_" + Summary[i]);

                typesList.add(Double.class);

            }

        attrNames = new String[attr.size()];

        attr.toArray(attrNames);

        Class[] types = new Class[typesList.size()];

        typesList.toArray(types);

        try {

            IVectorLayer output = getNewVectorLayer(sextanteLayerLabel,

                    sextanteLayerName,

                    shapeType, types, attrNames);

                        return ((FlyrVectIVectorLayer)output).getFeatureStore();

        } catch (UnsupportedOutputChannelException e) {

            Sextante.addErrorToLog(e);

        } catch (GeoAlgorithmExecutionException e) {

            Sextante.addErrorToLog(e);

        }

        return null;

    }

    @Override

    public Class<? extends GeoAlgorithmParametersPanel> getCustomParametersPanelClass() {

        return DissolveParametersPanel.class;

    }

}