edu.ucdavis.cstars.client.tasks

Class Geoprocessor

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.Geoprocessor

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

Represents a GP Task resource exposed by the ArcGIS Server REST API. A GP Task resource represents a single task in a GP service published using the ArcGIS Server and it supports one of the following operations: "execute" - performed on a GP Task resource when the execution type is synchronous. "submitJob" - performed on an asynchronous GP Task resource.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
void	addCheckJobStatusHandler(CheckJobStatusHandler handler) Add event handler for checkJobStatus.
void	addErrorHandler(ErrorHandler handler) Add event handler for errors.
void	addExecuteHandler(GeoprocessorExecuteHandler handler) Add event handler for execute.
void	addGetResultDataHandler(GetResultDataHandler handler) Add event handler for getResultDataHandler.
void	addGetResultImageHandler(GetResultImageHandler handler) Add event handler for getResultImage
void	addGetResultImageLayerHandler(GetResultImageLayerHandler handler) Add event handler for getResultImageLayer
void	addJobHandler(GeoprocessorJobHandler handler) Add event handler for when job is complete.
void	cancelJobStatusUpdates(java.lang.String jobId) Cancels the periodic job status updates initiated automatically when submitJob() is invoked for the job identified by jobId.
void	checkJobStatus(java.lang.String jobId) Sends a request to the GP Task for the current state of the job identified by jobId.
void	checkJobStatus(java.lang.String jobId, CheckJobStatusCallback callback) Sends a request to the GP Task for the current state of the job identified by jobId.
static Geoprocessor	create(java.lang.String url) Creates a new Geoprocessor object that represents the GP Task identifed by a URL.
Deferred	execute(JSObject params) Sends a request to the server to execute a synchronous GP task.
Deferred	execute(JSObject params, GeoprocessorExecuteCallback callback) Sends a request to the server to execute a synchronous GP task.
SpatialReference	getOutputSpatialReference() Deprecated. - Use outSpatialReference instead.
SpatialReference	getOutSpatialReference() The spatial reference of the output geometries.
SpatialReference	getProcessSpatialReference() The spatial reference that the model will use to perform geometry operations.
Deferred	getResultData(java.lang.String jobId, java.lang.String parameterName) Sends a request to the GP Task to get the task result identified by jobId and resultParameterName.
Deferred	getResultData(java.lang.String jobId, java.lang.String parameterName, GetResultDataCallback callback) Sends a request to the GP Task to get the task result identified by jobId and resultParameterName.
Deferred	getResultImage(java.lang.String jobId, java.lang.String parameterName, ImageParameters parameters) Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an image.
Deferred	getResultImage(java.lang.String jobId, java.lang.String parameterName, ImageParameters parameters, GetResultImageCallback callback) Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an image.
void	getResultImageLayer(java.lang.String jobId, java.lang.String parameterName, ImageParameters parameters) Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an ArcGISDynamicMapServiceLayer.
void	getResultImageLayer(java.lang.String jobId, java.lang.String parameterName, ImageParameters parameters, GetResultImageLayerCallback callback) Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an ArcGISDynamicMapServiceLayer.
int	getUpdateDelay() The time interval in milliseconds between each job status request sent to an asynchronous GP task.
java.lang.String	getUrl() ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.
void	setOutputSpatialReference(SpatialReference spatialReference) Deprecated. - Use outSpatialReference instead.
void	setOutSpatialReference(SpatialReference outSpatialReference) Set the outSpatialReference parameter.
void	setProcessSpatialReference(SpatialReference processSpatialReference) Set the processSpatialReference parameter.
void	setUpdateDelay(int delay) Sets the time interval in milliseconds between each job status request sent to an asynchronous GP task.
void	submitJob(JSObject inputParameters) Submits a job to the server for asynchronous processing by the GP task.
void	submitJob(JSObject inputParameters, SubmitJobCallback callback) Submits a job to the server for asynchronous processing by the GP task.

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

Creates a new Geoprocessor object that represents the GP Task identifed by a URL.

Parameters:

url - - URL to the ArcGIS Server REST resource that represents a geoprocessing service.

Returns:

Geoprocessor

getOutputSpatialReference

public final SpatialReference getOutputSpatialReference()

Deprecated. - Use outSpatialReference instead.

