edu.ucdavis.cstars.client.tasks

Class QueryTask

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.QueryTask

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

Executes a query operation on a layer resource of a map service exposed by the ArcGIS Server REST API.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryTask.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompleteHandler(QueryTaskCompleteHandler handler) Add handler for when complete event fires.
void	addErrorHandler(ErrorHandler handler) Add handler for when error event fires.
void	addExecuteForCountCompleteHandler(QueryTaskCountHandler handler) Add handler for when count complete event fires.
void	addExecuteForIdsCompleteHandler(QueryTaskIdsHandler handler) Add handler for when execute for ids complete event fires.
void	addExecuteRelationshipQueryCompleteHandler(QueryTaskRelationshipHandler handler) Add handler for when execute relationship query complete event fires.
static QueryTask	create(java.lang.String url) Creates a new QueryTask object used to execute a query on the layer resource identified by the url
static QueryTask	create(java.lang.String url, QueryTask.Options options) Creates a new QueryTask object used to execute a query on the layer resource identified by the url
Deferred	execute(Query query) Executes a Query against an ArcGIS Server map layer.
Deferred	execute(Query query, QueryTaskCallback callback) Executes a Query against an ArcGIS Server map layer.
Deferred	executeForCount(Query query) Get a count of the number of features that satisfy the input query.
Deferred	executeForCount(Query query, QueryTaskCountCallback callback) Get a count of the number of features that satisfy the input query.
Deferred	executeForIds(Query parameters) Executes a Query against an ArcGIS Server map layer.
Deferred	executeForIds(Query parameters, QueryTaskIdsCallback callback) Executes a Query against an ArcGIS Server map layer.
Deferred	executeRelationshipQuery(Query parameters) Executes a Query against an ArcGIS Server map layer.
Deferred	executeRelationshipQuery(Query parameters, QueryTaskRelationshipCallback callback) Executes a Query against an ArcGIS Server map layer.
java.lang.String	getUrl() URL to the ArcGIS Server REST resource that represents a map service layer.

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 QueryTask create(java.lang.String url)

Creates a new QueryTask object used to execute a query on the layer resource identified by the url

Parameters:

url - - URL to the ArcGIS Server REST resource that represents a layer in a service

Returns:

QueryTask

create

public static QueryTask create(java.lang.String url,
               QueryTask.Options options)

Creates a new QueryTask object used to execute a query on the layer resource identified by the url

Parameters:

url - - URL to the ArcGIS Server REST resource that represents a layer in a service

options - - Optional parameters.

Returns:

QueryTask

getUrl

public final java.lang.String getUrl()

URL to the ArcGIS Server REST resource that represents a map service layer.

Returns:

String

execute

public final Deferred execute(Query query,
               QueryTaskCallback callback)

Executes a Query against an ArcGIS Server map layer. The result is returned as a FeatureSet. If the query is successful, the user-specified callback function is invoked with the result. A FeatureSet contains an array of Graphic features, which can be added to the map using Map.graphics.add(). This array will not be populated if no results are found.

Parameters:

query - - Specifies the attributes and spatial filter of the query.

callback - - handler to be fired upon server response.

Returns:

Deferred

execute

public final Deferred execute(Query query)

Executes a Query against an ArcGIS Server map layer. The result is returned as a FeatureSet. If the query is successful, the user-specified callback function is invoked with the result. A FeatureSet contains an array of Graphic features, which can be added to the map using Map.graphics.add(). This array will not be populated if no results are found.

Parameters:

query - - Specifies the attributes and spatial filter of the query.

Returns:

Deferred

executeForCount

public final Deferred executeForCount(Query query,
                       QueryTaskCountCallback callback)

Get a count of the number of features that satisfy the input query. Valid only for layers published using ArcGIS Server 10 SP1 or greater. Layers published with earlier versions of ArcGIS Server return an error to the error callback.

Parameters:

query - - Specify the input query object.

callback - - handler to be fired upon server response.

Returns:

Deferred

executeForCount

public final Deferred executeForCount(Query query)

Get a count of the number of features that satisfy the input query. Valid only for layers published using ArcGIS Server 10 SP1 or greater. Layers published with earlier versions of ArcGIS Server return an error to the error callback.

Parameters:

query - - Specify the input query object.

Returns:

Deferred

executeForIds

public final Deferred executeForIds(Query parameters,
                     QueryTaskIdsCallback callback)

Executes a Query against an ArcGIS Server map layer. The result is returned as an array of ints.

Parameters:

parameters - - Specifies the attributes and spatial filter of the query.

callback - - handler to be fired upon server response.

Returns:

Deferred

executeForIds

public final Deferred executeForIds(Query parameters)

Executes a Query against an ArcGIS Server map layer. The result is returned as an array of ints.

Parameters:

parameters - - Specifies the attributes and spatial filter of the query.

Returns:

Deferred

executeRelationshipQuery

public final Deferred executeRelationshipQuery(Query parameters,
                                QueryTaskRelationshipCallback callback)

Executes a Query against an ArcGIS Server map layer.

Parameters:

parameters - - Specifies the attributes and spatial filter of the query.

callback - - handler to be fired upon server response.

Returns:

Deferred

executeRelationshipQuery

public final Deferred executeRelationshipQuery(Query parameters)

Executes a Query against an ArcGIS Server map layer.

Parameters:

parameters - - Specifies the attributes and spatial filter of the query.

Returns:

Deferred

addCompleteHandler

public final void addCompleteHandler(QueryTaskCompleteHandler handler)

Add handler for when complete event fires.

Parameters:

handler - - Fires when the query operation is complete.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add handler for when error event fires.

Parameters:

handler - - Fires when an error occurs when executing the task.

addExecuteForCountCompleteHandler

public final void addExecuteForCountCompleteHandler(QueryTaskCountHandler handler)

Add handler for when count complete event fires.

Parameters:

handler - - Fires when the query for the count is complete. This event is only available for layers published using ArcGIS Server 10 SP1 or later.

addExecuteForIdsCompleteHandler

public final void addExecuteForIdsCompleteHandler(QueryTaskIdsHandler handler)

Add handler for when execute for ids complete event fires.

Parameters:

handler - - Fires when the query on IDs is complete.

addExecuteRelationshipQueryCompleteHandler

public final void addExecuteRelationshipQueryCompleteHandler(QueryTaskRelationshipHandler handler)

Add handler for when execute relationship query complete event fires.

Parameters:

handler - - Fires when the executeRelationshipQuery is complete