Application: gvSIG desktop

/*

 * Created on 24-feb-2006

 *

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

 *

 * Copyright (C) 2004 IVER T.I. and 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.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

 *

 * $Id: DissolveVisitor.java 12804 2007-07-26 12:18:11Z  $

 * $Log$

 * Revision 1.2.2.1  2007-07-12 09:28:45  azabala

 * optimizations in dissolution of buffered features (we dont use strategies to avoid reading of geometries already processed)

 *

 * Revision 1.2  2006/07/27 17:21:06  azabala

 * *** empty log message ***

 *

 * Revision 1.1  2006/06/20 18:20:45  azabala

 * first version in cvs

 *

 * Revision 1.3  2006/06/08 18:24:43  azabala

 * modificaciones para admitir capas de shapeType MULTI

 *

 * Revision 1.2  2006/06/02 18:21:28  azabala

 * *** empty log message ***

 *

 * Revision 1.1  2006/05/24 21:11:14  azabala

 * primera version en cvs despues de refactoring orientado a crear un framework extensible de geoprocessing

 *

 * Revision 1.5  2006/05/08 15:37:26  azabala

 * added alphanumeric dissolve

 *

 * Revision 1.4  2006/05/01 19:14:30  azabala

 * comentario

 *

 * Revision 1.3  2006/03/15 18:33:24  azabala

 * *** empty log message ***

 *

 * Revision 1.2  2006/03/07 21:01:33  azabala

 * *** empty log message ***

 *

 * Revision 1.1  2006/03/06 19:48:39  azabala

 * *** empty log message ***

 *

 * Revision 1.2  2006/03/05 19:58:30  azabala

 * *** empty log message ***

 *

 * Revision 1.1  2006/02/26 20:54:04  azabala

 * *** empty log message ***

 *

 *

 */

package com.iver.cit.gvsig.geoprocess.impl.dissolve.fmap;

import java.awt.geom.Rectangle2D;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Stack;

import com.hardcode.gdbms.engine.data.driver.DriverException;

import com.hardcode.gdbms.engine.values.NumericValue;

import com.hardcode.gdbms.engine.values.Value;

import com.hardcode.gdbms.engine.values.ValueFactory;

import com.iver.cit.gvsig.fmap.core.DefaultFeature;

import com.iver.cit.gvsig.fmap.core.IGeometry;

import com.iver.cit.gvsig.fmap.core.v02.FConverter;

import com.iver.cit.gvsig.fmap.edition.EditionException;

import com.iver.cit.gvsig.fmap.layers.FBitSet;

import com.iver.cit.gvsig.fmap.layers.FLayer;

import com.iver.cit.gvsig.fmap.layers.FLyrVect;

import com.iver.cit.gvsig.fmap.layers.SelectableDataSource;

import com.iver.cit.gvsig.fmap.layers.layerOperations.AlphanumericData;

import com.iver.cit.gvsig.fmap.layers.layerOperations.VectorialData;

import com.iver.cit.gvsig.fmap.operations.strategies.FeatureVisitor;

import com.iver.cit.gvsig.fmap.operations.strategies.Strategy;

import com.iver.cit.gvsig.fmap.operations.strategies.VisitException;

import com.iver.cit.gvsig.geoprocess.core.fmap.FeatureProcessor;

import com.iver.cit.gvsig.geoprocess.core.fmap.SummarizationFunction;

import com.iver.cit.gvsig.geoprocess.core.fmap.XTypes;

import com.vividsolutions.jts.geom.Geometry;

import com.vividsolutions.jts.geom.GeometryFactory;

/**

 * <p>

 * This FeatureVisitor processes each geometry of a polygon layer, looks for

 * adjacent polygons and verify values of a dissolve field. If these values are

 * coincident, it creates a new polygon by unioning original polygons. Also

 * applies a sumarization function to numeric fields of original features.

 * </p>

 * 

 * @author azabala

 * 

 */

public class DissolveVisitor implements FeatureVisitor {

        /**

         * Allows to get attributes of disolved layer features

         */

        protected SelectableDataSource recordset;

        /**

         * Is used to do spatial querys (looking for adjacent polygons to visited

         * feature geometry

         */

        protected FLyrVect dissolvedLayer;

        /**

         * Field which adjacent features must have the same value to dissolve them

         */

        protected String dissolveField;

        /**

         * It marks all features that have already been dissolved (to avoid process

         * them in subsecuent steps)

         * 

         */

        protected FBitSet dissolvedGeometries;

        /**

         * Relates a numerical field name with its sumarization functions

         */

        protected Map numericField_sumarizeFunction;

