com.esri.adf.web.wms.data.query
Class WMSQueryFunctionality

java.lang.Object
  com.esri.adf.web.data.query.QueryFunctionality
      com.esri.adf.web.wms.data.query.WMSQueryFunctionality

All Implemented Interfaces:

GISFunctionality, Serializable

public class WMSQueryFunctionality
extends QueryFunctionality

Defines query capabilities on WMS data source.

See Also:

Serialized Form

Field Summary

static short

MAX_RECORD_COUNT

Fields inherited from class com.esri.adf.web.data.query.QueryFunctionality

FUNCTIONALITY_NAME, handlers

Constructor Summary

WMSQueryFunctionality()
Instantiates an object of WMSQueryFunctionality.

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
List<WebLayerInfo>	getQueryLayers() Returns the query-able layers as a List of WebLayerInfo objects.
GISResource	getResource() Returns the GISResource associated with this functionality.
void	initFunctionality(GISResource resource) The initialization chores for the functionality must be performed in this method.
List<QueryResult>	spatialQuery(IdentifyCriteria criteria, WebQuery query, List<? extends WebLayerInfo> webLayerInfos) Gets feature info from a WMS server.

Methods inherited from class com.esri.adf.web.data.query.QueryFunctionality

addFindCriteriaHandler, find, getFindCriteriaHandlers, removeFindCriteriaHandler, setFindCriteriaHandlers

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RECORD_COUNT

public static short MAX_RECORD_COUNT

Constructor Detail

WMSQueryFunctionality

public WMSQueryFunctionality()

Instantiates an object of WMSQueryFunctionality.

Method Detail

initFunctionality

public void initFunctionality(GISResource resource)

Description copied from interface: GISFunctionality

The initialization chores for the functionality must be performed in this method. This method is called by the resource when the functionality needs to be initialized. This happens either when the resource itself is being initialized or if users add this functionality to the resource using the GISResource.addFunctionality(String, GISFunctionality) method after the resource has already been initialized.

Classes which implement this method should maintain the resource as a class instance variable and return the same in the GISFunctionality.getResource() method. The functionality is ready for use only after this method has been called.

Parameters:

resource - the GISResource that this functionality supports

See Also:

GISResource.init(WebContext)

destroyFunctionality

public void destroyFunctionality()

Description copied from interface: GISFunctionality

The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This method is called by the GISResource when the resource itself is being destroyed.

The functionality is no longer usable after this method has been called.

See Also:

GISResource.destroy()

getQueryLayers

public List<WebLayerInfo> getQueryLayers()

Description copied from class: QueryFunctionality

Returns the query-able layers as a List of WebLayerInfo objects.

Specified by:

getQueryLayers in class QueryFunctionality

Returns:

the query-able layers as a List of WebLayerInfo objects

getResource

public GISResource getResource()

Description copied from interface: GISFunctionality

Returns the GISResource associated with this functionality.

The resource passed to GISFunctionality.initFunctionality(GISResource) is maintained as a class variable and is accessible through this method.

Returns:

the GISResource associated with this functionality

spatialQuery

public List<QueryResult> spatialQuery(IdentifyCriteria criteria,
                                      WebQuery query,
                                      List<? extends WebLayerInfo> webLayerInfos)
                               throws IOException

Gets feature info from a WMS server.

Parameters:

webLayerInfos - a list of WMS layers to query.

Throws:

IOException