com.luciad.wms.client.model

LuciadLightspeedClass TLcdWMSGetMapContext.Builder

java.lang.Object

com.luciad.wms.client.model.TLcdWMSGetMapContext.Builder

Enclosing class:

TLcdWMSGetMapContext

public static class TLcdWMSGetMapContext.Builder
extends Object

Builder class for TLcdWMSGetMapContext objects. Use TLcdWMSGetMapContext.newBuilder() to create an instance of this builder.

Since:

2016.1.

Method Summary

Modifier and Type	Method and Description
TLcdWMSGetMapContext.Builder	all(TLcdWMSGetMapContext aGetMapContext) Sets all parameters on the builder based on the given GetMap context.
TLcdWMSGetMapContext.Builder	backgroundColor(Color aBackgroundColor) Specifies the background color to use for the map.
TLcdWMSGetMapContext	build() Builds the context with the set parameters.
TLcdWMSGetMapContext.Builder	imageSize(int aWidth, int aHeight) Specifies the size of the returned image for the GetMap request.
TLcdWMSGetMapContext.Builder	mapBounds(ILcdBounds aMapBounds) Specifies the area of interest, specified in the map reference of the map to be returned.
TLcdWMSGetMapContext.Builder	mapReference(ILcdXYWorldReference aMapReference) Specifies the reference in which the map content should be returned.
TLcdWMSGetMapContext.Builder	mapRotation(Double aRotation) Specifies the rotation to use for the map.

Methods inherited from class java.lang.Object

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

Method Detail

imageSize

public TLcdWMSGetMapContext.Builder imageSize(int aWidth,
                                              int aHeight)

Specifies the size of the returned image for the GetMap request. This parameter is mandatory.

Parameters:

aWidth - the width of the returned map image

aHeight - the width of the returned map image

Returns:

this

mapReference

public TLcdWMSGetMapContext.Builder mapReference(ILcdXYWorldReference aMapReference)

Specifies the reference in which the map content should be returned. This parameter is mandatory.

Parameters:

aMapReference - the reference in which the map content should be returned.

Returns:

this

mapBounds

public TLcdWMSGetMapContext.Builder mapBounds(ILcdBounds aMapBounds)

Specifies the area of interest, specified in the map reference of the map to be returned. This parameter is mandatory.

Parameters:

aMapBounds - he area of interest, specified in the reference of the map to be returned.

Returns:

this

mapRotation

public TLcdWMSGetMapContext.Builder mapRotation(Double aRotation)

Specifies the rotation to use for the map. Note that this parameter requires support for map rotations in the WMS server by means of the angle request parameter. The default value is null, indicating that the rotation is applied in the WMS client, after the map is retrieved from the WMS server.

Parameters:

aRotation - the rotation to use for the map

Returns:

this

Since:

2022.0

backgroundColor

public TLcdWMSGetMapContext.Builder backgroundColor(Color aBackgroundColor)

Specifies the background color to use for the map. This parameter is mandatory.

Parameters:

aBackgroundColor - the background color to use for the map

Returns:

this

all

public TLcdWMSGetMapContext.Builder all(TLcdWMSGetMapContext aGetMapContext)

Sets all parameters on the builder based on the given GetMap context.

This is useful for example to create a new context that has almost all properties equal to another context.

Parameters:

aGetMapContext - a GetMap context

Returns:

this

build

public TLcdWMSGetMapContext build()

Builds the context with the set parameters.

Returns:

a context with the set parameters.