Application: gvSIG desktop » gvSIG raster

package org.gvsig.raster.lib.legend.api.colortable;

import java.util.List;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.tools.persistence.Persistent;

/**

 * @author fdiaz

 *

 */

public interface ColorTable extends Persistent, Cloneable {

    /**

     * Compress {@link ColorTable} to reduce number of {@link ColorTableClass}.

     */

    public void compressPalette();

    /**

     * Copies from {@link ColorTable} received as parameter

     *

     * @param colorTable

     *            {@link ColorTable} to be copied

     */

    public void copyFrom(ColorTable colorTable);

    /**

     * @return {@link ColorTableClass} of this {@link ColorTable}

     */

    public List<ColorTableClass> getClasses();

    /**

     * @return Gets the name of this {@link ColorTable}

     */

    public String getName();

    /**

     * @return Return if {@link ColorTable} has alpha

     */

    public boolean hasAlpha();

    /**

     * @return Gets if this {@link ColorTable} is interpolated

     */

    public boolean isInterpolated();

    /**

     * Remove duplicated values of {@link ColorTableClass}

     */

    public void removeDuplicatedValues();

    /**

     * Sets {@link ColorTableClass} of this {@link ColorTable} and recalculates

     * palette color of this {@link ColorTable}.

     *

     * @param colorTableClasses

     *            New classes of this {@link ColorTable}

     * @param compress

     *            True to compress palette color.

     */

    public void setClasses(List<ColorTableClass> colorTableClasses, boolean compress);

    /**

     * Calculates and sets {@link ColorTableClass} of this {@link ColorTable}

     * take into account min and max value. Palette color is recalculated with

     * new color table classes.

     *

     * @param min

     *            Minimum value of {@link ColorTableClass}

     * @param max

     *            Maximum value of {@link ColorTableClass}

     * @param compress

     *            True to compress {@link ColorTable}.

     */

    public void setClasses(double min, double max, boolean compress);

    /**

     * Sets interpolated to this {@link ColorTable}

     *

     * @param interpolated

     */

    public void setInterpolated(boolean interpolated);

    /**

     * Sets name of this {@link ColorTable}

     *

     * @param name

     */

    public void setName(String name);

    /**

     * Get RGBA values defined by {@link ColorTableClass}

     *

     * @param value

     *            Value to get RGBA

     * @return Byte array with RGBA values

     */

    byte[] getRGBA(Object value);

}