        /**

         * Processes results of dissolve operations (save them in a file, or cache

         * them in memory, etc)

         */

        protected FeatureProcessor featureProcessor;

        /**

         * Strategy of the layer we want to dissolve

         */

        protected Strategy strategy;

        /**

         * Index of the result

         */

        protected int fid = 0;

        /**

         * Constructor

         * @param dissolveField

         * @param processor

         */

        public DissolveVisitor(String dissolveField, FeatureProcessor processor) {

                this.dissolveField = dissolveField;

                this.featureProcessor = processor;

                dissolvedGeometries = new FBitSet();

        }

        public int getNumProcessedGeometries() {

                return dissolvedGeometries.cardinality();

        }

        public FBitSet getDissolvedGeometries(){

                return dissolvedGeometries;

        }

        public void setDissolvedAttributesInfo(Map numericField_sumFunction) {

                this.numericField_sumarizeFunction = numericField_sumFunction;

        }

        /*

         * Algorithm to compute dissolve is strongly based in depth first algorithm

         * to traverse graphs.

         * 

         * It puts features to dissolve in a stack. While stack is not empty, get

         * Features and looks for adjacent to it. For each adjacent feature, verify

         * its dissolve field value, and if it is similar to feature to dissolve

         * with, obtain a new feature by unioning their geometries and by applying

         * sumarization functions to its numeric attributes. For each adjacent

         * feature, put it in the Stack

         */

        public void visit(IGeometry g, int index) throws VisitException {

                if(g == null)

                        return;

                if(g.getGeometryType() != XTypes.POLYGON &&

                                g.getGeometryType() != XTypes.MULTI)

                        return;

                if (!dissolvedGeometries.get(index)) {

                        // if we havent dissolved this feature

                        Stack toDissol = new Stack();// stack for adjacent features

                        DissolvedFeature feature;

                        try {

                                feature = createFeature(g, index);

                                toDissol.push(feature);

                                ArrayList geometries = new ArrayList();

                                Value[] values = dissolveGeometries(toDissol, geometries);

                                Geometry geometry = union(geometries);

                                Value[] valuesWithFID = new Value[values.length + 1];

                                System.arraycopy(values, 0, valuesWithFID, 1, values.length);

                                valuesWithFID[0] = ValueFactory.createValue(fid);

                                DissolvedFeature dissolved = new DissolvedFeature(null,valuesWithFID, fid/*index*/);

                                dissolved.setJtsGeometry(geometry);

                                this.featureProcessor.processFeature(dissolved);

                                fid++;

                                resetFunctions();

                        } catch (DriverException e) {

                                throw new VisitException(

                                                "Error al procesar las geometrias a fusionar durante dissolve");

                        } catch (com.iver.cit.gvsig.fmap.DriverException e) {

                                throw new VisitException(

                                                "Error al procesar las geometrias a fusionar durante dissolve");

                        }

                }// if

        }

        /**

         * Returns the union of all geometries of the list

         * @param geometries

         * @return

         */

        protected Geometry union(List geometries){

                Geometry union = null;

                Geometry[] geom = new Geometry[geometries.size()];

                geometries.toArray(geom);                

                GeometryFactory fact = geom[0].getFactory();

            Geometry geomColl = fact.createGeometryCollection(geom);    

            union = geomColl.buffer(0);    

            return union;

        }

        /**

         * FIXME Redise?ar esto, pues el codigo es similar al de Spatial Join

         * 

         */