Returns:

SpatialReference

getOutSpatialReference

public final SpatialReference getOutSpatialReference()

The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries. If processSpatialReferencew is specified and outSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference.

Returns:

SpatialReference

getProcessSpatialReference

public final SpatialReference getProcessSpatialReference()

The spatial reference that the model will use to perform geometry operations. If processSpatialReference is specified and outputSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference.

Returns:

SpatialReference

getUpdateDelay

public final int getUpdateDelay()

The time interval in milliseconds between each job status request sent to an asynchronous GP task. Default value: 1000

Returns:

int

getUrl

public final java.lang.String getUrl()

ArcGIS Server Rest API endpoint to the resource that receives the geoprocessing request.

Returns:

String

cancelJobStatusUpdates

public final void cancelJobStatusUpdates(java.lang.String jobId)

Cancels the periodic job status updates initiated automatically when submitJob() is invoked for the job identified by jobId. You can still obtain the status of this job by calling the checkStatus() method at your own discretion.

Parameters:

jobId - - A string that uniquely identifies the job for which the job updates are cancelled.

checkJobStatus

public final void checkJobStatus(java.lang.String jobId,
                  CheckJobStatusCallback callback)

Sends a request to the GP Task for the current state of the job identified by jobId. Upon receiving the response, the onStatusUpdate event is fired and the optional callback function is invoked.

Parameters:

jobId - - A string that uniquely identifies a job on the server. It is created when a job is submitted for execution and later used to check its status and retrieve the results.

callback - - The function to call when the method has completed.

checkJobStatus

public final void checkJobStatus(java.lang.String jobId)

Sends a request to the GP Task for the current state of the job identified by jobId. Upon receiving the response, the onStatusUpdate event is fired and the optional callback function is invoked.

Parameters:

jobId - - A string that uniquely identifies a job on the server. It is created when a job is submitted for execution and later used to check its status and retrieve the results.

execute

public final Deferred execute(JSObject params,
               GeoprocessorExecuteCallback callback)

Sends a request to the server to execute a synchronous GP task. On completion, the onExecuteComplete event is fired and the optional callback function is invoked.

Parameters:

params - - The inputParameters argument specifies the input parameters accepted by the task and their corresponding values.

callback - - The function to call when the method has completed.

Returns:

Deferred

execute

public final Deferred execute(JSObject params)

Sends a request to the server to execute a synchronous GP task.

Parameters:

params - - The inputParameters argument specifies the input parameters accepted by the task and their corresponding values.

Returns:

Deferred

getResultData

public final Deferred getResultData(java.lang.String jobId,
                     java.lang.String parameterName,
                     GetResultDataCallback callback)

Sends a request to the GP Task to get the task result identified by jobId and resultParameterName.

Parameters:

jobId - - The jobId returned from JobInfo.

parameterName - - The name of the result parameter as defined in Services Directory.

callback - - The function to call when the method has completed.

Returns:

Deferred

getResultData

public final Deferred getResultData(java.lang.String jobId,
                     java.lang.String parameterName)

Sends a request to the GP Task to get the task result identified by jobId and resultParameterName.

Parameters:

jobId - - The jobId returned from JobInfo.

parameterName - - The name of the result parameter as defined in Services Directory.

Returns:

Deferred

getResultImage

public final Deferred getResultImage(java.lang.String jobId,
                      java.lang.String parameterName,
                      ImageParameters parameters,
                      GetResultImageCallback callback)

Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an image.

Parameters:

jobId - - The jobId returned from JobInfo.

parameterName - - The name of the result parameter as defined in Services Directory.

parameters - - Specifies the properties of the result image.

callback - - The function to call when the method has completed.

Returns:

Deferred

getResultImage

public final Deferred getResultImage(java.lang.String jobId,
                      java.lang.String parameterName,
                      ImageParameters parameters)

Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an image.

Parameters:

jobId - - The jobId returned from JobInfo.

parameterName - - The name of the result parameter as defined in Services Directory.

parameters - - Specifies the properties of the result image.

Returns:

Deferred

getResultImageLayer

public final void getResultImageLayer(java.lang.String jobId,
                       java.lang.String parameterName,
                       ImageParameters parameters,
                       GetResultImageLayerCallback callback)

Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an ArcGISDynamicMapServiceLayer.

