ConstantFormWKN.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.legend.structure.graphic;

import org.orbisgis.coremap.renderer.se.common.Uom;
import org.orbisgis.coremap.renderer.se.fill.Fill;
import org.orbisgis.coremap.renderer.se.fill.SolidFill;
import org.orbisgis.coremap.renderer.se.graphic.MarkGraphic;
import org.orbisgis.coremap.renderer.se.parameter.string.StringLiteral;
import org.orbisgis.coremap.renderer.se.stroke.PenStroke;
import org.orbisgis.coremap.renderer.se.stroke.Stroke;
import org.orbisgis.legend.LegendStructure;
import org.orbisgis.legend.structure.fill.FillLegend;
import org.orbisgis.legend.structure.fill.constant.ConstantSolidFill;
import org.orbisgis.legend.structure.fill.constant.ConstantSolidFillLegend;
import org.orbisgis.legend.structure.fill.constant.NullSolidFillLegend;
import org.orbisgis.legend.structure.literal.StringLiteralLegend;
import org.orbisgis.legend.structure.stroke.constant.ConstantPenStroke;
import org.orbisgis.legend.structure.stroke.constant.ConstantPenStrokeLegend;
import org.orbisgis.legend.structure.stroke.constant.NullPenStrokeLegend;

/**
 * This abstract class is a common {@code LegendStructure} description for all the {@code
 * MarkGraphic} instances where the only varying parameters are the dimensions
 * of the associated {@code ViewBox}. That means the {@code Fill}, the {@code
 * Stroke} and the {@code StringParameter} containing the well-known name
 * definition are constants.
 * @author Alexis Guéganno
 */
public abstract class ConstantFormWKN extends MarkGraphicLegend {

    /**
     * Builds a new ConstantFormWKN from the given mark and viewBoxLegend. We consider that the varying parameters are
     * all gathered in the mark's view box. All the other parameters are considered to be constant. It's up to you to
     * be sure it is.
     * @param mark
     * @param viewBoxLegend
     */
    public ConstantFormWKN(MarkGraphic mark, LegendStructure viewBoxLegend){
        super(mark,
                    new StringLiteralLegend((StringLiteral)mark.getWkn()),
                    viewBoxLegend,
                    getFillLeg(mark),
                    getStrokeLeg(mark)
        );
    }

    private static FillLegend getFillLeg(MarkGraphic mark){
        Fill f = mark.getFill();
        return  f == null ? new NullSolidFillLegend() :  new ConstantSolidFillLegend((SolidFill)f);
    }

    private static ConstantPenStroke getStrokeLeg(MarkGraphic mark){
        Stroke s = mark.getStroke();
        return s == null ? new NullPenStrokeLegend() :  new ConstantPenStrokeLegend((PenStroke) s);
    }

    /**
     * Builds a new default {@code ConstantFormWKN} associated to a default
     * {@link MarkGraphic}.
     */
    public ConstantFormWKN(){
            super();
    }
    /**
     * Build a default {@code LegendStructure} that describes a {@code MarkGraphic}
     * instance.
     * @param mark
     * @param wknLegend
     * @param viewBoxLegend
     * @param fillLegend
     * @param strokeLegend
     */
    public ConstantFormWKN(MarkGraphic mark, StringLiteralLegend wknLegend,
            LegendStructure viewBoxLegend, ConstantSolidFill fillLegend,
            ConstantPenStroke strokeLegend) {
        super(mark, wknLegend, viewBoxLegend, fillLegend, strokeLegend);
    }

    /**
     * Retrieves the {@code ConstantSolidFill} that is associated to this mark
     * graphic. It can be used to configure safely the underlying {@code
     * MarkGraphic} without threatening the found analysis.
     * @return
     */
    public ConstantSolidFill getSolidFill(){
            return (ConstantSolidFill) getFillLegend();
    }

    /**
     * Retrieves the {@code ConstantPenStroke} that is associated to this mark
     * graphic. It can be used to configure safely the underlying {@code
     * PenStroke} without threatening the found analysis.
     * @return
     */
    public ConstantPenStroke getPenStroke(){
            return (ConstantPenStroke) getStrokeLegend();
    }

    /**
     * Sets the {@code ConstantPenStroke} that is associated to this mark
     * graphic.
     * @param cps
     */
    public void setPenStroke(ConstantPenStroke cps){
            setStrokeLegend(cps);
    }

    /**
     * Gets the well-known name that describes the shape of the inner {@link
     * MarkGraphic}.
     * @return
     */
    public String getWellKnownName(){
            return ((StringLiteralLegend) getWknLegend()).getLiteral().getValue(null);
    }

    /**
     * Sets the well-known name that describes the shape of the inner {@link
     * MarkGraphic}.
     * @param string
     * The new {@code WellKnownName}.
     */
    public void setWellKnownName(String string){
            StringLiteralLegend sll = new StringLiteralLegend(new StringLiteral(string));
            setWknLegend(sll);
    }

    /**
     * Gets the unit of measure used to draw the associated {@code Stroke}.
     * @return
     */
    public Uom getStrokeUom(){
            return getPenStroke().getStrokeUom();
    }

    /**
     * Sets the unit of measure used to draw the associated {@code Stroke}.
     * @param u
     */
    public void setStrokeUom(Uom u){
            getPenStroke().setStrokeUom(u);
    }

    /**
     * Gets the unit of measure used to size the associated {@code Stroke}.
     * @return
     */
    public Uom getSymbolUom(){
            return getMarkGraphic().getUom();
    }

    /**
     * Sets the unit of measure used to size the associated {@code Stroke}.
     * @param u
     */
    public void setSymbolUom(Uom u){
            getMarkGraphic().setUom(u);
    }
}