PointSymbolizer.java

/**
 * OrbisGIS is a java GIS application dedicated to research in GIScience.
 * OrbisGIS is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * OrbisGIS is distributed under GPL 3 license.
 *
 * Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
 * Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
 *
 * This file is part of OrbisGIS.
 *
 * OrbisGIS 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 3 of the License, or (at your option) any later
 * version.
 *
 * OrbisGIS 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
 * OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, please consult: <http://www.orbisgis.org/>
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.orbisgis.coremap.renderer.se;

import com.vividsolutions.jts.geom.Geometry;
import java.awt.Graphics2D;
import java.awt.geom.AffineTransform;
import java.awt.geom.Point2D;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import javax.xml.bind.JAXBElement;
import net.opengis.se._2_0.core.ExtensionParameterType;
import net.opengis.se._2_0.core.ExtensionType;
import net.opengis.se._2_0.core.ObjectFactory;
import net.opengis.se._2_0.core.PointSymbolizerType;
import org.slf4j.*;



import org.orbisgis.coremap.map.MapTransform;
import org.orbisgis.coremap.renderer.se.SeExceptions.InvalidStyle;
import org.orbisgis.coremap.renderer.se.common.Uom;
import org.orbisgis.coremap.renderer.se.graphic.GraphicCollection;
import org.orbisgis.coremap.renderer.se.graphic.MarkGraphic;
import org.orbisgis.coremap.renderer.se.parameter.ParameterException;
import org.orbisgis.coremap.renderer.se.parameter.geometry.GeometryAttribute;
import org.xnap.commons.i18n.I18n;
import org.xnap.commons.i18n.I18nFactory;

/**
 * {@code PointSymbolizer} are used to draw a graphic at a point. As a symbolizer, 
 * it depends on :
 * <ul><li>A version</li>
 * <li>A name<li>
 * <li>A Description</li>
 * <li>A LegendGraphic</li></ul>
 * 
 * It has additional requirements :
 * <ul><li>A geometry, ie a value reference containing the geometry to style. It 
 * is optional, but shall appear if several geometries are defined in the data
 * type.</li>
 * <li>A unit of measure. If not set, the UOM of the parent will be used.</li>
 * <li>Graphic : the graphic to draw at the point. Compulsory.</li></ul>
 * 
 * An additional parameter can be given. It is used to determine if the symbol 
 * must be drawn on the vertex of a geometry, rather than at its center.
 * 
 * @author Alexis Guéganno, Maxence Laurent
 */
public final class PointSymbolizer extends VectorSymbolizer implements GraphicNode {
    private static final I18n I18N = I18nFactory.getI18n(PointSymbolizer.class);
    private static final String MODE_VERTEX = "vertex";
    private GraphicCollection graphic;
    private boolean onVertex;

    /**
     * Build a new default {@code PointSymbolizer}. It contains a 
     * {@link GraphicCollection} that contains a single default {@code MarkGraphic}.
     * Its UOM is {@link Uom#MM}.
     */
    public PointSymbolizer() {
        super();
        this.name = I18N.tr("Point Symbolizer");
        setGraphicCollection(new GraphicCollection());
        MarkGraphic mark = new MarkGraphic();
        graphic.addGraphic(mark);
        onVertex = false;
    }

    /**
     * Build a {@code PointSymbolizer} using the elements registered in the 
     * givenJAXBElement.
     * @param st
     * @throws org.orbisgis.coremap.renderer.se.SeExceptions.InvalidStyle
     */
    public PointSymbolizer(JAXBElement<PointSymbolizerType> st) throws InvalidStyle {
        super(st);
        PointSymbolizerType pst = st.getValue();

        if (pst.getGeometry() != null) {
            this.setGeometryAttribute(new GeometryAttribute(pst.getGeometry()));
        }

        onVertex = false;
        if (pst.getExtension() != null) {
            for (ExtensionParameterType param : pst.getExtension().getExtensionParameter()) {
                if (param.getName().equalsIgnoreCase("mode")) {
                    //level = Integer.parseInt(param.getContent());
                    onVertex = param.getContent().equalsIgnoreCase(MODE_VERTEX);
                    break;
                }
            }
        }

        if (pst.getUom() != null) {
            Uom u = Uom.fromOgcURN(pst.getUom());
            this.setUom(u);
        }

        if (pst.getGraphic() != null) {
            this.setGraphicCollection(new GraphicCollection(pst.getGraphic(), this));

        }
    }

    @Override
    public GraphicCollection getGraphicCollection() {
        return graphic;
    }

    @Override
    public void setGraphicCollection(GraphicCollection graphic) {
        this.graphic = graphic;
        graphic.setParent(this);
    }

    @Override
    public void draw(Graphics2D g2, ResultSet rs, long fid,
            boolean selected, MapTransform mt, Geometry the_geom)
            throws IOException, SQLException, ParameterException {

            if (graphic != null && graphic.getNumGraphics() > 0) {
                double x,y;
                Map<String,Object> map = getFeaturesMap(rs, fid);
                if (onVertex) {
                    List<Point2D> points = getPoints(rs, fid, mt, the_geom);
                    for (Point2D pt : points) {
                    x = pt.getX();
                    y = pt.getY();
                    graphic.draw(g2, map, selected, mt, AffineTransform.getTranslateInstance(x, y));
                    }
                } else {
                    Point2D pt = getPointShape(rs, fid, mt, the_geom);

                    x = pt.getX();
                    y = pt.getY();

                    // Draw the graphic right over the point !
                    graphic.draw(g2, map, selected, mt, AffineTransform.getTranslateInstance(x, y));
                }
        }
    }

    @Override
    public JAXBElement<PointSymbolizerType> getJAXBElement() {
        ObjectFactory of = new ObjectFactory();
        PointSymbolizerType s = of.createPointSymbolizerType();

        this.setJAXBProperty(s);


        if (this.getGeometryAttribute() != null){
            s.setGeometry(getGeometryAttribute().getJAXBGeometryType());
        }


        if (getUom() != null) {
            s.setUom(this.getUom().toURN());
        }

        if (graphic != null) {
            s.setGraphic(graphic.getJAXBElement());
        }

        if (onVertex) {
            ExtensionType exts = new ExtensionType();
            ExtensionParameterType param = of.createExtensionParameterType();
            param.setName("mode");
            param.setContent(MODE_VERTEX);
            exts.getExtensionParameter().add(param);
            s.setExtension(exts);
        }

        return of.createPointSymbolizer(s);
    }

    public boolean isOnVertex() {
        return onVertex;
    }

    public void setOnVertex(boolean onVertex) {
        this.onVertex = onVertex;
    }

    @Override
    public List<SymbolizerNode> getChildren() {
        List<SymbolizerNode> ls = new ArrayList<SymbolizerNode>();
        if(this.getGeometryAttribute()!=null){
            ls.add(this.getGeometryAttribute());
        }
        ls.add(graphic);
        return ls;
    }
}