Application: gvSIG desktop

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

 *

 * Copyright (C) 2005 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: AbstractIntervalLegend.java 14418 2007-10-04 11:22:02Z jvidal $

* $Log$

* Revision 1.12  2007-09-19 16:25:39  jaume

* ReadExpansionFileException removed from this context and removed unnecessary imports

*

* Revision 1.11  2007/09/10 15:47:11  jaume

* *** empty log message ***

*

* Revision 1.10  2007/08/03 09:22:08  jaume

* refactored class names

*

* Revision 1.9  2007/08/02 10:19:03  jvidal

* implements IPersistance

*

* Revision 1.8  2007/08/01 11:45:59  jaume

* passing general tests (drawing test yet missing)

*

* Revision 1.7  2007/05/28 15:36:42  jaume

* *** empty log message ***

*

* Revision 1.6  2007/05/17 09:32:06  jaume

* *** empty log message ***

*

* Revision 1.5  2007/05/10 14:13:36  jaume

* *** empty log message ***

*

* Revision 1.4  2007/05/10 09:44:08  jaume

* Refactored legend interface names

*

* Revision 1.3  2007/03/27 09:28:40  jaume

* *** empty log message ***

*

* Revision 1.2  2007/03/09 11:20:56  jaume

* Advanced symbology (start committing)

*

* Revision 1.1.2.2  2007/02/15 16:23:44  jaume

* *** empty log message ***

*

* Revision 1.1.2.1  2007/02/13 16:19:19  jaume

* graduated symbol legends (start commiting)

*

*

*/

package com.iver.cit.gvsig.fmap.rendering;

import java.util.ArrayList;

import java.util.Comparator;

import java.util.Iterator;

import java.util.TreeMap;

import org.apache.log4j.Logger;

import com.hardcode.gdbms.driver.exceptions.ReadDriverException;

import com.hardcode.gdbms.engine.data.DataSource;

import com.hardcode.gdbms.engine.instruction.FieldNotFoundException;

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

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

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

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

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

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

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

import com.iver.cit.gvsig.exceptions.layers.LegendLayerException;

import com.iver.cit.gvsig.fmap.Messages;

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

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

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

import com.iver.cit.gvsig.fmap.core.styles.SimpleMarkerFillPropertiesStyle;

import com.iver.cit.gvsig.fmap.core.symbols.IMarkerSymbol;

import com.iver.cit.gvsig.fmap.core.symbols.ISymbol;

import com.iver.cit.gvsig.fmap.core.symbols.MarkerFillSymbol;

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

public abstract class AbstractIntervalLegend extends AbstractClassifiedVectorLegend implements IVectorialIntervalLegend{

        protected int shapeType;

        public static final int EQUAL_INTERVALS = 0;

        public static final int NATURAL_INTERVALS = 1;

        public static final int QUANTILE_INTERVALS = 2;

        protected TreeMap symbols = new TreeMap

                        (new Comparator() {

                public int compare(Object o1, Object o2) {

                        if ((o1 != null) && (o2 != null)) {

                                if (o1 instanceof NullIntervalValue &&

                                                o2 instanceof NullIntervalValue) {

                                        return 0;

                                }

                                if (o2 instanceof NullIntervalValue) {

                                        return 1;

                                }

                                if (o1 instanceof NullIntervalValue) {

                                        return -1;

                                }

                                FInterval i2 = (FInterval) o2;

                                FInterval i1 = (FInterval) o1;

                                if (i1.getMin() > i2.getMin()) {

                                        return 1;

                                }

                                if (i1.getMin() < i2.getMin()) {

                                        return -1;

                                }

                                if (i1.getMax() < i2.getMax()) {

                                        return -1;

                                }

                                if (i1.getMax() > i2.getMax()) {

                                        return 1;

                                }

                        }

                        return 0;

                }

        });

        protected ArrayList keys = new ArrayList();

        protected int index = 0;

        protected String[] fieldNames;

        protected int fieldId;

        protected ISymbol defaultSymbol;

        protected DataSource dataSource;

        protected int intervalType = NATURAL_INTERVALS;

        protected boolean useDefaultSymbol = false;

        private Logger logger = Logger.getLogger(AbstractIntervalLegend.class);

        public void addSymbol(Object key, ISymbol symbol) {

                symbols.put(key, symbol);

                keys.add(key);

        }

        /*

         * @see com.iver.cit.gvsig.fmap.rendering.IVectorialLegend#getSymbol(int)

         */

