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: GraduatedSymbolLegend.java 16187 2007-11-08 16:13:44Z jdominguez $

* $Log$

* Revision 1.3  2007-05-17 09:32:06  jaume

* *** empty log message ***

*

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

* Advanced symbology (start committing)

*

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

* *** empty log message ***

*

* Revision 1.1.2.3  2007/02/14 15:53:35  jaume

* *** empty log message ***

*

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

* graduated symbol legends (start commiting)

*

* Revision 1.1.2.1  2007/02/12 15:15:20  jaume

* refactored interval legend and added graduated symbol legend

*

*

*/

package org.gvsig.symbology.fmap.rendering;

import org.gvsig.symbology.fmap.styles.SimpleMarkerFillPropertiesStyle;

import org.gvsig.symbology.fmap.symbols.MarkerFillSymbol;

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.symbols.IMarkerSymbol;

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

import com.iver.cit.gvsig.fmap.rendering.VectorialIntervalLegend;

import com.iver.utiles.StringUtilities;

import com.iver.utiles.XMLEntity;

/**

 * <p>GraduatedSymbolLegend is a legend that allows to classify ranges of

 * values using a value with symbol sizes.<b>

 * </p>

 * <p>

 * The symbol size will be calculated according the min size, the

 * max size and the amount of intervals. So for a min size of 1, a max size

 * of 5, and 5 intervals, symbol sizes will be [1, 2, 3, 4, 5].

 * </p>

 * @author  jaume dominguez faus - jaume.dominguez@iver.es

 */

public class GraduatedSymbolLegend extends VectorialIntervalLegend {

        private double maxSymbolSize;

        private double minSymbolSize;

        private ISymbol templateSymbol;

        /**

         * DefaultConstructor

         */

        public GraduatedSymbolLegend() {

                super();

        }

        /**

         * Convenience constructor.

         * 

         * Creates a new instance of GraduatedSymbolLegend from a VectorialIntervalLegend by

         * taking the same fields. 

         * @param leg

         */

        public GraduatedSymbolLegend(VectorialIntervalLegend leg) {

                this();

                VectorialIntervalLegend.initializeVectorialIntervalLegend(leg, this);

        }

        /**

         * Returns the max symbol size. Combined with the min symbol size and

         * the interval count, will produce the symbol sizes.

         * @return double, the max size.

         */

        public double getMaxSymbolSize() {

                return maxSymbolSize;

        }

        /**

         * Returns the min symbol size. Combined with the max symbol size and

         * the interval count, will produce the symbol sizes.

         * @return double, the min size.

         */

        public double getMinSymbolSize() {

                return minSymbolSize;

        }

        /**

         * Sets the max symbol size. Combined with the min symbol size and

         * the interval count, will produce the symbol sizes.

         */

        public void setMaxSymbolSize(double size) {

                this.maxSymbolSize = size;

        }

        /**

         * Sets the min symbol size. Combined with the max symbol size and

         * the interval count, will produce the symbol sizes.

         */

        public void setMinSymbolSize(double size) {

                this.minSymbolSize = size;

        }

        public XMLEntity getXMLEntity() {

                XMLEntity xml = super.getXMLEntity();

                xml.putProperty("className", getClass().getName());

                xml.putProperty("maxSymbolSize", maxSymbolSize);

                xml.putProperty("minSymbolSize", minSymbolSize);

                if (templateSymbol != null) {

                        XMLEntity templateXML = templateSymbol.getXMLEntity();

                        templateXML.putProperty("id", "templateSymbol");

                        xml.addChild(templateXML);

                }

                // remove unuseful properties from supertype

                xml.remove("startColor");

                xml.remove("endColor");

                return xml;

        }

        public void setXMLEntity(XMLEntity xml) {

                // patch for avoid errors in call to supertype's

                // setXMLEntity(XMLEntity)

                xml.putProperty("startColor",

                                StringUtilities.color2String(super.getStartColor()));

                xml.putProperty("endColor",

                                StringUtilities.color2String(super.getEndColor()));

                // end patch

                super.setXMLEntity(xml);

                maxSymbolSize = xml.getDoubleProperty("maxSymbolSize");

                minSymbolSize = xml.getDoubleProperty("minSymbolSize");

                if (xml.firstChild("id", "templateSymbol") != null) {

                        XMLEntity templateXML = xml.firstChild("id", "templateSymbol");

                        templateSymbol = SymbologyFactory.createSymbolFromXML(templateXML, "templateSymbol");

                } 

        }

        @Override

        public ISymbol getSymbolByFeature(IFeature feat) {

                ISymbol theSymbol = super.getSymbolByFeature(feat); 

                if (feat.getGeometry().getGeometryType() == 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;

        }

        /**

         * Sets the default symbol.

         * @param symbol

         */

        public void setTemplateSymbol(ISymbol symbol) {

                this.templateSymbol = symbol;

        }

        /**

         * Obtains the template symbol

         * @return

         */

        public ISymbol getTemplateSymbol() {

                return templateSymbol;

        }

}