Package org.gvsig.raster.lib.legend.api

Interface RasterLegendManager

public interface RasterLegendManager

Author:

fdiaz

Method Summary

Modifier and Type	Method	Description
ColorInterpretation	createColorInterpretation(BufferedImage image, String prefix)
ColorInterpretation	createColorInterpretation(String definedColorInterpretation)	Creates default color interpretation using ColorInterpretation constants.
ColorInterpretation	createColorInterpretation(String[] colorInterpretations)	Creates an empty ColorInterpretation
ColorInterpretation	createColorInterpretation(List<String> colorInterpretations)
ColorTable	createColorTable()	Creates a color table
ColorTable	createColorTable(String name, List<ColorTableClass> colorTableClasses, boolean interpolated)	Creates a new ColorTable
ColorTableClass	createColorTableClass()
ColorTableClass	createColorTableClass(String className, double value, double interpolated, 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, org.gvsig.raster.lib.buffer.api.operations.OperationList filters)	Creates a raster legend
List<ColorTableClass>	createListColorTableClasses(double minimum, double maximum, double intervalSize, Color fromColor, Color toColor)
List<ColorTableClass>	createListColorTableClasses(double minimum, double maximum, int intervals, Color fromColor, Color toColor)
MakeColorTable	createMakeColorTable()
Transparency	createTransparency()
Transparency	createTransparency(int transparency, 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.
List<ColorTableIOFactory>	getColorTableIOFactories()
ColorTableIOFactory	getColorTableIOFactory(String name)	Gets registered ColorTableIOFactory with the name
List<org.apache.commons.lang3.tuple.Pair<File,ColorTable>>	getColorTables(File folder)	Gets ColorTable inside folder using registered ColorTableIOFactory.
void	registerColorTableIOFactory(String name, ColorTableIOFactory colorTableIOFactory)	Registers ColorTableIOFactory.

Method Details

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,
 org.gvsig.raster.lib.buffer.api.operations.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(String className,
 double value,
 double interpolated,
 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(String name,
 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

List<ColorTableIOFactory> getColorTableIOFactories()

Returns:

Gets registered ColorTableIOFactory.

getColorTableIOFactory

ColorTableIOFactory getColorTableIOFactory(String name)

Gets registered ColorTableIOFactory with the name

Parameters:

name - Name of registered ColorTableIOFactory

Returns:

Register ColorTableIOFactory with name

getColorTables

List<org.apache.commons.lang3.tuple.Pair<File,ColorTable>> getColorTables(File folder)

Gets ColorTable inside folder using registered ColorTableIOFactory.

Parameters:

folder - Folder of ColorTable

Returns:

List of color tables

registerColorTableIOFactory

void registerColorTableIOFactory(String name,
 ColorTableIOFactory colorTableIOFactory)

Registers ColorTableIOFactory.

Parameters:

name - Name of ColorTableIOFactory to register it.

colorTableIOFactory - ColorTableIOFactory to create instances of ColorTableIO.

createColorInterpretation

ColorInterpretation createColorInterpretation(String[] colorInterpretations)

Creates an empty ColorInterpretation

Parameters:

colorInterpretations -

Returns:

New ColorInterpretation instance

createColorInterpretation

ColorInterpretation createColorInterpretation(List<String> colorInterpretations)

createColorInterpretation

ColorInterpretation createColorInterpretation(String definedColorInterpretation)

Creates default color interpretation using ColorInterpretation constants.

Parameters:

definedColorInterpretation - Defined ColorInterpretation. See constants at ColorInterpretation interface.

Returns:

Default ColorInterpretation

createColorInterpretation

ColorInterpretation createColorInterpretation(BufferedImage image,
 String prefix)

createTransparency

Transparency createTransparency()

Returns:

Returns an empty Transparency

createTransparency

Transparency createTransparency(int transparency,
 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

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

Parameters:

minimum -

maximum -

intervals -

fromColor -

toColor -

Returns:

createListColorTableClasses

List<ColorTableClass> createListColorTableClasses(double minimum,
 double maximum,
 double intervalSize,
 Color fromColor,
 Color toColor)

Parameters:

minimum -

maximum -

intervalSize -

fromColor -

toColor -

Returns:

createMakeColorTable

MakeColorTable createMakeColorTable()

Returns: