com.esri.core.tasks.ags.query
Class Query

java.lang.Object
  com.esri.core.tasks.ags.query.Query

public class Query
extends Object

Class holding the parameters of a query to be executed on the server.

In this class, you can define:

a where clause

a literal search text

a geometry to apply as the spatial filter

a spatial relationship to be applied on the input geometry

the spatial reference of the input geometry

the spatial reference of the returned geometry

if the result set must include the geometry associated with each result

the list of fields to be included in the returned result set

the object IDs of this layer / table to be queried

if the response should only include an array of object IDs or otherwise, a feature set

Constructor Summary

Query()

Method Summary

Geometry	getGeometry() Returns the geometry to apply as the spatial filter.
SpatialReference	getInSpatialReference() Returns the spatial reference of the input geometry.
double	getMaxAllowableOffset() Returns the maximum allowable offset.
int	getMaxFeatures()
int[]	getObjectIds() Returns the object IDs of this layer/table to be queried.
String[]	getOutFields() Returns the array of fields to be included in the returned result set.
SpatialReference	getOutSpatialReference() Returns the spatial reference of the returned geometry.
SpatialRelationship	getSpatialRelationship() Returns the SpatialRelationship to be applied on the input geometry.
String	getText() Returns the literal search text.
String	getWhere() Returns the where clause for the query.
boolean	isReturnGeometry() Returns true if the result set includes the geometry associated with each result.
boolean	isReturnIdsOnly() Returns true if the response only includes an array of object IDs.
boolean	isReturnM() Checks if M values are returned in geometries.
boolean	isReturnZ() Checks if Z values are returned in geometries.
void	setGeometry(Geometry geometry) Sets the geometry to apply as the spatial filter.
void	setGroupByFieldsForStatistics(String[] fieldNames) Sets the groupByFieldsForStatistics of the Query.
void	setInSpatialReference(SpatialReference inSR) Sets the spatial reference of the input geometry.
void	setMaxAllowableOffset(double maxAllowableOffset) Sets the maximum allowable offset.
void	setMaxFeatures(int maxFeatures)
void	setObjectIds(int[] objectIds) Sets the object IDs of this layer/table to be queried.
void	setOrderByFields(Map<String,OrderByFields> orderByFields) Sets the orderByFields of the Query.
void	setOutFields(String[] outFields) Sets the array of fields to be included in the returned result set.
void	setOutSpatialReference(SpatialReference outSR) Sets the spatial reference of the returned geometry.
void	setOutStatistics(OutStatistics[] outStatistics) The definitions for one or more field-based statistic to be calculated Note: outStatistics is supported on only those layers / tables that indicate suppportsStatistics is true.
void	setReturnGeometry(boolean returnGeometry) Sets if the result set should include the geometry associated with each result
void	setReturnIdsOnly(boolean returnIdsOnly) Sets if the response should only include the object IDs
void	setReturnM(boolean returnM) Sets if M values are returned in geometries.
void	setReturnZ(boolean returnZ) Sets if Z values are returned in geometries.
void	setSpatialRelationship(SpatialRelationship spatialRelationship) Sets the SpatialRelationship to be applied on the input geometry.
void	setText(String text) Sets the literal search text.
void	setWhere(String where) Sets the where clause for the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Method Detail

getWhere

public String getWhere()

Returns the where clause for the query.

Returns:

the where clause

setWhere

public void setWhere(String where)

Sets the where clause for the query.

Parameters:

where - the where clause to set

getText

public String getText()

Returns the literal search text.

Returns:

the literal search text

setText

public void setText(String text)

Sets the literal search text.

Parameters:

text - the literal search text

getGeometry

public Geometry getGeometry()

Returns the geometry to apply as the spatial filter.

Returns:

the geometry to apply as the spatial filter

setGeometry

public void setGeometry(Geometry geometry)

Sets the geometry to apply as the spatial filter.

Parameters:

geometry - the geometry to apply as the spatial filter

getSpatialRelationship

public SpatialRelationship getSpatialRelationship()

Returns the SpatialRelationship to be applied on the input geometry.

Returns:

the spatial relationship

setSpatialRelationship

public void setSpatialRelationship(SpatialRelationship spatialRelationship)

Sets the SpatialRelationship to be applied on the input geometry.

Parameters:

spatialRelationship - the spatial relationship

getOutSpatialReference

public SpatialReference getOutSpatialReference()

Returns the spatial reference of the returned geometry.

Returns:

the spatial reference of the returned geometry.

setOutSpatialReference

public void setOutSpatialReference(SpatialReference outSR)

Sets the spatial reference of the returned geometry.

Parameters:

