com.luciad.wms.client.model

LuciadLightspeedClass TLcdWMSGetFeatureInfoParameters

java.lang.Object

com.luciad.wms.client.model.TLcdWMSGetFeatureInfoParameters

public final class TLcdWMSGetFeatureInfoParameters
extends Object

This class contains optional parameters for a WMS GetFeatureInfo request. See TLcdWMSGetFeatureInfoContext.

Since:

2016.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdWMSGetFeatureInfoParameters.Builder Builder class for TLcdWMSGetFeatureInfoParameters objects.

Method Summary

Modifier and Type	Method and Description
TLcdWMSGetFeatureInfoParameters.Builder	asBuilder() Returns this object as a Builder.
String	getFeatureInfoFormat() Returns the feature info format to use when doing a query.
Collection<String>	getLayersToQuery() Returns a list of layers to query.
int	getMaxFeatureCount() Returns the maximum number of features to return in the query result.
static TLcdWMSGetFeatureInfoParameters.Builder	newBuilder() Returns a new builder for GetFeatureInfo parameters.

Methods inherited from class java.lang.Object

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

Method Detail

getLayersToQuery

public Collection<String> getLayersToQuery()

Returns a list of layers to query. If null, all layers are queried. Otherwise only the specified layers are queried.

Returns:

a list of layers to query.

getFeatureInfoFormat

public String getFeatureInfoFormat()

Returns the feature info format to use when doing a query. If null, a default feature info format should be used (ALcdWMSProxy.getFeatureInfoFormat()) . Otherwise the specified feature info format should be used. If this feature info format is not supported, the query will return an empty result.

Returns:

the feature info format to use when doing a query.

getMaxFeatureCount

public int getMaxFeatureCount()

Returns the maximum number of features to return in the query result.

Returns:

the maximum number of features to return in the query result.

newBuilder

public static TLcdWMSGetFeatureInfoParameters.Builder newBuilder()

Returns a new builder for GetFeatureInfo parameters.

Returns:

a new builder

asBuilder

public TLcdWMSGetFeatureInfoParameters.Builder asBuilder()

Returns this object as a Builder.

Returns:

this object as a Builder.