Package com.luciad.ogc.sld.model

Class TLcdSLDPolygonSymbolizer.Builder<T>

java.lang.Object

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

Enclosing class:

TLcdSLDPolygonSymbolizer

public static class TLcdSLDPolygonSymbolizer.Builder<T>
extends Object

A builder for SLD polygon symbolizers.

Since:

2012.1

Method Summary

Modifier and Type	Method	Description
T	buildSymbolizer()	Builds the symbolizer with the set parameters.
TLcdSLDPolygonSymbolizer.Builder<T>	fill(TLcdSLDFill aFill)	Specifies the fill to use.
TLcdSLDPolygonSymbolizer.Builder<T>	fillColor(ILcdOGCExpression aColorExpression)	Specifies an OGC expression to use for the fill color.
TLcdSLDPolygonSymbolizer.Builder<T>	fillColor(Color aColor)	Specifies the fill color for this symbolizer.
TLcdSLDGraphic.Builder<TLcdSLDPolygonSymbolizer.Builder<T>>	fillGraphic()	Returns a builder for the graphic that should be used by the polygon symbolizer.
TLcdSLDPolygonSymbolizer.Builder<T>	fillGraphic(TLcdSLDExternalGraphic aExternalGraphic)	Specifies an external graphic that is to be used as a fill.
TLcdSLDPolygonSymbolizer.Builder<T>	fillOpacity(double aOpacity)	Sets the opacity for the fill.
TLcdSLDPolygonSymbolizer.Builder<T>	geometry(TLcdOGCFunction aGeometryFunction)	Specifies the geometry that is styled by this symbolizer.
TLcdSLDPolygonSymbolizer.Builder<T>	geometry(TLcdOGCPropertyName aGeometry)	Specifies the geometry that is styled by this symbolizer.
TLcdSLDPolygonSymbolizer.Builder<T>	geometry(TLcdSLDGeometry aGeometry)	Sets the geometry of the symbolizer.
TLcdSLDPolygonSymbolizer.Builder<T>	metre()	Sets the unit of measure for this symbolizer to metre.
TLcdSLDPolygonSymbolizer.Builder<T>	noFill()	Specifies that no fill should be used.
TLcdSLDPolygonSymbolizer.Builder<T>	noStroke()	Specifies that no outline should be used.
TLcdSLDPolygonSymbolizer.Builder<T>	perpendicularOffset(double aOffset)	Sets the perpendicular offset from the original geometry at which the polygon should be drawn.
TLcdSLDPolygonSymbolizer.Builder<T>	stroke(TLcdSLDStroke aStroke)	Sets the stroke which will be used for the outline.
TLcdSLDPolygonSymbolizer.Builder<T>	strokeColor(ILcdOGCExpression aStrokeColorExpression)	Specifies an OGC expression to use for the outline color.
TLcdSLDPolygonSymbolizer.Builder<T>	strokeColor(Color aColor)	Specifies the outline color.
TLcdSLDPolygonSymbolizer.Builder<T>	strokeDashArray(int... aDashPattern)	Specifies the dash array of the stroke.
TLcdSLDPolygonSymbolizer.Builder<T>	strokeDashArray(String aDashPattern)	Specifies the dash array of the stroke.
TLcdSLDPolygonSymbolizer.Builder<T>	strokeOpacity(double aOpacity)	Sets the opacity for the stroke.
TLcdSLDPolygonSymbolizer.Builder<T>	strokeWidth(int aWidth)	Specifies the outline width.

Methods inherited from class java.lang.Object

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

Method Details

noFill

public TLcdSLDPolygonSymbolizer.Builder<T> noFill()

Specifies that no fill should be used. This allows for example to only show an outline without the fill.

This method must not be called when any of the other fill methods has already been called.

Returns:

This builder

fill

public TLcdSLDPolygonSymbolizer.Builder<T> fill(TLcdSLDFill aFill)

Specifies the fill to use.

This method must not be called when noFill() or any of the other fill methods has already been called.

Parameters:

aFill - A valid fill. Must not be null. Use noFill() when you want to disable the fill

Returns:

This builder

fillGraphic

public TLcdSLDPolygonSymbolizer.Builder<T> fillGraphic(TLcdSLDExternalGraphic aExternalGraphic)

Specifies an external graphic that is to be used as a fill. External graphics can be created using a TLcdSLDGraphic.Builder.

When this method is used in combination with the fillOpacity(double) and/or the fillColor(java.awt.Color), the color and opacity will be used as modulation color for the graphic.

This method must not be called when noFill(), fill(TLcdSLDFill) or fillGraphic() has already been called.

Parameters:

aExternalGraphic - The external graphic. Must not be null. Use noFill() when you want to disable the fill

Returns:

This builder

fillGraphic

public TLcdSLDGraphic.Builder<TLcdSLDPolygonSymbolizer.Builder<T>> fillGraphic()

Returns a builder for the graphic that should be used by the polygon symbolizer. End creation of the graphic by calling TLcdSLDGraphic.Builder.buildGraphic() to return to this polygon symbolizer builder.

When this method is used in combination with the fillOpacity(double) and/or the fillColor(java.awt.Color), the color and opacity will be used as modulation color for the graphic.

This method must not be called when noFill(), fill(TLcdSLDFill) or fillGraphic(TLcdSLDExternalGraphic) has already been called.

Returns:

a builder for a TLcdSLDGraphic

See Also:

• TLcdSLDGraphic.newBuilder()

fillColor

public TLcdSLDPolygonSymbolizer.Builder<T> fillColor(ILcdOGCExpression aColorExpression)

Specifies an OGC expression to use for the fill color.

