Categorize2String.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.parameter.string;

import java.sql.ResultSet;
import java.util.Iterator;
import java.util.Map;
import javax.xml.bind.JAXBElement;
import net.opengis.fes._2.LiteralType;
import net.opengis.se._2_0.core.CategorizeType;
import net.opengis.se._2_0.core.ParameterValueType;
import net.opengis.se._2_0.core.ThresholdBelongsToType;


import org.orbisgis.coremap.renderer.se.SeExceptions.InvalidStyle;
import org.orbisgis.coremap.renderer.se.parameter.Categorize;
import org.orbisgis.coremap.renderer.se.parameter.ParameterException;
import org.orbisgis.coremap.renderer.se.parameter.SeParameterFactory;
import org.orbisgis.coremap.renderer.se.parameter.real.RealLiteral;
import org.orbisgis.coremap.renderer.se.parameter.real.RealParameter;
/**
 * A categorization from {@code RealParameter} to {@code StringParamter}
 * @author Alexis Guéganno, Maxence Laurent
 */
public final class Categorize2String extends Categorize<StringParameter, StringLiteral> implements StringParameter {

    private String[] restriction = new String[]{};

        /**
         * Build a new {@code Categorize2String} with the given parameters. Built using 
         * {@link Categorize#Categorize(org.orbisgis.coremap.renderer.se.parameter.SeParameter,
         * org.orbisgis.coremap.renderer.se.parameter.SeParameter,
         * org.orbisgis.coremap.renderer.se.parameter.real.RealParameter) Categorize}
         * @param initialClass
         * The value of the first class.
         * @param fallback
         * The default value if an input can't be processed.
         * @param lookupValue 
         * The {@code RealParameter} used to retrieve the input values.
         */
    public Categorize2String(StringParameter initialClass, StringLiteral fallback, RealParameter lookupValue) {
        super(initialClass, fallback, lookupValue);
    }

        /**
         * Build a new {@code Categorize2String} from a JAXB element.
         * @param expr
         * @throws org.orbisgis.coremap.renderer.se.SeExceptions.InvalidStyle
         */
    public Categorize2String(JAXBElement<CategorizeType> expr) throws InvalidStyle {
        CategorizeType t = expr.getValue();

        this.setFallbackValue(new StringLiteral(t.getFallbackValue()));
        this.setLookupValue(SeParameterFactory.createRealParameter(t.getLookupValue()));


        Iterator<Object> it = t.getThresholdAndValue().iterator();
        this.put(new RealLiteral(Double.NEGATIVE_INFINITY), SeParameterFactory.createStringParameter((ParameterValueType)it.next()));

        // Fetch class values and thresholds
        while (it.hasNext()) {
            RealLiteral th = new RealLiteral((LiteralType)(it.next()));
            StringParameter vl = SeParameterFactory.createStringParameter((ParameterValueType)it.next());
            this.put(th, vl);
        }

        if (t.getThresholdBelongsTo() == ThresholdBelongsToType.PRECEDING) {
            this.setThresholdsPreceding();
        } else {
            this.setThresholdsSucceeding();
        }
        super.setPropertyFromJaxB(t);
    }

    @Override
    public String getValue(ResultSet rs, long fid) {
        try {
            return getParameter(rs, fid).getValue(rs, fid);
        } catch (ParameterException ex) {
            return this.getFallbackValue().getValue( rs, fid);
        }
    }

    @Override
    public String getValue(Map<String, Object> map) {
        try {
            return getParameter(map).getValue(map);
        } catch (ParameterException ex) {
            return this.getFallbackValue().getValue(map);
        }
    }

    @Override
    public void put(RealLiteral th, StringParameter value){
        super.put(th, value);
        value.setRestrictionTo(restriction);
    }

    @Override
    public void setRestrictionTo(String[] list) {
        restriction = list.clone();
        for (int i=0;i<this.getNumClasses();i++){
            get(i).setRestrictionTo(list);
        }
    }
}