        public ISymbol getSymbol(int recordIndex) throws ReadDriverException {

                Value val = dataSource.getFieldValue(recordIndex, fieldId);

                IInterval interval = getInterval(val);

                ISymbol theSymbol = getSymbolByInterval(interval);

                if (shapeType == FShape.POLYGON && theSymbol instanceof IMarkerSymbol) {

                        // transform it to a fill symbol

                        MarkerFillSymbol aux = new MarkerFillSymbol();

                        // tell the fill style to draw the IMarkerSymbol

                        // as a IFillSymbol centering it in the shape polygon

                        // centroid and applying offset (if any).

                        aux.setMarker((IMarkerSymbol) theSymbol);

                        SimpleMarkerFillPropertiesStyle p = new SimpleMarkerFillPropertiesStyle();

                        p.setFillStyle(SimpleMarkerFillPropertiesStyle.SINGLE_CENTERED_SYMBOL);

                        aux.setMarkerFillProperties(p);

                        theSymbol = aux;

                }

                if (theSymbol != null) {

                        return theSymbol;

                } else if (useDefaultSymbol) {

                        return getDefaultSymbol();

                }

                return null;

        }

        public ISymbol getSymbolByFeature(IFeature feat) {

                Value val = feat.getAttribute(FLyrVect.forTestOnlyVariableUseIterators_REMOVE_THIS_FIELD

                        ? 0 :fieldId);

                IInterval interval = getInterval(val);

                ISymbol theSymbol = getSymbolByInterval(interval);

                if (theSymbol == null) 

                        return getDefaultSymbol();

                if (shapeType == FShape.POLYGON && theSymbol instanceof IMarkerSymbol) {

                        // transform it to a fill symbol

                        MarkerFillSymbol aux = new MarkerFillSymbol();

                        // tell the fill style to draw the IMarkerSymbol

                        // as a IFillSymbol centering it in the shape polygon

                        // centroid and applying offset (if any).

                        aux.setMarker((IMarkerSymbol) theSymbol);

                        SimpleMarkerFillPropertiesStyle p = new SimpleMarkerFillPropertiesStyle();

                        p.setFillStyle(SimpleMarkerFillPropertiesStyle.SINGLE_CENTERED_SYMBOL);

                        aux.setMarkerFillProperties(p);

                        theSymbol = aux;

                }

                return theSymbol;

        }

        public FInterval[] calculateIntervals(DataSource recordSet, String fieldName, int numIntervalos, int shapeType)

        throws ReadDriverException, LegendLayerException {

                logger.debug("elRs.start()");

                recordSet.start();

                int idField = -1;

                setClassifyingFieldNames(new String[] {fieldName});

                String[] fieldNames = getClassifyingFieldNames();

                for (int i = 0; i < recordSet.getFieldCount(); i++) {

                        String nomAux = recordSet.getFieldName(i).trim();

                        if (fieldNames[0].compareToIgnoreCase(nomAux) == 0) {

                                idField = i;

                                break;

                        }

                }

                if (idField == -1) {

                        logger.error("Campo no reconocido " + fieldNames);

                        return null;

                }

                double minValue = Double.MAX_VALUE;

                double maxValue = Double.NEGATIVE_INFINITY;

                VectorialIntervalLegend auxLegend = LegendFactory.

                    createVectorialIntervalLegend(shapeType);

                Value clave;

                for (int j = 0; j < recordSet.getRowCount(); j++) {

                        clave = recordSet.getFieldValue(j, idField);

                        IInterval interval = auxLegend.getInterval(clave);

                        ////Comprobar que no esta repetido y no hace falta introducir en el hashtable el campo junto con el simbolo.

                        if (auxLegend.getSymbolByInterval(interval) == null) {

                                //si no esta creado el simbolo se crea

                                double valor = 0;

                                if (clave instanceof IntValue) {

                                        valor = ((IntValue) clave).getValue();

                                } else if (clave instanceof DoubleValue) {

                                        valor = ((DoubleValue) clave).getValue();

                                } else if (clave instanceof FloatValue) {

                                        valor = ((FloatValue) clave).getValue();

                                } else if (clave instanceof LongValue) {

                                        valor = ((LongValue) clave).getValue();

                                } else if (clave instanceof DateValue) {

                                        //TODO POR IMPLEMENTAR

                                        ///valorDate = elRs.getFieldValueAsDate(idField);

                                        ///if (valorDate.before(minValueDate)) minValueDate = valorDate;

                                        ///if (valorDate.after(maxValueDate)) maxValueDate = valorDate;

                                } else if (clave instanceof NullValue) {

                                        continue;

                                }

                                if (valor < minValue) {

                                        minValue = valor;

                                }

                                if (valor > maxValue) {

                                        maxValue = valor;

                                }

                        }

                }

                FInterval[] intervalArray = null;

                switch (getIntervalType()) {

                case VectorialIntervalLegend.EQUAL_INTERVALS:

                        intervalArray = calculateEqualIntervals(numIntervalos,

                                        minValue, maxValue, fieldName);

                        break;

                case VectorialIntervalLegend.NATURAL_INTERVALS:

                        intervalArray = calculateNaturalIntervals(recordSet, numIntervalos,

                                        minValue, maxValue, fieldName);

                        break;

                case VectorialIntervalLegend.QUANTILE_INTERVALS:

                        intervalArray = calculateQuantileIntervals(recordSet, numIntervalos,

                                        minValue, maxValue, fieldName);

                        break;

                }

                recordSet.stop();

                return intervalArray;

        }