This method must not be called when noFill(), fill(TLcdSLDFill), fillColor(java.awt.Color) has already been called.

Parameters:

aColorExpression - An OGC expression that evaluates to a color. Must not be null. Use noFill() when you want to disable the fill

Returns:

This builder

fillColor

public TLcdSLDPolygonSymbolizer.Builder<T> fillColor(Color aColor)

Specifies the fill color for this symbolizer.

When this method is used in combination with the fillGraphic() or fillGraphic(TLcdSLDExternalGraphic) method, the fill color and opacity will be used as modulation color for the graphic.

This method must not be called when noFill(), fill(TLcdSLDFill), fillColor(ILcdOGCExpression) has already been called.

Parameters:

aColor - the fill color. Must not be null. Use noFill() when you want to disable the fill

Returns:

This builder

fillOpacity

public TLcdSLDPolygonSymbolizer.Builder<T> fillOpacity(double aOpacity)

Sets the opacity for the fill.

When this method is used in combination with the fillGraphic() or fillGraphic(TLcdSLDExternalGraphic) method, the fill color and opacity will be used as modulation color for the graphic.

This method must not be called when noFill() or fill(TLcdSLDFill) has already been called.

Parameters:

aOpacity - An opacity between 0.0 and 1.0.

Returns:

This builder

noStroke

public TLcdSLDPolygonSymbolizer.Builder<T> noStroke()

Specifies that no outline should be used. This allows to show only a fill without an outline.

This method must not be called when any of the other stroke methods has already been called.

Returns:

This builder

stroke

public TLcdSLDPolygonSymbolizer.Builder<T> stroke(TLcdSLDStroke aStroke)

Sets the stroke which will be used for the outline.

This method must not be called when noStroke() or any of the other stroke methods has already been called.

Parameters:

aStroke - The stroke. Must not be null. Use noStroke() if you do not want an outline

Returns:

This builder

strokeOpacity

public TLcdSLDPolygonSymbolizer.Builder<T> strokeOpacity(double aOpacity)

Sets the opacity for the stroke.

This method must not be called when noStroke() or stroke(TLcdSLDStroke) has already been called.

Parameters:

aOpacity - An opacity between 0.0 and 1.0.

Returns:

This builder

strokeWidth

public TLcdSLDPolygonSymbolizer.Builder<T> strokeWidth(int aWidth)

Specifies the outline width. By default this is specified in pixels. Use the metre() method to switch the unit of measure to metres.

This method must not be called when noStroke() or stroke(TLcdSLDStroke) has already been called.

Parameters:

aWidth - The width. Must be greater than zero. Use noStroke() when you do not want an outline

Returns:

This builder

perpendicularOffset

public TLcdSLDPolygonSymbolizer.Builder<T> perpendicularOffset(double aOffset)

Sets the perpendicular offset from the original geometry at which the polygon should be drawn. By default, this offset is interpreted as a distance in pixels. Use the metre() method to switch the unit of measure to metres.

Parameters:

aOffset - A valid offset.

Returns:

this builder

Since:

2022.1

strokeColor

public TLcdSLDPolygonSymbolizer.Builder<T> strokeColor(ILcdOGCExpression aStrokeColorExpression)

Specifies an OGC expression to use for the outline color.

This method must not be called when noStroke(), stroke(TLcdSLDStroke) or strokeColor(java.awt.Color) has already been called.

Parameters:

aStrokeColorExpression - An OGC expression that evaluates to a color. Must not be null. Use noStroke() when you do not want an outline

Returns:

This builder

strokeColor

public TLcdSLDPolygonSymbolizer.Builder<T> strokeColor(Color aColor)

Specifies the outline color.

This method must not be called when noStroke() or stroke(TLcdSLDStroke) has already been called.

Parameters:

aColor - Outline color. Must not be null. Use noStroke() when you do not want an outline

Returns:

This builder

strokeDashArray

public TLcdSLDPolygonSymbolizer.Builder<T> strokeDashArray(String aDashPattern)

Specifies the dash array of the stroke. The aDashPattern parameter should contain alternating dash lengths and gap lengths, in pixels, separated by spaces. For example: "6 3 4 3"

Note that the dash pattern may impact the performance when using a TLspSLDStyler. Using patterns with a total length of 2, 4, 8 or 16 is encouraged.

This method must not be called when noStroke() or stroke(TLcdSLDStroke) has already been called.

Parameters:

aDashPattern - The pattern for the dash array. Alternates between dash lengths and gap lengths, in pixels, separated by spaces. Must not be null. Use noStroke() when you do not want an outline

Returns:

This builder

strokeDashArray

public TLcdSLDPolygonSymbolizer.Builder<T> strokeDashArray(int... aDashPattern)

Specifies the dash array of the stroke. The aDashPattern parameter should contain alternating dash lengths and gap lengths, in pixels. For example: "6 3 4 3"

Note that the dash pattern may impact the performance when using a TLspSLDStyler. Using patterns with a total length of 2, 4, 8 or 16 is encouraged.

This method must not be called when noStroke() or stroke(TLcdSLDStroke) has already been called.

Parameters:

aDashPattern - The pattern for the dash array. Alternates between dash lengths and gap lengths, in pixels. Must not be null . Use noStroke() when you do not want an outline

Returns:

This builder

Since:

2013.0

metre

public TLcdSLDPolygonSymbolizer.Builder<T> metre()

Sets the unit of measure for this symbolizer to metre. The unit of measure is applied to the width of the stroke. The default uom is pixels.

Returns:

This builder

geometry

public TLcdSLDPolygonSymbolizer.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 TLcdSLDPolygonSymbolizer.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 TLcdSLDPolygonSymbolizer.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