Parameters:

jobId - - The jobId returned from JobInfo.

parameterName - - The name of the result parameter as defined in Services Directory.

parameters - - Contains various options that can be specified when generating a dynamic map image.

callback - - The function to call when the method has completed.

getResultImageLayer

public final void getResultImageLayer(java.lang.String jobId,
                       java.lang.String parameterName,
                       ImageParameters parameters)

Sends a request to the GP Task to get the task result identified by jobId and resultParameterName as an ArcGISDynamicMapServiceLayer.

Parameters:

jobId - - The jobId returned from JobInfo.

parameterName - - The name of the result parameter as defined in Services Directory.

parameters - - Contains various options that can be specified when generating a dynamic map image.

setOutputSpatialReference

public final void setOutputSpatialReference(SpatialReference spatialReference)

Deprecated. - Use outSpatialReference instead.

Parameters:

spatialReference -

setOutSpatialReference

public final void setOutSpatialReference(SpatialReference outSpatialReference)

Set the outSpatialReference parameter.

Parameters:

outSpatialReference - - The spatial reference of the output geometries. If not specified, the output geometries are in the spatial reference of the input geometries. If processSpatialReferencew is specified and outSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference.

setProcessSpatialReference

public final void setProcessSpatialReference(SpatialReference processSpatialReference)

Set the processSpatialReference parameter.

Parameters:

processSpatialReference - - The spatial reference that the model will use to perform geometry operations. If processSpatialReference is specified and outputSpatialReference is not specified, the output geometries are in the spatial reference of the process spatial reference.

setUpdateDelay

public final void setUpdateDelay(int delay)

Sets the time interval in milliseconds between each job status request sent to an asynchronous GP task.

Parameters:

delay - - The value in milliseconds. One second equals 1000 milliseconds.

submitJob

public final void submitJob(JSObject inputParameters,
             SubmitJobCallback callback)

Submits a job to the server for asynchronous processing by the GP task. Once the job is submitted and until it is completed, the onStatusUpdate event is fired and the optional statusCallback() function is invoked at regular intervals, the duration of which is specified by the updateDelay property. Upon completion of the job, the onJobComplete event is fired and the callback function is invoked. The task execution results can be retrieved using getResultData(), getResultImage() or getResultImageLayer() methods.

Parameters:

inputParameters - - The inputParameters argument specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource.

callback - - The function to call when the method has completed and on update of status.

submitJob

public final void submitJob(JSObject inputParameters)

Submits a job to the server for asynchronous processing by the GP task. Once the job is submitted and until it is completed, the onStatusUpdate event is fired and the optional statusCallback() function is invoked at regular intervals, the duration of which is specified by the updateDelay property. Upon completion of the job, the onJobComplete event is fired and the callback function is invoked. The task execution results can be retrieved using getResultData(), getResultImage() or getResultImageLayer() methods.

Parameters:

inputParameters - - The inputParameters argument specifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource.

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add event handler for errors.

Parameters:

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

addExecuteHandler

public final void addExecuteHandler(GeoprocessorExecuteHandler handler)

Add event handler for execute.

Parameters:

handler - - Fires when a synchronous GP task is completed.

addGetResultDataHandler

public final void addGetResultDataHandler(GetResultDataHandler handler)

Add event handler for getResultDataHandler.

Parameters:

handler - - Fires when the result of an asynchronous GP task execution is available.

addGetResultImageHandler

public final void addGetResultImageHandler(GetResultImageHandler handler)

Add event handler for getResultImage

Parameters:

handler - - Fires when a map image is generated by invoking the getResultImage() method.

addGetResultImageLayerHandler

public final void addGetResultImageLayerHandler(GetResultImageLayerHandler handler)

Add event handler for getResultImageLayer

Parameters:

handler - - Fires when getResultImageLayer() has completed.

addJobHandler

public final void addJobHandler(GeoprocessorJobHandler handler)

Add event handler for when job is complete.

Parameters:

handler - - Fires when an asynchronous GP task using submitJob is complete.

addCheckJobStatusHandler

public final void addCheckJobStatusHandler(CheckJobStatusHandler handler)

Add event handler for checkJobStatus.

Parameters:

handler - - Fires when a job status update is available.