org.gvsig.raster.lib.legend.api

Interface RasterLegendManager

public interface RasterLegendManager

Method Summary

Modifier and Type	Method and Description
ColorInterpretation	createColorInterpretation(java.awt.image.BufferedImage image, java.lang.String prefix)
ColorInterpretation	createColorInterpretation(java.util.List<java.lang.String> colorInterpretations)
ColorInterpretation	createColorInterpretation(java.lang.String definedColorInterpretation) Creates default color interpretation using ColorInterpretation constants.
ColorInterpretation	createColorInterpretation(java.lang.String[] colorInterpretations) Creates an empty ColorInterpretation
ColorTable	createColorTable() Creates a color table
ColorTable	createColorTable(java.lang.String name, java.util.List<ColorTableClass> colorTableClasses, boolean interpolated) Creates a new ColorTable
ColorTableClass	createColorTableClass()
ColorTableClass	createColorTableClass(java.lang.String className, double value, double interpolated, java.awt.Color color) Creates new instance with values received as parameters.
RasterLegend	createLegend() Creates a raster legend
RasterLegend	createLegend(ColorInterpretation colorInterpretation) Creates a raster legend
RasterLegend	createLegend(ColorInterpretation colorInterpretation, Transparency transparency, OperationList filters) Creates a raster legend
java.util.List<ColorTableClass>	createListColorTableClasses(double minimum, double maximum, double intervalSize, java.awt.Color fromColor, java.awt.Color toColor)
java.util.List<ColorTableClass>	createListColorTableClasses(double minimum, double maximum, int intervals, java.awt.Color fromColor, java.awt.Color toColor)
MakeColorTable	createMakeColorTable()
Transparency	createTransparency()
Transparency	createTransparency(int transparency, java.util.List<TransparencyRange> transparencyRanges) Creates a new Transparency using transparency value and defined TransparencyRange.
TransparencyRange	createTransparencyRange() Creates an empty TransparencyRange TransparencyRange.
TransparencyRange	createTransparencyRange(int[] redRange, int[] greenRange, int[] blueRange, int alpha, boolean isAnd) Creates a new TransparencyRange using color ranges TransparencyRange.
ColorTableIO	getColorTableIO() Gets default ColorTableIO to read and write ColorTable to file.
java.util.List<ColorTableIOFactory>	getColorTableIOFactories()
ColorTableIOFactory	getColorTableIOFactory(java.lang.String name) Gets registered ColorTableIOFactory with the name
java.util.List<<any>>	getColorTables(java.io.File folder) Gets ColorTable inside folder using registered ColorTableIOFactory.
void	registerColorTableIOFactory(java.lang.String name, ColorTableIOFactory colorTableIOFactory) Registers ColorTableIOFactory.

Method Detail

createLegend

RasterLegend createLegend()

Creates a raster legend

Returns:

RasterLegend

createLegend

RasterLegend createLegend(ColorInterpretation colorInterpretation)

Creates a raster legend

Parameters:

colorInterpretation - ColorInterpretation of this RasterLegend

Returns:

New RasterLegend

createLegend

RasterLegend createLegend(ColorInterpretation colorInterpretation,
                          Transparency transparency,
                          OperationList filters)

Creates a raster legend

Parameters:

colorInterpretation - ColorInterpretation of this

transparency - Transparency of this RasterLegend

filters - A OperationList to be applied

Returns:

New RasterLegend

createColorTableClass

ColorTableClass createColorTableClass()

Returns:

New empty instance of ColorTableClass

createColorTableClass

ColorTableClass createColorTableClass(java.lang.String className,
                                      double value,
                                      double interpolated,
                                      java.awt.Color color)

Creates new instance with values received as parameters.

Parameters:

className - Name of class

value - Value of class

interpolated - Interpolated value

color - Color of class

Returns:

New instance of ColorTableClass.

createColorTable

ColorTable createColorTable()

Creates a color table

Returns:

New color table instance

createColorTable

ColorTable createColorTable(java.lang.String name,
                            java.util.List<ColorTableClass> colorTableClasses,
                            boolean interpolated)

Creates a new ColorTable

Parameters:

name - Name of ColorTable

colorTableClasses - ColorTableClass that defined ColorTable

interpolated - True to apply interpolation to ColorTable

Returns:

New color table instance.

getColorTableIO

ColorTableIO getColorTableIO()

Gets default ColorTableIO to read and write ColorTable to file.

Returns:

Default ColorTableIO

getColorTableIOFactories

java.util.List<ColorTableIOFactory> getColorTableIOFactories()

Returns:

Gets registered ColorTableIOFactory.

getColorTableIOFactory

ColorTableIOFactory getColorTableIOFactory(java.lang.String name)

Gets registered ColorTableIOFactory with the name

Parameters:

name - Name of registered ColorTableIOFactory

Returns:

Register ColorTableIOFactory with name

getColorTables

java.util.List<<any>> getColorTables(java.io.File folder)

Gets ColorTable inside folder using registered ColorTableIOFactory.

Parameters:

folder - Folder of ColorTable

Returns:

List of color tables

registerColorTableIOFactory

void registerColorTableIOFactory(java.lang.String name,
                                 ColorTableIOFactory colorTableIOFactory)

Registers ColorTableIOFactory.

Parameters:

name - Name of ColorTableIOFactory to register it.

colorTableIOFactory - ColorTableIOFactory to create instances of ColorTableIO.

createColorInterpretation

ColorInterpretation createColorInterpretation(java.lang.String[] colorInterpretations)

Creates an empty ColorInterpretation

Parameters:

colorInterpretations -

Returns:

New ColorInterpretation instance

createColorInterpretation

ColorInterpretation createColorInterpretation(java.util.List<java.lang.String> colorInterpretations)

createColorInterpretation

ColorInterpretation createColorInterpretation(java.lang.String definedColorInterpretation)

Creates default color interpretation using ColorInterpretation constants.

Parameters:

definedColorInterpretation - Defined ColorInterpretation. See constants at ColorInterpretation interface.

Returns:

Default ColorInterpretation

createColorInterpretation

ColorInterpretation createColorInterpretation(java.awt.image.BufferedImage image,
                                              java.lang.String prefix)

createTransparency

Transparency createTransparency()

Returns:

Returns an empty Transparency

createTransparency

Transparency createTransparency(int transparency,
                                java.util.List<TransparencyRange> transparencyRanges)

Creates a new Transparency using transparency value and defined TransparencyRange.

Parameters:

transparency - Value of transparency

transparencyRanges - List with TransparencyRange that define ranges of transparency by RGB values

Returns:

New Transparency instance

createTransparencyRange

TransparencyRange createTransparencyRange()

Creates an empty TransparencyRange TransparencyRange.

Returns:

createTransparencyRange

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

Creates a new TransparencyRange using color ranges TransparencyRange.

Parameters:

redRange -

greenRange -

blueRange -

alpha -

isAnd -

Returns:

createListColorTableClasses

java.util.List<ColorTableClass> createListColorTableClasses(double minimum,
                                                            double maximum,
                                                            int intervals,
                                                            java.awt.Color fromColor,
                                                            java.awt.Color toColor)

Parameters:

minimum -

maximum -

intervals -

fromColor -

toColor -

Returns:

createListColorTableClasses

java.util.List<ColorTableClass> createListColorTableClasses(double minimum,
                                                            double maximum,
                                                            double intervalSize,
                                                            java.awt.Color fromColor,
                                                            java.awt.Color toColor)

Parameters:

minimum -

maximum -

intervalSize -

fromColor -

toColor -

Returns:

createMakeColorTable

MakeColorTable createMakeColorTable()

Returns: