edu.ucdavis.cstars.client.tasks

Class Query

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.Query

public class Query
extends com.google.gwt.core.client.JavaScriptObject

Query for input to the QueryTask. Not all query properties are required to execute a QueryTask. The query definition requires one of the following properties: queryGeometry, text, or where. Optional properties include outFields, outSpatialReference, and returnGeometry.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.SpatialRelationshipType

Method Summary

Methods

Modifier and Type	Method and Description
static Query	create() Creates a new Query object used to execute a query on the layer resource identified by the URL.
Geometry	getGeometry() The geometry to apply to the spatial filter.
com.google.gwt.core.client.JsArrayString	getGroupByFieldsForStatistics() One or more field names that will be used to group the statistics.
double	getMaxAllowableOffset() The maximum allowable offset used for generalizing geometries returned by the query operation.
com.google.gwt.core.client.JsArrayInteger	getObjectIds() A comma delimited list of ObjectIds for the features in the layer/table that you want to query.
com.google.gwt.core.client.JsArrayString	getOrderByFields() One or more field names that will be used to order the query results.
com.google.gwt.core.client.JsArrayString	getOutFields() Attribute fields to include in the FeatureSet.
SpatialReference	getOutSpatialReference() The spatial reference for the returned geometry.
com.google.gwt.core.client.JsArray<StatisticDefinition>	getOutStatistics() The definitions for one or more field-based statistic to be calculated.
java.lang.String	getRelationParam() The 'Shape Comparison Language' string to evaluate.
Query.SpatialRelationshipType	getSpatialRelationship() The spatial relationship to be applied on the input geometry while performing the query.
java.lang.String	getText() Shorthand for a where clause using "like".
TimeExtent	getTimeExtent() Time extent for the query.
java.lang.String	getWhere() A where clause for the query.
boolean	returnGeometry() If "true", each feature in the FeatureSet includes the geometry.
void	setGeometry(Geometry geometry) Set the geometry to apply to the spatial filter.
void	setGroupByFieldsForStatistics(java.lang.String[] groupByFieldsForStatistics) Set the groupByFieldsForStatistics parameter.
void	setMaxAllowableOffset(double maxAllowableOffset) Set the maximum allowable offset.
void	setObjectIds(int[] ids) Set object ids.
void	setOrderByFields(java.lang.String[] orderByFields) Set the orderByField parameter.
void	setOutFields(java.lang.String[] outFields) Set outFields for query.
void	setOutSpatialReference(SpatialReference outSpatialReference) Set the spatial reference for the query.
void	setOutStatistics(StatisticDefinition[] outStatistics) Set the outStatistics parameter.
void	setRelationParam(java.lang.String relationParam) Set the relation param for this query.
void	setReturnGeometry(boolean returnGeometry) Set the returnGeometry parameter for this query.
void	setSpatialRelationship(Query.SpatialRelationshipType spatialRelationship) Set the spatial relationship for this query.
void	setText(java.lang.String text) Set the text for this query.
void	setTimeExtent(TimeExtent timeExtent) Specify a time extent for the query.
void	setWhere(java.lang.String where) Set where clause for this query.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Query create()

Creates a new Query object used to execute a query on the layer resource identified by the URL.

Returns:

Query

getGeometry

public final Geometry getGeometry()

The geometry to apply to the spatial filter. The spatial relationship as specified by spatialRelationship is applied to this geometry while performing the query. The valid geometry types are Extent, Point, Multipoint, Polyline, or Polygon.

Returns:

Geometry

setGeometry

public final void setGeometry(Geometry geometry)

Set the geometry to apply to the spatial filter.

Parameters:

geometry - - the geometry to apply to the spatial filter. The spatial relationship as specified by spatialRelationship is applied to this geometry while performing the query. The valid geometry types are Extent, Point, Multipoint, Polyline, or Polygon.

getGroupByFieldsForStatistics

public final com.google.gwt.core.client.JsArrayString getGroupByFieldsForStatistics()

One or more field names that will be used to group the statistics. groupByFieldsForStatistics is only valid when outStatistics have been defined. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)

Returns:

JsArrayString

setGroupByFieldsForStatistics

public final void setGroupByFieldsForStatistics(java.lang.String[] groupByFieldsForStatistics)

Set the groupByFieldsForStatistics parameter.

Parameters:

groupByFieldsForStatistics - - One or more field names that will be used to group the statistics. groupByFieldsForStatistics is only valid when outStatistics have been defined. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)

getMaxAllowableOffset

public final double getMaxAllowableOffset()

The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.

Returns:

double

setMaxAllowableOffset

public final void setMaxAllowableOffset(double maxAllowableOffset)

Set the maximum allowable offset.

Parameters:

maxAllowableOffset - - the maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the map is used.

getObjectIds

public final com.google.gwt.core.client.JsArrayInteger getObjectIds()

A comma delimited list of ObjectIds for the features in the layer/table that you want to query.

Returns:

JsArrayInteger

setObjectIds

public final void setObjectIds(int[] ids)