    /**

     * EQUAL INTERVAL Devuelve un Array con el n?mero de intervalos que se

     * quieren crear. Los intervalos se crean con un tama?o igual entre ellos.

     * @param numIntervals n?mero de intervalos

     * @param minValue Valor m?nimo.

     * @param maxValue Valor m?ximo.

     * @param fieldName Nombre del campo

     *

     * @return Array con los intervalos.

     */

    private FInterval[] calculateEqualIntervals(int numIntervals, double minValue,

        double maxValue, String fieldName) {

        FInterval[] theIntervalArray = new FInterval[numIntervals];

        double step = (maxValue - minValue) / numIntervals;

        if (numIntervals > 1) {

            theIntervalArray[0] = new FInterval(minValue, minValue + step);

            for (int i = 1; i < (numIntervals - 1); i++) {

                theIntervalArray[i] = new FInterval(minValue + (i * step) +

                        0.01, minValue + ((i + 1) * step));

            }

            theIntervalArray[numIntervals - 1] = new FInterval(minValue +

                    ((numIntervals - 1) * step) + 0.01, maxValue);

        } else {

            theIntervalArray[0] = new FInterval(minValue, maxValue);

        }

        return theIntervalArray;

    }

    /**

     * NATURAL INTERVAL Devuelve un Array con el n?mero de intervalos que se

     * quieren crear. Los intervalos se distribuyen de forma natural.

     *

     * @param numIntervals n?mero de intervalos

     * @param minValue Valor m?nimo.

     * @param maxValue Valor m?ximo.

     * @param fieldName Nombre del campo

     *

     * @return Array con los intervalos.

     * @throws LegendLayerException 

     */

    private FInterval[] calculateNaturalIntervals(DataSource recordSet, int numIntervals, double minValue,

        double maxValue, String fieldName) throws LegendLayerException {

        NaturalIntervalGenerator intervalGenerator = new NaturalIntervalGenerator(

                        recordSet, fieldName, numIntervals);

        try {

            intervalGenerator.generarIntervalos();

        } catch (ReadDriverException e) {

                throw new LegendLayerException(Messages.getString("failed_calculating_intervals"), e);

        }

        int numIntervalsGen = intervalGenerator.getNumIntervals() - 1;

        if (numIntervalsGen == -1) {

            //TODO cuando no puede calcular los intervalos.

            numIntervalsGen = 1;

        }

        FInterval[] theIntervalArray = new FInterval[numIntervalsGen];

        if (numIntervalsGen > 1) {

            theIntervalArray[0] = new FInterval(minValue,

                    intervalGenerator.getValorRuptura(0));

            for (int i = 1; i < (numIntervalsGen - 1); i++) {

                theIntervalArray[i] = new FInterval(intervalGenerator.getValInit(i -

                            1), intervalGenerator.getValorRuptura(i));

            }

            theIntervalArray[numIntervalsGen - 1] = new FInterval(intervalGenerator.getValInit(numIntervalsGen -

                        2), maxValue);

        } else {

            theIntervalArray[numIntervalsGen - 1] = new FInterval(minValue,

                    maxValue);

        }

        return theIntervalArray;

    }

    /**

     * QUANTILE INTERVAL Devuelve un Array con el n?mero de intervalos que se

     * quieren crear. Los intervalos se distribuyen de forma quantile.

     * @param recordSet 

     *

     * @param numIntervals n?mero de intervalos

     * @param minValue Valor m?nimo.

     * @param maxValue Valor m?ximo.

     * @param fieldName Nombre del campo

     *

     * @return Array con los intervalos.

     * @throws LegendLayerException 

     */