        protected void resetFunctions() {

                if(numericField_sumarizeFunction == null)

                        return;

                Iterator fieldsIt = numericField_sumarizeFunction.keySet().iterator();

                while (fieldsIt.hasNext()) {

                        String field = (String) fieldsIt.next();

                        SummarizationFunction[] functions = (SummarizationFunction[]) numericField_sumarizeFunction

                                        .get(field);

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

                                functions[i].reset();

                        }// for

                }// while

        }

        /**

         * Inner class to manage dissolve geoprocess. It mantains feature info

         * interesting for dissolve (int index, JTS Geometry, etc)

         * 

         * @author azabala

         * 

         */

        protected class DissolvedFeature extends DefaultFeature {

                int index;

                Geometry jtsGeometry;

                public DissolvedFeature(IGeometry geom, Value[] att, int index) {

                        super(geom, att);

                        this.index = index;

                }

                public int getIndex() {

                        return index;

                }

                public Geometry getJtsGeometry() {

                        return jtsGeometry;

                }

                public void setJtsGeometry(Geometry jtsGeometry) {

                        this.jtsGeometry = jtsGeometry;

                }

                public IGeometry getGeometry() {

                        IGeometry solution = super.getGeometry();

                        if (solution == null && jtsGeometry != null) {

                                solution = FConverter.jts_to_igeometry(jtsGeometry);

                        }

                        return solution;

                }

        }

        /**

         * Creates a new IFeature with util info for dissolve geoprocess (it ignore

         * non numerical values, etc)

         * 

         * @param g

         * @param index

         * @return

         * @throws DriverException

         */

        protected DissolvedFeature createFeature(IGeometry g, int index)

                        throws DriverException {

                DissolvedFeature solution = null;

                int numNumericFields = 0;

                if(numericField_sumarizeFunction != null)

                        numNumericFields = numericField_sumarizeFunction.keySet().size();

                // attributes will be dissolve field and sumarized function for

                // numerical

                // values

                Value[] values = new Value[numNumericFields + 1];

                if (numericField_sumarizeFunction != null){

                        Iterator fieldIt = numericField_sumarizeFunction.keySet().iterator();

                        int valueIndex = 0;

                        while (fieldIt.hasNext()) {

                                String fieldName = (String) fieldIt.next();

                                int fieldIndex = recordset.getFieldIndexByName(fieldName);

                                values[valueIndex] = recordset.getFieldValue(index, fieldIndex);

                                valueIndex++;

                        }

                }

                /*

                 * FIXME In this case, we are dissolving with one only dissolve field.

                 * To work with many dissolve fields, we must to follow certain

                 * conventions: For example, first numeric fields, after that, dissolve

                 * fields

                 */

                int dissolveField = recordset.getFieldIndexByName(this.dissolveField);

                values[numNumericFields] = recordset

                                .getFieldValue(index, dissolveField);

                solution = new DissolvedFeature(g, values, index);

                return solution;

        }

//        // FIXME Mover esto a una utility class

//        protected Geometry fastUnion(Geometry g1, Geometry g2) {

//                Geometry[] geoms = new Geometry[2];

//                geoms[0] = g1;

//                geoms[1] = g2;

//                GeometryCollection gc = g1.getFactory().createGeometryCollection(geoms);

//                return gc.buffer(0d);

