java.lang.Object | |
↳ | com.esri.core.tasks.ags.query.Query |
Class holding the parameters of a query to be executed on the server.
In this class, you can define:
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Query()
Default constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
boolean | equals(Object obj) | ||||||||||
Geometry |
getGeometry()
Returns the geometry to apply as the spatial filter.
| ||||||||||
String[] |
getGroupByFieldsForStatistics()
Gets the groupByFieldsForStatistics for Query.
| ||||||||||
SpatialReference |
getInSpatialReference()
Returns the spatial reference of the input geometry.
| ||||||||||
double |
getMaxAllowableOffset()
Returns the maximum allowable offset.
| ||||||||||
int |
getMaxFeatures()
Gets the max features.
| ||||||||||
int[] |
getObjectIds()
Returns the object IDs of this layer/table to be queried.
| ||||||||||
Map<String, OrderByFields> |
getOrderByFields()
Gets the orderByFields of the Query.
| ||||||||||
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.
| ||||||||||
OutStatistics[] |
getOutStatistics()
The definitions for one or more field-based statistic to be calculated Note:
| ||||||||||
SpatialRelationship |
getSpatialRelationship()
Returns the
spatial relationship to be applied on the input geometry. | ||||||||||
String |
getText()
Returns the literal search text.
| ||||||||||
TimeExtent |
getTimeExtent()
Gets the time extent.
| ||||||||||
String |
getWhere()
Returns the where clause for the query.
| ||||||||||
int | hashCode() | ||||||||||
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.
| ||||||||||
void |
setGeometry(Geometry geometry)
Sets the geometry to apply as the spatial filter.
| ||||||||||
void |
setGroupByFieldsForStatistics(String[] groupByFieldsForStatistics)
Sets the groupByFieldsForStatistics for 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)
Sets the max features.
| ||||||||||
void |
setObjectIds(int[] objectIds)
Sets the object IDs of this layer/table to be queried.
| ||||||||||
void |
setOrderByFields(Map<String, OrderByFields> orderByFields)
Sets the orderByFields for 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:
| ||||||||||
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 |
setSpatialRelationship(SpatialRelationship spatialRelationship)
Sets the
spatial relationship to be applied on the input geometry. | ||||||||||
void |
setText(String text)
Sets the literal search text.
| ||||||||||
void |
setTimeExtent(TimeExtent timeExtent)
Sets the time extent.
| ||||||||||
void |
setWhere(String where)
Sets the where clause for the query.
| ||||||||||
Object |
toInternalFormat()
Returns the Query in an internal format.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Default constructor.
Returns the geometry to apply as the spatial filter.
Gets the groupByFieldsForStatistics for 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.
Returns the spatial reference of the input geometry.
Returns the maximum allowable offset.
Gets the max features.
Returns the object IDs of this layer/table to be queried.
Gets 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:
Returns the array of fields to be included in the returned result set.
Returns the spatial reference of the returned geometry.
The definitions for one or more field-based statistic to be calculated Note:
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.
Returns the spatial relationship
to be applied on the input geometry.
Returns true if the result set includes the geometry associated with each result. The default is true.
Returns true if the response only includes an array of object IDs.
Sets the geometry to apply as the spatial filter.
geometry | the geometry to apply as the spatial filter |
---|
Sets the groupByFieldsForStatistics for 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.
groupByFieldsForStatistics | The groupByFieldsForStatistics to set. |
---|
Sets the spatial reference of the input geometry.
inSR | the spatial reference of the input geometry |
---|
Sets the maximum allowable offset.
maxAllowableOffset | the max allowable offset |
---|
Sets the max features.
maxFeatures | the maxFeatures to set |
---|
Sets the object IDs of this layer/table to be queried.
objectIds | an array of ObjectIds |
---|
Sets the orderByFields for 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:
null
:
Map order = new LinkedHashMap();
order.put("pop2007",FieldOrder.ASC);
order.put("AVE_FAM_SZ",null);
orderByFields | The orderByFields to set. |
---|
Sets the array of fields to be included in the returned result set.
outFields | an array of field names |
---|
Sets the spatial reference of the returned geometry.
outSR | the spatial reference of the returned geometry. |
---|
The definitions for one or more field-based statistic to be calculated Note:
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.
outStatistics | The outStatistics to set. |
---|
Sets if the result set should include the geometry associated with each result.
returnGeometry | true for the result set to include the geometry associated with each result |
---|
Sets if the response should only include the object IDs.
returnIdsOnly | true for the response only to include the object IDs |
---|
Sets the spatial relationship
to be applied on the input geometry.
spatialRelationship | the spatial relationship |
---|
Sets the literal search text.
text | the literal search text |
---|
Sets the time extent.
timeExtent | the time extent to set |
---|
Sets the where clause for the query.
where | the where clause to set |
---|