Package com.luciad.wmts.server

Class TLcdWMTSGetLegendGraphicRequestContext

java.lang.Object

com.luciad.wmts.server.TLcdWMTSGetLegendGraphicRequestContext

public class TLcdWMTSGetLegendGraphicRequestContext
extends Object

This class contains all information provided by the client and some additional derived information that might be useful when generating legends. The client provides the width, height and style of the requested legend.

Since:

2022.0

Method Summary

Modifier and Type	Method	Description
int	getHeight()	An optional argument which specifies the height in pixels of the graphic which will be produced.
Supplier<ILcdModel>	getModelSupplier()
TLcdSLDFeatureTypeStyle[]	getSLDFeatureTypeStyles()
String	getStyle()	The style parameter of the request.
int	getWidth()	An optional argument which specifies the width in pixels of the graphic which will be produced.
TLcdWMTSLayer	getWMTSLayer()

Methods inherited from class java.lang.Object

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

Method Details

getWidth

public int getWidth()

An optional argument which specifies the width in pixels of the graphic which will be produced.

Returns:

A positive integer specifying a width in pixels.

getHeight

public int getHeight()

An optional argument which specifies the height in pixels of the graphic which will be produced.

Returns:

A positive integer specifying a height in pixels.

getStyle

public String getStyle()

The style parameter of the request.

Returns:

String indicating the style.

getWMTSLayer

public TLcdWMTSLayer getWMTSLayer()

Returns:

the Web Map Tiled Server layer for which a legend graphic shall be created (the server's point of view).

getSLDFeatureTypeStyles

public TLcdSLDFeatureTypeStyle[] getSLDFeatureTypeStyles()

Returns:

The SLD feature styles configured on the server side which a legend graphic shall be created from (the client's point of view).

There are two options for the SLD feature styles, which contain information that can be useful with respect to the content of the legend:

• The client has specified a WMTS layer and the WMTS layer is not linked to an SLD on the server side: in this case the TLcdSLDFeatureTypeStyle[] argument is null.
• The client has specified a WMTS layer and the WMS named layer is linked to an SLD on the server side: in this case TLcdSLDFeatureTypeStyle[] arguments is defined.

getModelSupplier

public Supplier<ILcdModel> getModelSupplier()

Returns:

Provides a way to retrieve the model linked to the Web Map Server Layer, the named or user-defined SLD layer that are part of the context. We provide a Supplier instead of the ILcdModel directly for performance reasons. So unless you need information specifically related to the model, refrain from calling it.