Application: gvSIG desktop » gvSIG raster

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

import java.awt.Color;

import java.io.File;

import java.util.List;

import org.apache.commons.lang3.tuple.Pair;

import org.gvsig.raster.lib.buffer.api.FilterList;

import org.gvsig.raster.lib.legend.api.colorinterpretation.ColorInterpretation;

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

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

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

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

import org.gvsig.raster.lib.legend.api.colortable.colortableclass.ColorTableClass;

/**

 * @author fdiaz

 *

 */

public interface RasterLegendManager {

    /**

     * Creates a raster legend

     *

     * @return RasterLegend

     */

    public RasterLegend createLegend();

    /**

     * Creates a raster legend

     *

     * @param colorInterpretation

     *            {@link ColorInterpretation} of this {@link RasterLegend}

     * @return New {@link RasterLegend}

     */

    public RasterLegend createLegend(ColorInterpretation colorInterpretation);

    /**

     * Creates a raster legend

     *

     * @param colorInterpretation

     *            {@link ColorInterpretation} of this

     * @param transparency

     *            {@link Transparency} of this {@link RasterLegend}

     * @param filters

     *            A {@link FilterList} to be applied

     * @return New {@link RasterLegend}

     */

    public RasterLegend createLegend(ColorInterpretation colorInterpretation,

        Transparency transparency, FilterList filters);

    /**

     * @return New empty instance of {@link ColorTableClass}

     */

    public ColorTableClass createColorTableClass();

    /**

     * Creates new instance with values received as parameters.

     *

     * @param className

     *            Name of class

     * @param value

     *            Value of class

     * @param interpolated

     *            Interpolated value

     * @param color

     *            Color of class

     * @return New instance of {@link ColorTableClass}.

     */

    public ColorTableClass createColorTableClass(String className, double value,

        double interpolated, Color color);

    /**

     * Creates a color table

     *

     * @return New color table instance

     */

    public ColorTable createColorTable();

    /**

     * Creates a new {@link ColorTable}

     *

     * @param name

     *            Name of {@link ColorTable}

     * @param colorTableClasses

     *            {@link ColorTableClass} that defined {@link ColorTable}

     * @param interpolated

     *            True to apply interpolation to {@link ColorTable}

     * @return New color table instance.

     */

    public ColorTable createColorTable(String name, List<ColorTableClass> colorTableClasses,

        boolean interpolated);

    /**

     * Gets default {@link ColorTableIO} to read and write {@link ColorTable} to

     * file.

     *

     * @return Default {@link ColorTableIO}

     */

    public ColorTableIO getColorTableIO();

    /**

     * @return Gets registered {@link ColorTableIOFactory}.

     */

    public List<ColorTableIOFactory> getColorTableIOFactories();

    /**

     * Gets registered {@link ColorTableIOFactory} with the name

     *

     * @param name

     *            Name of registered {@link ColorTableIOFactory}

     * @return Register {@link ColorTableIOFactory} with name

     */

    public ColorTableIOFactory getColorTableIOFactory(String name);

    /**

     * Gets {@link ColorTable} inside folder using registered

     * {@link ColorTableIOFactory}.

     *

     * @param folder

     *            Folder of {@link ColorTable}

     * @return List of color tables

     */

    public List<Pair<File,ColorTable>> getColorTables(File folder);

    /**

     * Registers {@link ColorTableIOFactory}.

     *

     * @param name

     *            Name of {@link ColorTableIOFactory} to register it.

     * @param colorTableIOFactory

     *            {@link ColorTableIOFactory} to create instances of

     *            {@link ColorTableIO}.

     */

    public void registerColorTableIOFactory(String name, ColorTableIOFactory colorTableIOFactory);

    /**

     * Creates an empty {@link ColorInterpretation}

     *

     * @param colorInterpretations

     *

     * @return New {@link ColorInterpretation} instance

     */

    public ColorInterpretation createColorInterpretation(String[] colorInterpretations);

    /**

     * Creates default color interpretation using {@link ColorInterpretation}

     * constants.

     *

     * @param definedColorInterpretation

     *            Defined {@link ColorInterpretation}. See constants at

     *            {@link ColorInterpretation} interface.

     * @return Default {@link ColorInterpretation}

     */

    public ColorInterpretation createColorInterpretation(String definedColorInterpretation);

    /**

     * @return Returns an empty {@link Transparency}

     */

    public Transparency createTransparency();

    /**

     * Creates a new {@link Transparency} using transparency value and defined

     * {@link TransparencyRange}.

     *

     * @param transparency

     *            Value of transparency

     * @param transparencyRanges

     *            List with {@link TransparencyRange} that define ranges of

     *            transparency by RGB values

     * @return New {@link Transparency} instance

     */

    public Transparency createTransparency(int transparency,

        List<TransparencyRange> transparencyRanges);

    /**

     * Creates an empty {@link TransparencyRange}

     * {@link TransparencyRange}.

     * @return

     */

    public TransparencyRange createTransparencyRange();

    /**

     * Creates a new {@link TransparencyRange} using color ranges

     *

     * {@link TransparencyRange}.

     * @param redRange

     * @param greenRange

     * @param blueRange

     * @param alpha

     * @param isAnd

     * @return

     */

    public TransparencyRange createTransparencyRange(int[] redRange, int[] greenRange, int[] blueRange, int alpha, boolean isAnd);

    /**

     * @param minimum

     * @param maximum

     * @param intervals

     * @param fromColor

     * @param toColor

     * @return

     */

    List<ColorTableClass> createListColorTableClasses(double minimum, double maximum, int intervals, Color fromColor,

        Color toColor);

    /**

     * @param minimum

     * @param maximum

     * @param intervalSize

     * @param fromColor

     * @param toColor

     * @return

     */

    List<ColorTableClass> createListColorTableClasses(double minimum, double maximum, double intervalSize,

        Color fromColor, Color toColor);

    /**

     * @return

     */

    MakeColorTable createMakeColorTable();

}