//        }

        protected boolean verifyIfDissolve(DissolvedFeature fet1,

                        DissolvedFeature fet2) {

                Geometry jtsGeo = fet1.getJtsGeometry();

                Geometry featureJtsGeo = fet2.getJtsGeometry();

                //FIXME Revisar si intersects considera dos arcos adjacentes

                //que no comparten nodo

                if (jtsGeo.intersects(featureJtsGeo)) {// They have at least

                        //a common point

                        // dissolveField is the last

                        int fieldIndex = 0;

                        if (numericField_sumarizeFunction != null)

                                fieldIndex = numericField_sumarizeFunction.keySet().size();

                        Value adjacentVal = fet1.getAttribute(fieldIndex);

                        Value val = fet2.getAttribute(fieldIndex);

                        if (adjacentVal.doEquals(val)) {

                                return true;

                        }// if val equals

                }// if touches

                return false;

        }

        /**

         * For each individual geometry processed in DissolveVisitor's visit method,

         * this Visitor visits its adjacent polygons geometries to check dissolve

         * conditions.

         * 

         * @author azabala

         * 

         */

        protected class IndividualGeometryDissolveVisitor implements FeatureVisitor {

                /**

                 * Marks index of features that have been dissolved yet

                 */

                FBitSet dissolvedFeatures;

                /**

                 * It saves all features for we are looking for adjacent geometries.

                 * Dissolving is similar to network tracking algorithms: one feature is

                 * adjacent to two, two is adjacent to four, etc We will save features

                 * to process in this stack

                 */

                Stack featuresToDissolve;

                /**

                 * Field use to dissolve adjacent geometries with the same value for it

                 * 

                 * FIXME Change it for an evaluator of logical expresions

                 */

                String dissolveField;

                /**

                 * Maps for each numerical field its sumarization functions

                 */

                Map fields_sumarizeFunc;

                /**

                 * Feature for which we are looking for features to dissolve

                 */

                DissolvedFeature feature;

                /**

                 * jts geometry of feature

                 */

                private Geometry featureJtsGeo;

                /**

                 * Numeric values result of a sumarization operation

                 */

                private List sumarizedValues;

                /**

                 * Constructor

                 * 

                 * @param feature

                 *            Feature we are analizing to found its adjacents

                 * 

                 * @param dissolvedFeatures

                 *            bitset that marks all analyzed features (to not to analyze

                 *            later)

                 * 

                 * @param featuresToDissolve

                 *            stack where we put adjacent features to analyze later

                 * 

                 * @param fields_sumarize

                 *            maps a numeric field of the solution layer with its

                 *            sumarization functions

                 */

                protected IndividualGeometryDissolveVisitor(DissolvedFeature feature,

                                FBitSet dissolvedFeatures, Stack featuresToDissolve,

                                Map fields_sumarize) {

                        this.dissolvedFeatures = dissolvedFeatures;

                        this.feature = feature;

                        this.featuresToDissolve = featuresToDissolve;

                        this.featureJtsGeo = feature.getGeometry().toJTSGeometry();

                        feature.setJtsGeometry(featureJtsGeo);

                        this.sumarizedValues = new ArrayList();

                        this.fields_sumarizeFunc = fields_sumarize;

                }

                public String getProcessDescription() {

                        return "Dissolving a polygon with its adjacents";

                }

                /**

                 * Applies to sumarization functions feature values.

                 * 

                 * @throws DriverException

                 * 

                 * FIXME Redise?ar, pues el codigo es similar al de Spatial Join

                 */

                protected void applySumarizeFunction(int recordIndex)

                                throws DriverException {

                        // TODO Redesing this with extensible dissolve

                        if (fields_sumarizeFunc == null)

                                return;

                        Iterator fieldsIt = fields_sumarizeFunc.keySet().iterator();

                        while (fieldsIt.hasNext()) {

                                String field = (String) fieldsIt.next();

                                int fieldIndex = recordset.getFieldIndexByName(field);

                                Value valToSumarize = recordset.getFieldValue(recordIndex,

                                                fieldIndex);

                                SummarizationFunction[] functions = (SummarizationFunction[]) fields_sumarizeFunc

                                                .get(field);

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

                                        functions[i].process((NumericValue) valToSumarize);

                                        sumarizedValues.add(functions[i].getSumarizeValue());

                                }// for

                        }// while

                }

                /**

                 * Analizes a feature (defined by g and its index) to see if it is an

                 * adjacent feature to the given feature, and to check its dissolve

                 * condition.

                 * 

                 * @param g

                 * @param index

                 */

                public void visit(IGeometry g, int index) throws VisitException {

                        // Is it the feature whose adjacents we are looking for?

                        if (index == feature.getIndex())

                                return;

                        // have we dissolved this feature yet?

                        if (dissolvedFeatures.get(index))

                                return;

                        try {

                                DissolvedFeature adjacentFeature = createFeature(g, index);

                                Geometry jtsGeo = g.toJTSGeometry();

                                adjacentFeature.setJtsGeometry(jtsGeo);

                                if (verifyIfDissolve(feature, adjacentFeature)) {

                                        dissolvedFeatures.set(index);

                                        // we actualize geometry by unioning

                                        featuresToDissolve.push(adjacentFeature);

                                        // group by attributes

                                        applySumarizeFunction(index);

                                }

                        } catch (DriverException e) {

                                throw new VisitException(

                                                "Error al cargar los pol?gonos adyacentes durante un dissolve");

                        }        

                }// visit

                public void stop(FLayer layer) {

                }

                public boolean start(FLayer layer) {

                        try {

                                recordset = ((AlphanumericData) layer).getRecordset();

                                this.applySumarizeFunction(feature.getIndex());

                        } catch (com.iver.cit.gvsig.fmap.DriverException e) {

                                return false;

                        } catch (DriverException e) {

                                return false;

                        }

                        return true;

                }

                public void setFields_sumarizeFunc(Map fields_sumarizeFunc) {

                        this.fields_sumarizeFunc = fields_sumarizeFunc;

                }

                public Map getFields_sumarizeFunc() {

                        return fields_sumarizeFunc;

                }

                public Geometry getFeatureJtsGeo() {

                        return featureJtsGeo;

                }

                public Value[] getSumarizedValues() {

                        Value[] solution = new Value[sumarizedValues.size()];

                        sumarizedValues.toArray(solution);

                        return solution;

                }

                public Value[] getSumarizedValues2() {

                        Value[] solution = null;

                        ArrayList values = new ArrayList();

                        if (fields_sumarizeFunc != null){

                                Iterator fieldsIt = fields_sumarizeFunc.keySet().iterator();

                                while (fieldsIt.hasNext()) {

                                        String field = (String) fieldsIt.next();

                                        SummarizationFunction[] functions = (SummarizationFunction[]) fields_sumarizeFunc

                                                        .get(field);

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

                                                values.add(functions[i].getSumarizeValue());

                                        }// for

                                }// while

                        }//if

                        if (dissolveField != null) {

                                try {

                                        int dissolveFieldIndex = recordset

                                                        .getFieldIndexByName(dissolveField);

                                        Value dissolveField = recordset.getFieldValue(feature

                                                        .getIndex(), dissolveFieldIndex);

                                        values.add(dissolveField);

                                } catch (DriverException e) {

                                        // TODO Auto-generated catch block

                                        e.printStackTrace();

                                }

                        }

                        solution = new Value[values.size()];

                        values.toArray(solution);

                        return solution;

                }

                public void setDissolveField(String dissolveField) {

                        this.dissolveField = dissolveField;

                }

                public void setProcessedFeature(DissolvedFeature feature2) {

                        this.feature = feature2;

                }

        }// IndividualDissolve

        protected Value[] dissolveGeometries(Stack toDissol,

                        List geometries) throws com.iver.cit.gvsig.fmap.DriverException,

                        VisitException {

                IndividualGeometryDissolveVisitor visitor = null;

                DissolvedFeature feature = null;

                while (toDissol.size() != 0) {

                        feature = (DissolvedFeature) toDissol.pop();

                        // flags this idx (to not to process in future)

                        dissolvedGeometries.set(feature.getIndex());

                        if (visitor == null) {

                                visitor = new IndividualGeometryDissolveVisitor(feature,

                                                dissolvedGeometries, toDissol,

                                                numericField_sumarizeFunction);

                                visitor.setDissolveField(this.dissolveField);

                        } else {

                                visitor.setProcessedFeature(feature);

                        }

                        Rectangle2D bounds = feature.getGeometry().getBounds2D();

                        double xmin = bounds.getMinX();

                        double ymin = bounds.getMinY();

                        double xmax = bounds.getMaxX();

                        double ymax = bounds.getMaxY();

                        double magnify = 15d;

                        Rectangle2D query = new Rectangle2D.Double(xmin - magnify, ymin

                                        - magnify, (xmax - xmin) + magnify, (ymax - ymin) + magnify);

                        strategy.process(visitor, query);

                        //al final de toda la pila de llamadas recursivas, 

                        //geometries tendr? todas las geometrias que debemos dissolver

                        geometries.add(feature.getJtsGeometry());

                }// while

                Value[] values = visitor.getSumarizedValues2();

                return values;

        }

        protected DissolvedFeature dissolve(Stack toDissol)

                        throws com.iver.cit.gvsig.fmap.DriverException, VisitException {

                DissolvedFeature feature = null;

                Geometry jtsGeometry = null;

                IndividualGeometryDissolveVisitor visitor = null;

                while (toDissol.size() != 0) {

                        feature = (DissolvedFeature) toDissol.pop();

                        // flags this idx (to not to process in future)

                        dissolvedGeometries.set(feature.getIndex());

                        if (visitor == null) {

                                visitor = new IndividualGeometryDissolveVisitor(feature,

                                                dissolvedGeometries, toDissol,

                                                numericField_sumarizeFunction);

                                visitor.setDissolveField(this.dissolveField);

                        } else {

                                visitor.setProcessedFeature(feature);

                        }

                        Rectangle2D bounds = feature.getGeometry().getBounds2D();

                        double xmin = bounds.getMinX();

                        double ymin = bounds.getMinY();

                        double xmax = bounds.getMaxX();

                        double ymax = bounds.getMaxY();

                        double magnify = 15d;

                        Rectangle2D query = new Rectangle2D.Double(xmin - magnify, ymin

                                        - magnify, (xmax - xmin) + magnify, (ymax - ymin) + magnify);

                        strategy.process(visitor, query);

                        Geometry jtsGeo = visitor.getFeatureJtsGeo();

                        if (jtsGeometry == null) {

                                jtsGeometry = jtsGeo;

                        } else {

                                jtsGeometry = jtsGeometry.union(jtsGeo);

                        }

                }// while

                Value[] values = visitor.getSumarizedValues2();

                feature = new DissolvedFeature(null, values, -1);

                feature.setJtsGeometry(jtsGeometry);

                return feature;

        }

        public void stop(FLayer layer) {

                this.featureProcessor.finish();

        }

        public boolean start(FLayer layer) {

                if (layer instanceof AlphanumericData && layer instanceof VectorialData) {

                        try {

                                dissolvedLayer = (FLyrVect) layer;

                                recordset = ((AlphanumericData) layer).getRecordset();

                                featureProcessor.start();

                        } catch (com.iver.cit.gvsig.fmap.DriverException e) {

                                return false;

                        } catch (EditionException e) {

                                return false;

                        }

                        return true;

                }

                return false;

        }

        public void setStrategy(Strategy strategy) {

                this.strategy = strategy;

        }

        public String getProcessDescription() {

                return "Dissolving polygons of a layer";

        }

}