com.luciad.wms.client.model

LuciadLightspeedClass TLcdWMSGetFeatureInfoParameters.Builder

java.lang.Object

com.luciad.wms.client.model.TLcdWMSGetFeatureInfoParameters.Builder

Enclosing class:

TLcdWMSGetFeatureInfoParameters

public static class TLcdWMSGetFeatureInfoParameters.Builder
extends Object

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

Since:

2016.1.

Method Summary

Modifier and Type	Method and Description
TLcdWMSGetFeatureInfoParameters.Builder	all(TLcdWMSGetFeatureInfoParameters aGetFeatureInfoContext) Sets all parameters on the builder based on the given GetFeatureInfo context.
TLcdWMSGetFeatureInfoParameters	build() Builds the context with the set parameters.
TLcdWMSGetFeatureInfoParameters.Builder	featureInfoFormat(String aFeatureInfoFormat) Specifies the feature info format to use.
TLcdWMSGetFeatureInfoParameters.Builder	layersToQuery(Collection<String> aLayersToQuery) Specifies the layers to query.
TLcdWMSGetFeatureInfoParameters.Builder	maxFeatureCount(int aMaxFeatureCount) Sets the maximum number of features returned when doing a query.

Methods inherited from class java.lang.Object

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

Method Detail

featureInfoFormat

public TLcdWMSGetFeatureInfoParameters.Builder featureInfoFormat(String aFeatureInfoFormat)

Specifies the feature info format to use. If this method is not called, the query should use a fallback feature info format, see ALcdWMSProxy.getFeatureInfoFormat().

Parameters:

aFeatureInfoFormat - the feature info format to use.

Returns:

this

layersToQuery

public TLcdWMSGetFeatureInfoParameters.Builder layersToQuery(Collection<String> aLayersToQuery)

Specifies the layers to query. If this method is not called, the query should use all layers.

Parameters:

aLayersToQuery - the layers to query. These are WMS layer names, see ALcdWMSNamedLayer.getNamedLayerName().

Returns:

this

maxFeatureCount

public TLcdWMSGetFeatureInfoParameters.Builder maxFeatureCount(int aMaxFeatureCount)

Sets the maximum number of features returned when doing a query.

The default is 1.

Parameters:

aMaxFeatureCount - the maximum number of features returned when doing a query

Returns:

this

all

public TLcdWMSGetFeatureInfoParameters.Builder all(TLcdWMSGetFeatureInfoParameters aGetFeatureInfoContext)

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

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

Parameters:

aGetFeatureInfoContext - a GetFeatureInfo context

Returns:

this

build

public TLcdWMSGetFeatureInfoParameters build()

Builds the context with the set parameters.

Returns:

a context with the set parameters.