com.esri.adf.web.ags.data.query
Class AGSQueryFunctionality

java.lang.Object
  com.esri.adf.web.data.query.QueryFunctionality
      com.esri.adf.web.ags.data.query.AGSQueryFunctionality

All Implemented Interfaces:

GISFunctionality, java.io.Serializable

public class AGSQueryFunctionality
extends QueryFunctionality
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

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

FUNCTIONALITY_NAME, handlers

Constructor Summary

AGSQueryFunctionality()

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
protected java.lang.String	getFieldValue(com.esri.arcgisws.PropertySetProperty[] props, java.lang.String fieldName) Returns the field value from the property set based on the specified field name
protected WebLayerInfo	getLayer(int layerId)
AGSMapFunctionality	getMapFunctionality()
java.util.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.
protected void	setDetails(com.esri.arcgisws.PropertySetProperty[] props, QueryResult result)
protected void	setHighlightGeometryAndExtent(com.esri.arcgisws.Geometry geom, QueryResult result)
protected void	setHighlightGeometryAndExtent(com.esri.arcgisws.Geometry geom, QueryResult result, com.esri.arcgisws.SpatialReference sr)

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

Constructor Detail

AGSQueryFunctionality

public AGSQueryFunctionality()

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.

Specified by:

initFunctionality in interface GISFunctionality

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.

Specified by:

destroyFunctionality in interface GISFunctionality

See Also:

GISResource.destroy()

getQueryLayers

public java.util.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.

Specified by:

getResource in interface GISFunctionality

Returns:

the GISResource associated with this functionality

setHighlightGeometryAndExtent

protected void setHighlightGeometryAndExtent(com.esri.arcgisws.Geometry geom,
                                             QueryResult result)

setHighlightGeometryAndExtent

protected void setHighlightGeometryAndExtent(com.esri.arcgisws.Geometry geom,
                                             QueryResult result,
                                             com.esri.arcgisws.SpatialReference sr)

setDetails

protected void setDetails(com.esri.arcgisws.PropertySetProperty[] props,
                          QueryResult result)

getFieldValue

protected java.lang.String getFieldValue(com.esri.arcgisws.PropertySetProperty[] props,
                                         java.lang.String fieldName)

Returns the field value from the property set based on the specified field name

Parameters:

props - the property set which has the fields and values

fieldName - the field name for which the value should be retrieved

Returns:

the field value

getLayer

protected WebLayerInfo getLayer(int layerId)

getMapFunctionality

public AGSMapFunctionality getMapFunctionality()