Package com.luciad.ogc.sld.model

Class TLcdSLDRasterSymbolizer.Builder<T>

java.lang.Object

com.luciad.ogc.sld.model.TLcdSLDRasterSymbolizer.Builder<T>

Enclosing class:

TLcdSLDRasterSymbolizer

public static class TLcdSLDRasterSymbolizer.Builder<T>
extends Object

A builder for SLD raster symbolizers.

Since:

2012.1

Method Summary

Modifier and Type	Method	Description
TLcdSLDRasterSymbolizer.Builder<T>	addColorMapEntry(Color aColor, double aValue)	Adds an entry to the color map of this symbolizer.
T	buildSymbolizer()	Builds the symbolizer with the set parameters.
TLcdSLDRasterSymbolizer.Builder<T>	colorMap(TLcdSLDColorMap aColorMap)	Sets the color map of this symbolizer.
TLcdSLDRasterSymbolizer.Builder<T>	gammaValue(double aGammaValue)	Sets the gamma value of this raster symbolizer.
TLcdSLDRasterSymbolizer.Builder<T>	geometry(TLcdOGCFunction aGeometryFunction)	Specifies the geometry that is styled by this symbolizer.
TLcdSLDRasterSymbolizer.Builder<T>	geometry(TLcdOGCPropertyName aGeometry)	Specifies the geometry that is styled by this symbolizer.
TLcdSLDRasterSymbolizer.Builder<T>	geometry(TLcdSLDGeometry aGeometry)	Sets the geometry of the symbolizer.
TLcdSLDRasterSymbolizer.Builder<T>	opacity(double aOpacity)	Sets the opacity of this raster symbolizer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

opacity

public TLcdSLDRasterSymbolizer.Builder<T> opacity(double aOpacity)

Sets the opacity of this raster symbolizer. If not set, an opacity of 1.0 will be used when building the symbolizer.

Parameters:

aOpacity - An opacity between 0.0 and 1.0

Returns:

This builder

gammaValue

public TLcdSLDRasterSymbolizer.Builder<T> gammaValue(double aGammaValue)

Sets the gamma value of this raster symbolizer. If not set, a gamma value of 1.0 will be used when building the symbolizer.

A value of 1.0 (the default) leaves the contrast unchanged. A value larger than 1.0 enhances the contrast of dark colors by making them brighter, while a value smaller than 1.0 enhances the contrast of bright colors by making them darker.

Parameters:

aGammaValue - A gamma value >= 0.0.

Returns:

This builder

Since:

2016.1

addColorMapEntry

public TLcdSLDRasterSymbolizer.Builder<T> addColorMapEntry(Color aColor,
 double aValue)

Adds an entry to the color map of this symbolizer. If no entries are specified, then there will be no color map.

This method must not be called when colorMap(TLcdSLDColorMap) has already been called.

Parameters:

aColor - The color that maps to aValue

aValue - A value in the domain of the raster data that will be styled

Returns:

This builder

colorMap

public TLcdSLDRasterSymbolizer.Builder<T> colorMap(TLcdSLDColorMap aColorMap)

Sets the color map of this symbolizer. If no color map is specified, then there will be no color map.

This method must not be called when addColorMapEntry(java.awt.Color, double) has already been called.

Parameters:

aColorMap - The color map. Must not be null

Returns:

This builder

geometry

public TLcdSLDRasterSymbolizer.Builder<T> geometry(TLcdOGCPropertyName aGeometry)

Specifies the geometry that is styled by this symbolizer.

This method must not be called when geometry(TLcdSLDGeometry) or geometry(TLcdOGCFunction) has already been called.

Parameters:

aGeometry - A property name that points to a compatible geometry. Must not be null

Returns:

this builder

See Also:

• TLcdOGCFilterFactory.property(TLcdDataType, com.luciad.datamodel.TLcdDataProperty...)

geometry

public TLcdSLDRasterSymbolizer.Builder<T> geometry(TLcdOGCFunction aGeometryFunction)

Specifies the geometry that is styled by this symbolizer.

This method must not be called when geometry(TLcdSLDGeometry) or geometry(TLcdOGCPropertyName) has already been called.

Parameters:

aGeometryFunction - A function that determines a compatible geometry. Must not be null

Returns:

this builder

Since:

2020.1

See Also:

• TLcdOGCFilterFactory.function(String, ILcdOGCExpression...)

geometry

public TLcdSLDRasterSymbolizer.Builder<T> geometry(TLcdSLDGeometry aGeometry)

Sets the geometry of the symbolizer.

This method must not be called when geometry(TLcdOGCPropertyName) or geometry(TLcdOGCFunction) has already been called.

Parameters:

aGeometry - The geometry. Must not be null

Returns:

This builder.

buildSymbolizer

public T buildSymbolizer()

Builds the symbolizer with the set parameters.

This method can only be called once. When you used the builder to build an instance, the builder is no longer valid and should be thrown away.

Returns:

the resulting symbolizer