com.esri.adf.web.data.query
Class IdentifyCriteria

java.lang.Object
  com.esri.adf.web.data.query.IdentifyCriteria

All Implemented Interfaces:

QueryCriteria, Serializable

public class IdentifyCriteria
extends Object
implements QueryCriteria, Serializable

IdentifyCriteria returns map features and their attribute values based on a search location. This can be conducted on an individual layer, the top-most layer, all layers, or just on all the visible layers.

Depending on the resource type, there are different criteria handlers to fulfill the query. This class defines common elements required by all of the handlers.

See Also:

QueryCriteria, QueryCriteriaHandler, Serialized Form

Field Summary

static String

CRITERIA_TYPE Criteria Type: "Identify"

Constructor Summary

IdentifyCriteria()
Instantiates an empty object of IdentifyCriteria.

IdentifyCriteria(WebGeometry webGeometry)
Instantiates an object of IdentifyCriteria with the given geometry.

IdentifyCriteria(WebGeometry webGeometry, int tolerance)
Instantiates an object of IdentifyCriteria with the given point geometry and search tolerance.

Method Summary

String	getCriteriaType() A String representing the query type e.g.
String	getDisplayFieldName() Gets the field name which can be used in the query result as a result node title.
List<? extends LayerDefinition>	getLayerDefinitions() Returns the list of LayerDefinition used for identify.
int	getMaxRecordCount() Gets the maximum number of returning records in one query.
int	getTolerance() Returns the tolerance that used to perform identify operation.
WebGeometry	getWebGeometry(WebSpatialReference spatialReference) Gets the geometry in the given spatial reference.
boolean	isFetchResultDetails() Returns true if all the feature details e.g.
void	setDisplayFieldName(String displayFieldName) Sets the field name which can be used in the query result as a result node title.
void	setFetchResultDetails(boolean fetchResultDetails) Sets to true to return all the feature details e.g.
void	setLayerDefinitions(List<? extends LayerDefinition> layerDefinitions) Sets the list of LayerDefinition objects used for identify.
void	setMaxRecordCount(int maxRecordCount) Sets the maximum number of returning records in one query.
void	setTolerance(int tolerance) Sets the tolerance that used to perform identify operation.
void	setWebGeometry(WebGeometry webGeometry) Sets the search geometry.

Methods inherited from class java.lang.Object

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

Field Detail

CRITERIA_TYPE

public static final String CRITERIA_TYPE

Criteria Type: "Identify"

See Also:

Constant Field Values

Constructor Detail

IdentifyCriteria

public IdentifyCriteria()

Instantiates an empty object of IdentifyCriteria.

IdentifyCriteria

public IdentifyCriteria(WebGeometry webGeometry)

Instantiates an object of IdentifyCriteria with the given geometry. The valid geometry types are depended on handler implementations, most of the implementations support at least point geometry.

Parameters:

webGeometry - The valid geometry.

IdentifyCriteria

public IdentifyCriteria(WebGeometry webGeometry,
                        int tolerance)

Instantiates an object of IdentifyCriteria with the given point geometry and search tolerance. The valid geometry types are depended on handler implementations, most of the implementations support at least point geometry.

Parameters:

webGeometry - a valid

tolerance - a tolerance unit may be in pixels or in geometry's unit,which is depend on the handler's implementation.

See Also:

QueryCriteriaHandler

Method Detail

getCriteriaType

public String getCriteriaType()

Description copied from interface: QueryCriteria

A String representing the query type e.g. "Identify"

Specified by:

getCriteriaType in interface QueryCriteria

getDisplayFieldName

public String getDisplayFieldName()

Description copied from interface: QueryCriteria

Gets the field name which can be used in the query result as a result node title.

Specified by:

getDisplayFieldName in interface QueryCriteria

Returns:

the field name.

setDisplayFieldName

public void setDisplayFieldName(String displayFieldName)

Description copied from interface: QueryCriteria

Sets the field name which can be used in the query result as a result node title.

Specified by:

setDisplayFieldName in interface QueryCriteria

getTolerance

public int getTolerance()

Returns the tolerance that used to perform identify operation.

Returns:

the tolerance that used to perform identify operation.

setTolerance

public void setTolerance(int tolerance)

Sets the tolerance that used to perform identify operation.

Parameters:

tolerance - the tolerance that used to perform identify operation.

getWebGeometry

public WebGeometry getWebGeometry(WebSpatialReference spatialReference)

Gets the geometry in the given spatial reference.

Parameters:

spatialReference - the spatial reference of the return geometry.

Returns:

the geometry in the given spatial reference.

setWebGeometry

public void setWebGeometry(WebGeometry webGeometry)

Sets the search geometry. The valid geometry types are depend on query handler's implementation.

Parameters:

webGeometry - Point or other valid geometry.

isFetchResultDetails

public boolean isFetchResultDetails()

Description copied from interface: QueryCriteria

Returns true if all the feature details e.g. fields should be returned.

Specified by:

isFetchResultDetails in interface QueryCriteria

setFetchResultDetails

public void setFetchResultDetails(boolean fetchResultDetails)

Description copied from interface: QueryCriteria

Sets to true to return all the feature details e.g. fields.

Specified by:

setFetchResultDetails in interface QueryCriteria

getMaxRecordCount

public int getMaxRecordCount()

Description copied from interface: QueryCriteria

Gets the maximum number of returning records in one query.

Specified by:

getMaxRecordCount in interface QueryCriteria

Returns:

the maximum number of returning records.

setMaxRecordCount

public void setMaxRecordCount(int maxRecordCount)

Description copied from interface: QueryCriteria

Sets the maximum number of returning records in one query.

Specified by:

setMaxRecordCount in interface QueryCriteria

Parameters:

maxRecordCount - the new value.

setLayerDefinitions

public void setLayerDefinitions(List<? extends LayerDefinition> layerDefinitions)

Sets the list of LayerDefinition objects used for identify.

Parameters:

layerDefinitions - the list of layer definition objects

getLayerDefinitions

public List<? extends LayerDefinition> getLayerDefinitions()

Returns the list of LayerDefinition used for identify.

Returns:

the list of layer definition objects