ProportionalStrokeLegend.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.stroke;

import org.orbisgis.coremap.renderer.se.fill.SolidFill;
import org.orbisgis.coremap.renderer.se.parameter.InterpolationPoint;
import org.orbisgis.coremap.renderer.se.parameter.ParameterException;
import org.orbisgis.coremap.renderer.se.parameter.real.Interpolate2Real;
import org.orbisgis.coremap.renderer.se.parameter.real.RealAttribute;
import org.orbisgis.coremap.renderer.se.parameter.real.RealLiteral;
import org.orbisgis.coremap.renderer.se.parameter.real.RealParameter;
import org.orbisgis.coremap.renderer.se.parameter.string.StringLiteral;
import org.orbisgis.coremap.renderer.se.stroke.PenStroke;
import org.orbisgis.legend.IInterpolationLegend;
import org.orbisgis.legend.LegendStructure;
import org.orbisgis.legend.LookupFieldName;
import org.orbisgis.legend.structure.fill.constant.ConstantFillLegend;
import org.orbisgis.legend.structure.fill.constant.ConstantSolidFillLegend;
import org.orbisgis.legend.structure.interpolation.LinearInterpolationLegend;
import org.orbisgis.legend.structure.literal.StringLiteralLegend;
import org.orbisgis.legend.structure.parameter.NumericLegend;

/**
 * {@code PenStroke} is defined using a {@code Width} attribute, which is a
 * RealAttribute. Consequently, it can be defined as linearly interpolated upon
 * some numeric attribute. This way, we obtain a "proportional line" analysis.
 * @author Alexis Guéganno
 */
public class ProportionalStrokeLegend extends ConstantColorAndDashesPSLegend
        implements IInterpolationLegend {

        /**
         * Builds an empty {@code ProportionalStrokeLegend}. It will change 0 to
         * 0 and 1 to 1. The lookup field can't be properly set from this
         * method, it's up to the caller to do it.
         */
        public ProportionalStrokeLegend(){
                PenStroke ps = (PenStroke) getStroke();
                Interpolate2Real ir = new Interpolate2Real(new RealLiteral(0));
                InterpolationPoint<RealParameter> ip =new InterpolationPoint<RealParameter>();
                ip.setData(0);
                ip.setValue(new RealLiteral(0));
                ir.addInterpolationPoint(ip);
                InterpolationPoint<RealParameter> ip2 =new InterpolationPoint<RealParameter>();
                ip2.setData(1);
                ip2.setValue(new RealLiteral(1));
                ir.addInterpolationPoint(ip2);
                ir.setLookupValue(new RealAttribute());
                ps.setWidth(ir);
                NumericLegend wa = new LinearInterpolationLegend(ir);
                setLineWidthLegend(wa);
        }

        /**
         * Builds a {@code ProportionalStrokeLegend} from the given {@code PenStroke}. We suppose the given parameter has
         * been validated. Otherwise, we will receive {@code ClassCastException} during initialization.
         * @param penStroke
         */
        public ProportionalStrokeLegend(PenStroke penStroke){
            super(penStroke,
                        new LinearInterpolationLegend((Interpolate2Real)penStroke.getWidth()),
                        new ConstantSolidFillLegend((SolidFill) penStroke.getFill()),
                        penStroke.getDashArray() == null ? null : new StringLiteralLegend((StringLiteral) penStroke.getDashArray()));
        }

        /**
         * Build a new {@code ProportionalStrokeLegend}, using the given {@code
         * PenStroke}.
         * @param penStroke
         */
        public ProportionalStrokeLegend(PenStroke penStroke, LinearInterpolationLegend width,
                    ConstantFillLegend fill, LegendStructure dashes) {
                super(penStroke, width, fill, dashes);
        }

        @Override
        public double getFirstData() {
            return ((LinearInterpolationLegend)getLineWidthLegend()).getFirstData();
        }

        @Override
        public double getSecondData() {
            return ((LinearInterpolationLegend)getLineWidthLegend()).getSecondData();
        }

        @Override
        public void setFirstData(double d) {
            ((LinearInterpolationLegend)getLineWidthLegend()).setFirstData(d);
        }

        @Override
        public void setSecondData(double d){
            ((LinearInterpolationLegend)getLineWidthLegend()).setSecondData(d);
        }

        @Override
        public double getFirstValue() throws ParameterException {
            return ((LinearInterpolationLegend)getLineWidthLegend()).getFirstValue();
        }

        @Override
        public void setFirstValue(double d) {
            ((LinearInterpolationLegend)getLineWidthLegend()).setFirstValue(d);
        }

        @Override
        public double getSecondValue() throws ParameterException {
            return ((LinearInterpolationLegend)getLineWidthLegend()).getSecondValue();
        }

        @Override
        public void setSecondValue(double d) {
            ((LinearInterpolationLegend)getLineWidthLegend()).setSecondValue(d);
        }

        @Override
        public void setLookupFieldName(String name) {
                ((LinearInterpolationLegend)getLineWidthLegend()).setLookupFieldName(name);
        }

        @Override
        public String getLookupFieldName() {
                return ((LinearInterpolationLegend)getLineWidthLegend()).getLookupFieldName();
        }
        
}