Class SLDColorMapBuilder
LinearColorMap
using elements from RasterSymbolizer
ColorMapTransform
element.
This class is not intended to be thread safe.
- Author:
- Simone Giannecchini, GeoSolutions
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for theSLDColorMapBuilder
class.SLDColorMapBuilder
(String name) Constructor for theSLDColorMapBuilder
class. -
Method Summary
Modifier and TypeMethodDescriptionaddColorMapEntry
(ColorMapEntry colorMapEntry) addValueToPreserve
(double value) Add a value that we should try to preserve while applying the color map.LinearColorMap
boolean
Getter of the property extendedColorsint
Retrieves theLinearColorMap.LinearColorMapType
for thisSLDColorMapBuilder
.int
Getter of the property numberColorMapEntriesint
Getter of the property numberOfColorMapElementsdouble[]
Retrieves the values to preserve.setColorForValuesToPreserve
(Color color) Set the color to use for the values we want to preserve.setExtendedColors
(boolean extendedColors) Setter of the property extendedColorsvoid
setGapsColor
(Color defaultColor) Sets the defaultColor
to use when a value falls outside the range of values for provided color map elements.setLinearColorMapType
(int colorMapType) Sets theLinearColorMap.LinearColorMapType
for thisSLDColorMapBuilder
.setNumberColorMapEntries
(int numberColorMapEntries) Setter of the property numberColorMapEntries
-
Field Details
-
defaultColorForValuesToPreserve
-
defaultGapsColor
Default color to fill gaps.*
-
-
Constructor Details
-
SLDColorMapBuilder
public SLDColorMapBuilder()Default constructor for theSLDColorMapBuilder
class. -
SLDColorMapBuilder
Constructor for theSLDColorMapBuilder
class.- Parameters:
name
- name for theLinearColorMap
we will create at the end of this process.
-
-
Method Details
-
setGapsColor
Sets the defaultColor
to use when a value falls outside the range of values for provided color map elements.Note that once the underlying colormap has been built this method will throw an
IllegalStateException
if invoked.In case one would want to unset the default color, he should simply call this method with a
null
value.- Parameters:
defaultColor
- The defaultColor
to use when a value falls outside the provided color map elements.- UML property:
- name="gapsColor"
-
setLinearColorMapType
Sets theLinearColorMap.LinearColorMapType
for thisSLDColorMapBuilder
.- Returns:
- this
SLDColorMapBuilder
. - See Also:
-
LinearColorMap.LinearColorMapType
- UML property:
- name="linearColorMapType"
-
getLinearColorMapType
public int getLinearColorMapType()Retrieves theLinearColorMap.LinearColorMapType
for thisSLDColorMapBuilder
.-1
is returned in case theLinearColorMap.LinearColorMapType
is still unspecified.- Returns:
- the
LinearColorMap.LinearColorMapType
for thisSLDColorMapBuilder
or-1
case theLinearColorMap.LinearColorMapType
is still unspecified. - UML property:
- name="linearColorMapType"
-
addColorMapEntry
-
getValuesToPreserve
public double[] getValuesToPreserve()Retrieves the values to preserve.- Returns:
- an array of double which represents the values that need to be preserved by the
ColorMapTransform
we will create.
-
addValueToPreserve
Add a value that we should try to preserve while applying the color map.This means that all the values we add using this method will be mapped to the same color which can be set using
setColorForValuesToPreserve(Color)
.- Returns:
- this
SLDColorMapBuilder
.
-
setColorForValuesToPreserve
Set the color to use for the values we want to preserve.- Returns:
- this
SLDColorMapBuilder
.
-
getColorForValuesToPreserve
- Returns:
-
getExtendedColors
public boolean getExtendedColors()Getter of the property extendedColors- Returns:
- Returns the extendedColors.
- UML property:
- name="extendedColors"
-
setExtendedColors
Setter of the property extendedColorsUnless this property is set prior to start working with this
SLDColorMapBuilder
we will make use of only 256 colors. If we use extended colors, then we'll be able to use up to 65536 colors.Note that this imposes a limitation on the maximum number of
ColorMapEntry
we can use.- Parameters:
extendedColors
- The extendedColors to set.- UML property:
- name="extendedColors"
-
getNumberColorMapEntries
public int getNumberColorMapEntries()Getter of the property numberColorMapEntries- Returns:
- Returns the numberColorMapEntries.
- UML property:
- name="numberColorMapEntries"
-
setNumberColorMapEntries
Setter of the property numberColorMapEntries- Parameters:
numberColorMapEntries
- The numberColorMapEntries to set.- UML property:
- name="numberColorMapEntries"
-
getNumberOfColorMapElements
public int getNumberOfColorMapElements()Getter of the property numberOfColorMapElements- Returns:
- Returns the numberOfColorMapElements.
- UML property:
- name="numberOfColorMapElements"
-
buildLinearColorMap
public LinearColorMap buildLinearColorMap()
-