edu.ucdavis.cstars.client.tasks

Class RouteTask

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.RouteTask

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

Solves a route on a route layer resource in a Network Analyst service exposed by the ArcGIS Server REST API.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorHandler(ErrorHandler handler) Add event handler for errors.
void	addSolveHandler(RouteSolveHandler handler) Add event handler for solve.
static RouteTask	create(java.lang.String url) Creates a new RouteTask object.
java.lang.String	getUrl() URL to the ArcGIS Server REST resource that represents a network analysis service.
Deferred	solve(RouteParameters params) Solves the route against the route layer with the route parameters.
Deferred	solve(RouteParameters params, RouteSolveCallback callback) Solves the route against the route layer with the route parameters.

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

Creates a new RouteTask object.

Parameters:

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

Returns:

RouteTask

getUrl

public final java.lang.String getUrl()

URL to the ArcGIS Server REST resource that represents a network analysis service.

Returns:

String url.

solve

public final Deferred solve(RouteParameters params,
             RouteSolveCallback callback)

Solves the route against the route layer with the route parameters.

Parameters:

params - - Route parameters used as input to generate the route.

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

Returns:

Deferred

solve

public final Deferred solve(RouteParameters params)

Solves the route against the route layer with the route parameters.

Parameters:

params - - Route parameters used as input to generate the route.

Returns:

Deferred

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add event handler for errors.

Parameters:

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

addSolveHandler

public final void addSolveHandler(RouteSolveHandler handler)

Add event handler for solve.

Parameters:

handler - - Fires when RouteTask.solve() has completed.