    private FInterval[] calculateQuantileIntervals(DataSource recordSet, int numIntervals, double minValue,

        double maxValue, String fieldName) throws LegendLayerException {

        QuantileIntervalGenerator intervalGenerator = new QuantileIntervalGenerator(

                        recordSet, fieldName, numIntervals);

        try {

            intervalGenerator.generarIntervalos();

        } catch (ReadDriverException e) {

                throw new LegendLayerException(Messages.getString("failed_calculating_intervals"), e);

        }

        int numIntervalsGen = intervalGenerator.getNumIntervalGen();

        FInterval[] theIntervalArray = new FInterval[numIntervalsGen];

        if (intervalGenerator.getNumIntervalGen() > 1) {

            theIntervalArray[0] = new FInterval(minValue,

                    intervalGenerator.getValRuptura(0));

            for (int i = 1; i < (numIntervalsGen - 1); i++) {

                theIntervalArray[i] = new FInterval(intervalGenerator.getValInit(i -

                            1), intervalGenerator.getValRuptura(i));

            }

            theIntervalArray[numIntervalsGen - 1] = new FInterval(intervalGenerator.getValInit(numIntervalsGen -

                        2), maxValue);

        } else {

            theIntervalArray[numIntervalsGen - 1] = new FInterval(minValue,

                    maxValue);

        }

        return theIntervalArray;

    }

        public ISymbol getSymbolByInterval(IInterval key) {

                if (key == null) {

                        return null;

                }

                if (symbols.containsKey(key)) {

                        return (ISymbol) symbols.get(key);

                }

                return null;

        }

        public String[] getDescriptions() {

                String[] descriptions = new String[symbols.size()];

                ISymbol[] auxSym = getSymbols();

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

                        descriptions[i] = auxSym[i].getDescription();

                return descriptions;

        }

        public Object[] getValues() {

                return symbols.keySet().toArray();

        }

        public void clear() {

                index = 0;

                keys.clear();

                symbols.clear();

        }

        public ISymbol[] getSymbols() {

                return (ISymbol[]) symbols.values().toArray(new ISymbol[0]);

        }

        public String[] getClassifyingFieldNames() {

                return fieldNames;

        }

        public void setDefaultSymbol(ISymbol s) {

                if (s == null) throw new NullPointerException("Default symbol cannot be null");

                defaultSymbol = s;

        }

        public void setClassifyingFieldNames(String[] fieldNames) {

                this.fieldNames = fieldNames;

        }

        public ISymbol getDefaultSymbol() {

                NullIntervalValue niv=new NullIntervalValue();

                if (symbols.containsKey(niv))

                        return (ISymbol)symbols.get(niv);

                if(defaultSymbol==null)

                    defaultSymbol=SymbologyFactory.createDefaultFillSymbol();//mio

                return defaultSymbol;

        }

    public void setDataSource(DataSource ds)

        throws FieldNotFoundException, ReadDriverException {

            if (!FLyrVect.forTestOnlyVariableUseIterators_REMOVE_THIS_FIELD) {

                    /*

                     * when we move definitely to feature iterators this

                     * method  

                     */

                    dataSource = ds;

                    ds.start();

                    fieldId = ds.getFieldIndexByName(fieldNames[0]);

                    ds.stop();

            } 

    }

        public IInterval getInterval(Value v) {

                for (int i = 0; i < keys.size(); i++) {

                        if (((IInterval) keys.get(i)).isInInterval(v)) {

                                return (IInterval) keys.get(i);

                        }

                }

                return null;

        }

        public void setIntervalType(int intervalType) {

                this.intervalType = intervalType;

        }

        public int getIntervalType() {

                return intervalType;

        }

        public void useDefaultSymbol(boolean b) {

                useDefaultSymbol = b;

        }

        public boolean isUseDefaultSymbol() {

                return useDefaultSymbol;

        }

        public void delSymbol(Object obj) {

                keys.remove(obj);

                symbols.remove(obj);

        }

        public void replace(ISymbol oldSymbol, ISymbol newSymbol) {

                if (symbols.containsValue(oldSymbol)) {

                        Iterator it = symbols.keySet().iterator();

                        while (it.hasNext()) {

                                Object key = it.next();

                                if (symbols.get(key).equals(oldSymbol)) {

                                        symbols.remove(key);

                                        symbols.put(key, newSymbol);

                                }

                        }

                }

        }

}