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

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataTypes;

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

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

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

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

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

import org.gvsig.geoprocess.algorithm.dissolve.DissolveRule;

import org.gvsig.geoprocess.algorithm.dissolve.IDissolveRule;

import org.gvsig.geoprocess.algorithm.dissolve.Summary;

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

import es.unex.sextante.exceptions.UnsupportedOutputChannelException;

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

import es.unex.sextante.outputs.OutputVectorLayer;

/**

 * Spatial join algorithm

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

 */

public class SpatialJoinAlgorithm extends AbstractSextanteGeoProcess {

        public static final String        NEW_FIELD             = "NUM_RELA";

        public static final String        RESULT                = "RESULT";

        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";

        public static final String        NEAREST               = "NEAREST";

        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("Spatialjoin"));

        setGroup(getTranslation("basic_vect_algorithms"));

        // setGeneratesUserDefinedRasterOutput(false);

                try {

                        m_Parameters.addInputVectorLayer(LAYER1, 

                getTranslation("Input_layer"),

                                                                                                IVectorLayer.SHAPE_TYPE_WRONG, 

                                                                                                true);

                        m_Parameters.addInputVectorLayer(LAYER2, 

                getTranslation("Input_layer"),

                                                                                                IVectorLayer.SHAPE_TYPE_WRONG, 

                                                                                                true);

            m_Parameters.addBoolean(SELECTGEOM_INPUT, 

                            getTranslation("Selected_geometries_input_layer"), false);

            m_Parameters.addBoolean(SELECTGEOM_OVERLAY, 

                            getTranslation("Selected_geometries_overlay_layer"), false);

            m_Parameters.addBoolean(NEAREST, getTranslation("use_the_nearest"), false);

            m_Parameters.addString(FUNCTION_LIST,

                getTranslation("Function_list"));

                } catch (RepeatedParameterNameException e) {

                        Sextante.addErrorToLog(e);

                }

                addOutputVectorLayer(RESULT,getTranslation("Spatialjoin"),

                                                                OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

        }

        /*

         * (non-Javadoc)

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

         */

        public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

                if(existsOutPutFile(SpatialJoinAlgorithm.RESULT, 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();

                boolean nearest = m_Parameters.getParameterValueAsBoolean(NEAREST);

                String functionList = m_Parameters.getParameterValueAsString(FUNCTION_LIST);

                loadSummary(functionList);

                FlyrVectIVectorLayer lyr1 = null;

                FlyrVectIVectorLayer lyr2 = null;

                if(layer2 instanceof FlyrVectIVectorLayer && layer1 instanceof FlyrVectIVectorLayer) { 

                        lyr2 = ((FlyrVectIVectorLayer)layer2);

                        lyr1 = ((FlyrVectIVectorLayer)layer1);

                } else 

                        return false;

                DataManager dataManager = DALLocator.getDataManager();

                //Builds a new JSIRTree index. To do that we have to replace the default index and 

                //when the operation has finished then it restores the original default index 

                String indexName = "GEOMETRY";

                try {

                        indexName = lyr2.getFeatureStore().getDefaultFeatureType().getDefaultGeometryAttributeName();

                        FeatureAttributeDescriptor fat = lyr2.getFeatureStore().getDefaultFeatureType().getAttributeDescriptor(indexName);

                        String defaultIndex = dataManager.getDefaultFeatureIndexProviderName(

                                        fat.getDataType().getType());

                        dataManager.setDefaultFeatureIndexProviderName(

                                        fat.getDataType().getType(), "JSIRTree");

                        lyr2.getFeatureStore().createIndex(

                                        lyr2.getFeatureStore().getDefaultFeatureType(), indexName, indexName + "_idx");

                        dataManager.setDefaultFeatureIndexProviderName(

                                        fat.getDataType().getType(), defaultIndex);

                } catch (DataException e) {

                        Sextante.addErrorToLog(e);

                }

                //Builds the output and computes the operation

                try {

                        FeatureType featureType1 = lyr1.getFeatureStore().getDefaultFeatureType();

                        FeatureType featureType2 = lyr2.getFeatureStore().getDefaultFeatureType();

                        GeometryOperation operation = null;

                        FeatureStore outFeatStore = null;

            if (nearest) {

                outFeatStore =

                    buildOutPutStoreFromUnion(featureType1, featureType2,

                        lyr1.getShapeType(), getTranslation("SpatialJoin"),

                        RESULT, "DIST", Double.class);

                operation =

                    new SpatiallyIndexedSpatialJoinOperation(lyr2, indexName

                        + "_idx", this);

            } else {

                outFeatStore =

                    buildSpatialJoinOutPutStore(featureType1,

                        lyr1.getShapeType(), getTranslation("SpatialJoin"),

                        RESULT);

                IDissolveRule rule = new DissolveRule(0, funcMap);

                Summary summary =

                    new Summary(rule, outFeatStore.getDefaultFeatureType());

                operation =

                    new IntersectsSpatialJoinOperation(lyr2,

                        indexName + "_idx", summary, this);

            }

            operation.setTaskStatus(getStatus());

                        operation.computesGeometryOperation(lyr1.getFeatureStore(), 

                                        outFeatStore, 

                                        attrNames, 

                                        selectedGeomInput, 

                                        selectedGeomOverlay, 

                                        true);                

                } catch (DataException e) {

                        Sextante.addErrorToLog(e);

                }

                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 buildSpatialJoinOutPutStore(FeatureType featureType1,

                                                                                        int shapeType,

                                                                                        String sextanteLayerName, 

                                                                                        String sextanteLayerLabel) {

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

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

                Iterator it = featureType1.iterator();

                while( it.hasNext() ) {

                        FeatureAttributeDescriptor attribute = (FeatureAttributeDescriptor)it.next();

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

                                attr.add(attribute.getName());

                                typesList.add(attribute.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, 7);

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

                                typesList.add(Double.class);

                        }

                }

                attr.add(NEW_FIELD);

                typesList.add(Integer.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 SpatialJoinParametersPanel.class;

    }

}