Package com.luciad.ogc.sld.model

Class TLcdSLDLineSymbolizer.Builder<T>

java.lang.Object

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

Enclosing class:

TLcdSLDLineSymbolizer

public static class TLcdSLDLineSymbolizer.Builder<T>
extends Object

A builder for SLD line symbolizers.

Since:

2012.1

Method Summary

Modifier and Type	Method	Description
T	buildSymbolizer()	Builds the symbolizer with the set parameters.
TLcdSLDLineSymbolizer.Builder<T>	color(ILcdOGCExpression aColorExpression)	Specifies an OGC expression to use for the outline color.
TLcdSLDLineSymbolizer.Builder<T>	color(Color aColor)	Specifies the outline color.
TLcdSLDLineSymbolizer.Builder<T>	dashArray(int... aDashPattern)	Specifies the dash array of the stroke.
TLcdSLDLineSymbolizer.Builder<T>	dashArray(String aDashPattern)	Specifies the dash array of the stroke.
TLcdSLDLineSymbolizer.Builder<T>	geometry(TLcdOGCFunction aGeometryFunction)	Specifies the geometry that is styled by this symbolizer.
TLcdSLDLineSymbolizer.Builder<T>	geometry(TLcdOGCPropertyName aGeometry)	Specifies the geometry that is styled by this symbolizer.
TLcdSLDLineSymbolizer.Builder<T>	geometry(TLcdSLDGeometry aGeometry)	Sets the geometry of the symbolizer.
TLcdSLDGraphic.Builder<TLcdSLDLineSymbolizer.Builder<T>>	graphic()	Returns a builder for the graphic that should be used for the stroke.
TLcdSLDLineSymbolizer.Builder<T>	graphic(TLcdSLDGraphic aGraphic)	Sets the graphic that should be used for the stroke.
TLcdSLDLineSymbolizer.Builder<T>	metre()	Sets the unit of measure for this symbolizer to metre.
TLcdSLDLineSymbolizer.Builder<T>	opacity(double aOpacity)	Sets the opacity for the stroke.
TLcdSLDLineSymbolizer.Builder<T>	perpendicularOffset(double aOffset)	Sets the perpendicular offset from the original geometry at which the line should be drawn.
TLcdSLDLineSymbolizer.Builder<T>	stroke(TLcdSLDStroke aStroke)	Sets the stroke which will be used for the outline.
TLcdSLDLineSymbolizer.Builder<T>	width(double aWidth)	Specifies the outline width.
TLcdSLDLineSymbolizer.Builder<T>	width(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

geometry

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

metre

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

perpendicularOffset

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

Sets the perpendicular offset from the original geometry at which the line 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

stroke

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

Sets the stroke which will be used for the outline.

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

Parameters:

aStroke - The stroke. Must not be null.

Returns:

This builder

opacity

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

Sets the opacity for the stroke.

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

Parameters:

aOpacity - An opacity between 0.0 and 1.0.

Returns:

This builder

width

public TLcdSLDLineSymbolizer.Builder<T> width(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 stroke(TLcdSLDStroke) has already been called.

Parameters:

aWidth - The width. Must be greater than zero.

Returns:

This builder

width

public TLcdSLDLineSymbolizer.Builder<T> width(double 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 stroke(TLcdSLDStroke) has already been called.

Parameters:

aWidth - The width. Must be greater than zero.

Returns:

This builder

Since:

2022.1

color

public TLcdSLDLineSymbolizer.Builder<T> color(Color aColor)

Specifies the outline color.

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

Parameters:

aColor - Outline color. Must not be null.

Returns:

This builder

color

public TLcdSLDLineSymbolizer.Builder<T> color(ILcdOGCExpression aColorExpression)

Specifies an OGC expression to use for the outline color.

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

Parameters:

aColorExpression - An OGC expression that evaluates to a color. Must not be null.

Returns:

This builder

dashArray

public TLcdSLDLineSymbolizer.Builder<T> dashArray(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 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.

Returns:

This builder

dashArray

public TLcdSLDLineSymbolizer.Builder<T> dashArray(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 graphic(TLcdSLDGraphic) 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.

Returns:

This builder

Since:

2013.0

graphic

public TLcdSLDGraphic.Builder<TLcdSLDLineSymbolizer.Builder<T>> graphic()

Returns a builder for the graphic that should be used for the stroke.

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

Returns:

a builder for a TLcdSLDGraphic

graphic

public TLcdSLDLineSymbolizer.Builder<T> graphic(TLcdSLDGraphic aGraphic)

Sets the graphic that should be used for the stroke.

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

Parameters:

aGraphic - The graphic. 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