Application: gvSIG desktop

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

import org.gvsig.raster.lib.legend.api.colortable.ColorTable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.observer.WeakReferencingObservable;

import org.gvsig.tools.persistence.Persistent;

import org.gvsig.tools.lang.Cloneable;

/**

 * @author fdiaz

 *

 */

public interface ColorInterpretation extends WeakReferencingObservable, Persistent, Cloneable, Observer {

    // Color interpretation identifiers

    public static final String RED_BAND = "Red";

    public static final String GREEN_BAND = "Green";

    public static final String BLUE_BAND = "Blue";

    public static final String ALPHA_BAND = "Alpha";

    public static final String GRAY_BAND = "Gray";

    // public static final String RED_GREEN_BAND = "Red_Green"; // YELLOW_BAND?

    // public static final String RED_BLUE_BAND = "Red_Blue"; // MAGENTA_BAND?

    // public static final String GREEN_BLUE_BAND = "Green_Blue"; // CYAN_BAND?

    public static final String HUE_BAND = "Hue";

    public static final String SATURATION_BAND = "Saturation";

    public static final String LIGHTNESS_BAND = "Lightness";

    public static final String CYAN_BAND = "Cyan";

    public static final String MAGENTA_BAND = "Magenta";

    public static final String YELLOW_BAND = "Yellow";

    public static final String BLACK_BAND = "Black";

    public static final String YCBCR_Y_BAND = "YCbCr_Y";

    public static final String YCBCR_CB_BAND = "YCbCr_Cb";

    public static final String YCBCR_CR_BAND = "YCbCr_Cr";

    public static final String PALETTE_BAND = "Palette";

    public static final String UNDEFINED_BAND = "Undefined";

    // Constants to initialize the color interpretation

    public static final String RGB = "RGB";

    public static final String BGR = "BGR";

    public static final String ARGB = "ARGB";

    public static final String GRAYSCALE = "GRAYSCALE";

    public static final String PALETTE = "PALETTE";

    public static final String HSL = "HSL";

    public static final String CMYK = "CMYK";

    public static final String YCBCR = "YCBCR";

    /**

     * Set color interpretation value to band

     *

     * @param band

     *            Band

     * @param value

     *            Color interpretation value

     */

    public void setColorInterpValue(int band, String value);

    /**

     * @return Returns the number of assigned color interpretation values

     */

    public int length();

    /**

     * @return Returns true if the color values are

     *         assigned to any band of the image or the values Gray or Palette

     *         are

     *         assigned.

     */

    public boolean hasInterpretation();

    /**

     * @return Returns true if the color interpretation is BGR, that is, the

     *         three first bands of the image are Blue, Green and Red.

     *

     */

    public boolean isBGR();

    /**

     * @return Returns true if the color interpretation is RGB, that is, the

     *         three first bands of the image are Red, Green and Blue.

     */

    public boolean isRGB();

    /**

     * @return Returns true if the color interpretation is ARGB, that is, the

     *         four first bands of the image are Red, Green, Blue and Alpha.

     */

    public boolean isRGBA();

    /**

     * @return Returns true if the color interpretation has at least one RED

     *         band, one GREEN band and one BLUE band.

     */

    public boolean hasAnyRGBBand();

    /**

     * @return Returns true if the color interpretation is Gray

     */

    public boolean isGray();

    /**

     * @return Returns true if the color interpretation is HSL

     */

    public boolean isHSL();

    /**

     * @return Returns true if the color interpretation is CMYK

     */

    public boolean isCMYK();

    /**

     * @return Returns true if the color interpretation YCBCR

     */

    public boolean isYCBCR();

    /**

     * @param band

     * @return Returns true if the selected band has color

     *         interpretation

     *         and false otherwise

     */

    public boolean isColorInterpretation(int band);

    /**

     * @param band

     * @return Returns true if the selected band has gray interpretation and

     *         false

     *         otherwise

     */

    public boolean isGrayInterpretation(int band);

    /**

     * @param band

     * @return Returns true if the selected band has palette interpretation and

     *         false

     *         otherwise

     */

    public boolean isPaletteInterpretation(int band);

    /**

     *

     *

     * @param band

     * @return Returns true if the selected band has alpha interpretation and

     *         false

     *         otherwise

     */

    public boolean isAlphaInterpretation(int band);

    /**

     * Get color interpretation of band.

     *

     * @param i

     *            Number of band

     * @return Color interpretation defined of band

     */

    public String get(int i);

    /**

     * Gets the band position defined with color interpretation received as

     * parameter.

     *

     * @param id

     *            Color interpretation definition

     * @return Index of band

     */

    public int getBand(String id);

    /**

     * Gets if color interpretation is defined

     *

     * @return True if color interpretation is defined, false if it is undefined

     */

    public boolean isUndefined();

    /**

     * Gets color interpretation of all bands

     *

     * @return Array with color interpretation

     */

    public String[] getValues();

    /**

     * @return Returns true if one band has the "Alpha" label

     */

    public boolean hasAlphaBand();

    /**

     * @return Returns the number of band with the label "Alpha"

     */

    public int getAlphaBand();

    /**

     * Adds a color interpretation to this color interpretation. The result is

     * the addition of color interpretations.

     *

     * @param ci

     */

    public void addColorInterpretation(ColorInterpretation ci);

    /**

     * Copy from the color interpretation received as parameter

     *

     * @param colorInterpretation

     */

    public void copyFrom(ColorInterpretation colorInterpretation);

    /**

     * @return Returns true if the color interpretation has at least one Gray

     *         band.

     */

    boolean hasAnyGrayBand();

    /**

     * @return Returns true if the color interpretation has at least one Palette

     *         band.

     */

    public boolean hasAnyPaletteBand();

    /**

     * @return Returns true if the color interpretation has at least one HUE

     *         band, one SATURATION band or one LIGHTNESS band.

     */

    public boolean hasAnyHSLBand();

    /**

     * @return Returns true if the color interpretation has at least one HUE

     *         band, one SATURATION band or one LIGHTNESS band.

     */

    public boolean hasAnyCMYKBand();

    /**

     * @return Returns true if the color interpretation has at least one YCBCR-CB

     *         band, one YCBCR-CR band or one YCBCR-Y band.

     */

    public boolean hasAnyYCBCRBand();

    /**

     * Sets the colorTable.

     * @param colorTable

     */

    public void setPalette(ColorTable colorTable);

    /**

     * Sets the band which will apply the color table

     * @param band

     */

    public void setPaletteBand(int band);

    /**

     * If there are not color table, return -1

     *

     * @return the band in which will apply  the color table

     */

    public int getPaletteBand();

    /**

     * @return the color table

     */

    public ColorTable getPalette();

    /**

     * @return true if paletteBand and colorTable are not null.

     */

    public boolean isPalette();

    /**

     * @return Returns true if the color interpretation has at least one Color band

     * (not Gray, Palette nor Alpha)

     *

     */

    public boolean hasAnyColorInterpretationBand();

}