ColorLiteral.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.color;

import java.awt.Color;
import java.sql.ResultSet;
import java.util.Map;
import java.util.Random;
import javax.xml.bind.JAXBElement;
import net.opengis.fes._2.LiteralType;


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

/**
 * 
 * @author Maxence Laurent, Alexis Guéganno
 */
public class ColorLiteral extends Literal implements ColorParameter{

    private Color color;
    private static Random rndGenerator;

    static {
        rndGenerator = new Random(13579);
    }

    /**
     * Create a new random color 
     */
    public ColorLiteral(){
        int r = (int)(rndGenerator.nextFloat()*255);
        int g = (int)(rndGenerator.nextFloat()*255);
        int b = (int)(rndGenerator.nextFloat()*255);
        color = new Color(r,g,b);
    }

    @Override
    public boolean equals(Object o){
        if(o instanceof ColorLiteral){
            return ((ColorLiteral)o).color.equals(color);
        } else {
            return false;
        }
    }

    /**
     * Create a <code>ColorLiteral</code> with the given <code>Color</code>.
     * @param color 
     */
    public ColorLiteral(Color color){
        this.color = color;
    }

    /**
     * Either "well known color" or "#aabbcc"
     * @param htmlColor
     * @todo create color from htmlColor
     */
    public ColorLiteral(String htmlColor){
        this.color = Color.decode(htmlColor.trim());
    }

    /**
     * Build a ColorLiteral from a Literal SE value.
     * @param l 
     */
    public ColorLiteral(JAXBElement<LiteralType> l) {
        this(l.getValue().getContent().get(0).toString());
    }

    @Override
    public Color getColor(ResultSet rs, long fid){
        return color;
    }

    @Override
    public Color getColor(Map<String,Object> map){
        return color;
    }

    /**
     * Set the <code>Color</code> embedded in this <code>ColorLiteral</code> instance.
     * @param color 
     */
    public void setColor(Color color){
        this.color = color;
		this.fireChange();
    }

    @Override
    public String toString(){
        return "#" + String.format("%02X", color.getRed())
                + String.format("%02X", color.getGreen())
                + String.format("%02X", color.getBlue());
    }

    @Override
    public int compareTo(Object o) {
        Color col = (Color) o;
        if(col.getRGB() > color.getRGB()){
            return -1;
        } else if (col.getRGB() == color.getRGB()){
            return 0;
        } else {
            return 1;
        }
    }
}