outSpatialReference - the spatial reference of the returned geometry.

getInSpatialReference

public SpatialReference getInSpatialReference()

Returns the spatial reference of the input geometry.

Returns:

the spatial reference of the input geometry

setInSpatialReference

public void setInSpatialReference(SpatialReference inSR)

Sets the spatial reference of the input geometry.

Parameters:

inSpatialReference - the spatial reference of the input geometry

setReturnGeometry

public void setReturnGeometry(boolean returnGeometry)

Sets if the result set should include the geometry associated with each result

Parameters:

returnGeometry - true for the result set to include the geometry associated with each result

isReturnGeometry

public boolean isReturnGeometry()

Returns true if the result set includes the geometry associated with each result. The default is true.

Returns:

true if the result set includes the geometry associated with each result, false otherwise

setOutFields

public void setOutFields(String[] outFields)

Sets the array of fields to be included in the returned result set.

Parameters:

outFields - an array of field names

getOutFields

public String[] getOutFields()

Returns the array of fields to be included in the returned result set.

Returns:

an array of field names

setObjectIds

public void setObjectIds(int[] objectIds)

Sets the object IDs of this layer/table to be queried.

Parameters:

objectIds - an array of ObjectIds

getObjectIds

public int[] getObjectIds()

Returns the object IDs of this layer/table to be queried.

Returns:

the array of ObjectIDs

setReturnIdsOnly

public void setReturnIdsOnly(boolean returnIdsOnly)

Sets if the response should only include the object IDs

Parameters:

returnIdsOnly - true for the response only to include the object IDs

isReturnIdsOnly

public boolean isReturnIdsOnly()

Returns true if the response only includes an array of object IDs.

Returns:

true if the response only includes an array of object IDs, false otherwise

setMaxAllowableOffset

public void setMaxAllowableOffset(double maxAllowableOffset)

Sets the maximum allowable offset.

Parameters:

maxAllowableOffset -

getMaxAllowableOffset

public double getMaxAllowableOffset()

Returns the maximum allowable offset.

Returns:

the maximum allowable offset

getMaxFeatures

public int getMaxFeatures()

Returns:

the maxFeatures

setMaxFeatures

public void setMaxFeatures(int maxFeatures)

Parameters:

maxFeatures - the maxFeatures to set

setOrderByFields

public void setOrderByFields(Map<String,OrderByFields> orderByFields)

Sets the orderByFields of the Query. One or more field names using which the features/records need to be ordered. Use ASC or DESC, for ascending or descending order respectively, following every field to control the ordering.

Note:

• orderByFields is supported on only those layers / tables that indicate supportsAdvancedQueries is true.
• orderByFields defaults to ASC (ascending order) if "ORDER" is unspecified.

To use the default order you can set it to null:

 
    Map order = new LinkedHashMap();
    order.put("pop2007",FieldOrder.ASC);
    order.put("AVE_FAM_SZ",null);
 
 

Parameters:

orderByFields - The orderByFields to set.

setOutStatistics

public void setOutStatistics(OutStatistics[] outStatistics)

The definitions for one or more field-based statistic to be calculated Note:

• outStatistics is supported on only those layers / tables that indicate suppportsStatistics is true.
• If outStatisticFieldName is empty or missing, then map server would assign a field name to the returned statistic field. A valid field name can only contain alpha-numberic characters and an underscore.
• When using outStatistics the only other parameters that will be used are groupByFieldsForStatistics, orderByFields, text, time, and where.
• Specifying geometry, objectIds, or gdbVersion parameters would return an error.

Values: An array of statistic definitions. A statistic definition specifies the type of statistic, the field on which it is to be calculated, and the resulting output field name.

Parameters:

outStatistics - The outStatistics to set.

setGroupByFieldsForStatistics

public void setGroupByFieldsForStatistics(String[] fieldNames)

Sets the groupByFieldsForStatistics of the Query. One or more field names using which the values need to be grouped for calculating the statistics.

Note: groupByFieldsForStatistics is valid only when outStatistics parameter is used.

Parameters:

groupByFieldsForStatistics - The groupByFieldsForStatistics to set.

isReturnZ

public boolean isReturnZ()

Checks if Z values are returned in geometries.

Returns:

true, if Z values are included.

setReturnZ

public void setReturnZ(boolean returnZ)

Sets if Z values are returned in geometries.

Parameters:

returnZ - true to have Z values returned.

isReturnM

public boolean isReturnM()

Checks if M values are returned in geometries.

Returns:

true, if M values are included.

setReturnM

public void setReturnM(boolean returnM)

Sets if M values are returned in geometries.

Parameters:

returnM - true to have M values returned.