Set object ids.

Parameters:

ids - - Array of ObjectIds for the features in the layer/table that you want to query.

getOrderByFields

public final com.google.gwt.core.client.JsArrayString getOrderByFields()

One or more field names that will be used to order the query results. Specfiy ASC (ascending) or DESC (descending) after the field name to control the order. The default order is ASC. orderByFields is only supported on dynamic layers and tables where supportsAdvancedQueries is true. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)

Returns:

JsArrayString

setOrderByFields

public final void setOrderByFields(java.lang.String[] orderByFields)

Set the orderByField parameter.

Parameters:

orderByFields - - One or more field names that will be used to order the query results. Specfiy ASC (ascending) or DESC (descending) after the field name to control the order. The default order is ASC. orderByFields is only supported on dynamic layers and tables where supportsAdvancedQueries is true. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)

getOutFields

public final com.google.gwt.core.client.JsArrayString getOutFields()

Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list the actual field names rather than the alias names. Returned fields are also the actual field names. However, you are able to use the alias names when you display the results. You can set field alias names in the map document. When you specify the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the faster the response will be. Each query must have access to the Shape and Objectid fields for a layer, but your list of fields does not need to include these two fields.

Returns:

JsArrayString

setOutFields

public final void setOutFields(java.lang.String[] outFields)

Set outFields for query.

Parameters:

outFields - - Attribute fields to include in the FeatureSet.

getOutSpatialReference

public final SpatialReference getOutSpatialReference()

The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map.

Returns:

SpatialReference

setOutSpatialReference

public final void setOutSpatialReference(SpatialReference outSpatialReference)

Set the spatial reference for the query.

Parameters:

outSpatialReference - - The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map.

getOutStatistics

public final com.google.gwt.core.client.JsArray<StatisticDefinition> getOutStatistics()

The definitions for one or more field-based statistic to be calculated. outStatistics is only supported on layers/tables where supportsStatistics is true. If outStatistics is specified the only other query parameters that will be used are groupByFieldsForStatistics, orderByFields, text, timeExtent and where. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)

Returns:

JsArray

setOutStatistics

public final void setOutStatistics(StatisticDefinition[] outStatistics)

Set the outStatistics parameter.

Parameters:

outStatistics - - The definitions for one or more field-based statistic to be calculated. outStatistics is only supported on layers/tables where supportsStatistics is true. If outStatistics is specified the only other query parameters that will be used are groupByFieldsForStatistics, orderByFields, text, timeExtent and where. Requires ArcGIS Server service version 10.1 or greater (As of v2.6)

getRelationParam

public final java.lang.String getRelationParam()

The 'Shape Comparison Language' string to evaluate. Examples of valid strings are: RELATE(G1,G2,"FFFTTT***) dim (g1.boundary,g2.boundary) = linear dim (g1.exterior, g2.boundary)= linear The string describes the spatial relationship to be tested when the spatial relationship is esriSpatialRelRelation The Shape Comparison Language EDN topic has additional details.

Returns:

String

setRelationParam

public final void setRelationParam(java.lang.String relationParam)

Set the relation param for this query.

Parameters:

relationParam - -The 'Shape Comparison Language' string to evaluate.

returnGeometry

public final boolean returnGeometry()

If "true", each feature in the FeatureSet includes the geometry. Set to "false" (default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.

Returns:

boolean

setReturnGeometry

public final void setReturnGeometry(boolean returnGeometry)

Set the returnGeometry parameter for this query.

Parameters:

returnGeometry - - If "true", each feature in the FeatureSet includes the geometry. Set to "false" (default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.

getSpatialRelationship

public final Query.SpatialRelationshipType getSpatialRelationship()

The spatial relationship to be applied on the input geometry while performing the query. Default value: SPATIAL_REL_INTERSECTS

Returns:

SpatialRelationshipType

setSpatialRelationship

public final void setSpatialRelationship(Query.SpatialRelationshipType spatialRelationship)

Set the spatial relationship for this query.

Parameters:

spatialRelationship - - The spatial relationship to be applied on the input geometry while performing the query.

getText

public final java.lang.String getText()

Shorthand for a where clause using "like". The field used is the display field defined in the map document. You can determine what the display field is for a layer in Services Directory.

Returns:

String

setText

public final void setText(java.lang.String text)

Set the text for this query.

Parameters:

text - - Shorthand for a where clause using "like". The field used is the display field defined in the map document. You can determine what the display field is for a layer in Services Directory.

getTimeExtent

public final TimeExtent getTimeExtent()

Time extent for the query.

Returns:

TimeExtent

setTimeExtent

public final void setTimeExtent(TimeExtent timeExtent)

Specify a time extent for the query.

Parameters:

timeExtent - - time extent to be used in query.

getWhere

public final java.lang.String getWhere()

A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed.

Returns:

String

setWhere

public final void setWhere(java.lang.String where)

Set where clause for this query.

Parameters:

where - - A where clause for the query. Any legal SQL where clause operating on the fields in the layer is allowed.