StringLiteral.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.Arrays;
import java.util.Map;
import javax.xml.bind.JAXBElement;
import net.opengis.fes._2.LiteralType;


import org.orbisgis.coremap.renderer.se.parameter.Literal;

/**
 * A {@code StringParameter} with a stored, inner {@code String} value.
 * @author Alexis Guéganno
 */
public class StringLiteral extends Literal implements StringParameter{

    private String v;
    private String[] restriction;

    /**
     * Instanciates a new {@code StringLiteral} with an empty inner {@code String} value.
     */
    public StringLiteral(){
        v = "";
    }

    /**
     * Instanciates a new {@code StringLiteral} with inner {@code String} set to {@code value}.
     */
    public StringLiteral(String value){
        v = value;
    }

    /**
     * Builds a new {@code StringLiteral} from the given {@code JAXBElement.}.
     */
    public StringLiteral(JAXBElement<LiteralType> l) {
        this(l.getValue().getContent().get(0).toString());
    }

    @Override
    public String getValue(ResultSet rs, long fid){
        return v;
    }

    @Override
    public String getValue(Map<String, Object> feature){
        return v;
    }

    /**
     *
     * Set the inner {@code String} of this {@code StringLiteral} to {@code value}.
     * If {@code s} can't be found in the restrictions, an {@link InvalidString}
     * will be thrown.
     * @param value
     * @throws InvalidString if value is not compatible with the restrictions.
     */
    public void setValue(String value){
        if(validateValue(value)){
            v = value;
            update();
        } else {
                throw new InvalidString("Can't validate the value against the current restrictions !");
        }
    }

    @Override
    public String toString(){
        return v;
    }

    @Override
    public void setRestrictionTo(String[] list) {
        restriction = list == null ? new String[0] : list.clone();
        for (int i = 0; i < restriction.length; i++) {
                //We go to upper case in order to use binary search later.
                restriction[i] = restriction[i].toUpperCase();
        }
        Arrays.sort(restriction);
        if(!validateValue(v)){
                v = restriction[0];
                throw new InvalidString("Can't validate the current value against the new restrictions !");
        }
    }

    /**
     * Validate {@code s} against the restrictions set on this {@code
     * StringLiteral}.
     * @param s
     * @return
     */
    public boolean validateValue(String s){
            return restriction == null || restriction.length == 0 ||
                    Arrays.binarySearch(restriction, s.toUpperCase()) >= 0;
    }

    /**
     * Get the list of restrictions currently associated to this {@code StringLiteral}
     * @return 
     * The restrictions as an array of {@code String}
     */
    public String[] getRestriction(){
        return restriction;
    }

    @Override
    public boolean equals(Object o){
            return (o instanceof StringLiteral) ? v.equals(o.toString()) : false;
    }

    @Override
    public int hashCode() {
            int hash = 7;
            hash = 11 * hash + (this.v != null ? this.v.hashCode() : 0);
            return hash;
    }

    @Override
    public int compareTo(Object o) {
        StringLiteral st = (StringLiteral) o;
        return this.v.compareTo(st.v);
    }

}