public final class

RouteTask

extends Object
implements RemoteResource Loadable
java.lang.Object
   ↳ com.esri.arcgisruntime.tasks.networkanalysis.RouteTask

Class Overview

A task to compute routes and turn-by-turn directions.

The RouteTask can be used in both online and offline workflows. To solve routes using an ArcGIS Network Analyst service hosted on ArcGIS Online or on-premises with ArcGIS for Server, create a RouteTask by passing in the URL of the service to the RouteTask(String) constructor. Create a set of default parameters RouteParameters for solving a route with this RouteTask by calling createDefaultParametersAsync(). Get the modifiable list of Stop and add your stops to it. Solve the RouteTask by calling solveRouteAsync(RouteParameters), which returns a ListenableFuture for tracking when the operation is done and getting the RouteResult.


 // create RouteTask instance
 mRouteTask = new RouteTask("http://www.yourserver.com/arcgis/rest/services/NetworkAnalysis/CA/NAServer/Route");
 .....

 // get default parameters
 mRouteParameters = mRouteTask.createDefaultParametersAsync().get();

 // get List of Stops
 List<Stop> routeStops = mRouteParameters.getStops();

 // add your stops to it
 routeStops.add(new Stop(new Point(-13045663.744, 4039204.580, WEB_MERCATOR)));
 routeStops.add(new Stop(new Point(-13052490.008, 4035542.739, WEB_MERCATOR)));

 // solve
 RouteResult result = mRouteTask.solveRouteAsync(mRouteParameters).get();
 List<Route> routes = result.getRoutes();
 mRoute = routes.get(0);

 
Alternatively to work offline and solve routes using a network dataset stored in a local geodatabase, pass the path to the database to the RouteTask(String, String) constructor. To use a network dataset stored in a Mobile Map Package (MMPK), use the RouteTask(TransportationNetworkDataset) constructor.

Use this task to find routes between any given locations based on different criteria - the quickest, shortest, most scenic, and so on. The route returned depends on the impedance chosen by the user. For example, if the impedance is time, then the best route is the quickest route. Hence, the best route can be defined as the route that has the lowest impedance. Use getAccumulateAttributeNames() to set these constraints.

Summary

Public Constructors
RouteTask(String url)
Creates a RouteTask with the given URL to a route layer in an ArcGIS Network Analyst service.
RouteTask(String databasePath, String networkName)
Creates a RouteTask using the given path to the geodatabase and transportation network dataset name.
RouteTask(TransportationNetworkDataset dataset)
Creates a RouteTask from a transportation network dataset.
Public Methods
void addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.
void addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.
void cancelLoad()
Cancels a pending load operation.
ListenableFuture<RouteParameters> createDefaultParametersAsync()
Executes an asynchronous operation to create a set of default parameters for solving a route with this route task.
ListenableFuture<RouteParameters> createParametersAsync(FeatureCollection featureCollection)
Creates route parameters for this route task from a feature collection that contains stops, route info, and barriers tables.
ListenableFuture<RouteParameters> createParametersAsync(PortalItem portalItem)
Imports route parameters from a portal item and then adjusts the imported parameters to the current Route task.
static ListenableFuture<RouteResult> createRouteResultAsync(PortalItem portalItem)
Imports a route result from a portal item.
static ListenableFuture<RouteResult> createRouteResultAsync(FeatureCollection featureCollection)
Imports a route result from a feature collection that represents a route layer.
Credential getCredential()
Gets the Credential that is set on the network resource.
CoreRouteTask getInternal()
For internal use only.
ArcGISRuntimeException getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to the FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.
LoadStatus getLoadStatus()
Returns the LoadStatus of the loadable resource.
RequestConfiguration getRequestConfiguration()
Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
RouteTaskInfo getRouteTaskInfo()
Gets the metadata (specifying the default values of properties such as TravelModeName, SupportedLanguages..
TransportationNetworkDataset getTransportationNetworkDataset()
Gets the transportation network dataset being used by this route task.
String getUri()
Gets the URI of this RemoteResource.
void loadAsync()
Loads the metadata of the loadable resource asynchronously.
boolean removeDoneLoadingListener(Runnable listener)
Removes a done loading listener from the loadable resource.
boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes a LoadStatusChangedListener from the loadable resource.
void retryLoadAsync()
Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).
void setCredential(Credential credential)
Sets a Credential to be used by the network resource in the event of an authentication challenge.
void setRequestConfiguration(RequestConfiguration requestConfiguration)
Sets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
ListenableFuture<RouteResult> solveRouteAsync(RouteParameters routeParameters)
Executes an asynchronous operation to solve (calculate) the route based on the provided route parameters.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.esri.arcgisruntime.io.RemoteResource
From interface com.esri.arcgisruntime.loadable.Loadable

Public Constructors

public RouteTask (String url)

Creates a RouteTask with the given URL to a route layer in an ArcGIS Network Analyst service. The service may be hosted in the cloud on ArcGIS Online or on-premises with ArcGIS for Server.

Parameters
url online resource for routing
Throws
IllegalArgumentException if url is null or empty

public RouteTask (String databasePath, String networkName)

Creates a RouteTask using the given path to the geodatabase and transportation network dataset name.

Parameters
databasePath the path to file to create the data from
networkName the name of the network
Throws
IllegalArgumentException if databasePath or networkName is null or empty

public RouteTask (TransportationNetworkDataset dataset)

Creates a RouteTask from a transportation network dataset.

Parameters
dataset the transport network dataset for the route task
Throws
IllegalArgumentException if dataset is null

Public Methods

public void addDoneLoadingListener (Runnable listener)

Adds a listener to the loadable resource that is invoked when loading has completed.

The listener may be added at any point, whether the loadable resource has already completed loading or not.

  • For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
  • For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.

Alternatively, to be notified when there is any change in the load status, use the addLoadStatusChangedListener(LoadStatusChangedListener) method instead.

Parameters
listener a Runnable that is invoked upon completion of the load operation

public void addLoadStatusChangedListener (LoadStatusChangedListener listener)

Adds a LoadStatusChangedListener to the loadable resource that is invoked whenever the load status changes.

Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.

The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the addDoneLoadingListener(Runnable) method.

Parameters
listener the LoadStatusChangedListener to be added

public void cancelLoad ()

Cancels a pending load operation.

A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling this method and the resource will transition from LoadStatus.LOADING to LoadStatus.FAILED_TO_LOAD state. If the load operation was successfully cancelled a CancellationException will be returned from getLoadError().

Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.

This method does nothing if the resource is not in LoadStatus.LOADING state.

public ListenableFuture<RouteParameters> createDefaultParametersAsync ()

Executes an asynchronous operation to create a set of default parameters for solving a route with this route task.

Returns
  • a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException if the operation fails.

public ListenableFuture<RouteParameters> createParametersAsync (FeatureCollection featureCollection)

Creates route parameters for this route task from a feature collection that contains stops, route info, and barriers tables.

The route parameters created from the feature collection will be adjusted to this RouteTask. RouteTask searches the following table names in feature collection:

  • "Stops" for importing stops. Required.
  • "RouteInfo" for importing route info. Optional.
  • "Barriers" for importing point barriers. Optional.
  • "PolylineBarriers" for importing polyline barriers. Optional.
  • "PolygonBarriers" for importing polygon barriers. Optional.

Please note:

  • If obtained travel mode from a featureCollection can not be applied to this RouteTask then it will be null.
  • In case of travel mode being null user can override it by an another travel mode (for example obtained from getTravelModes()).
  • Accumulate attributes from the route info table going to be applied only if they exist in getRestrictionAttributes() and getCostAttributes() for this RouteTask.

Parameters
featureCollection the feature collection that contains stops, and optionally also contains route info, and barriers tables
Returns
  • a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException if the operation fails.
Throws
IllegalArgumentException if featureCollection is null

public ListenableFuture<RouteParameters> createParametersAsync (PortalItem portalItem)

Imports route parameters from a portal item and then adjusts the imported parameters to the current Route task.

Travel mode will be null if it could not be created from the route layer settings for the route task's network. In the case that the travel mode is null then the client can override it with another travel mode (for example obtained from RouteTaskInfo. Accumulate attributes from Route Info table are going to be applied only if they exist in transportation network restriction and cost attributes.

Parameters
portalItem the portal item containing a feature collection that contains stops, route info, and barriers tables. Stops table is required.
Returns
  • A listenable future that will contain the route parameters
Throws
IllegalArgumentException if portalItem is null

public static ListenableFuture<RouteResult> createRouteResultAsync (PortalItem portalItem)

Imports a route result from a portal item.

Parameters
portalItem the portal item containing a feature collection that contains directions, stops, route info, and barriers tables.
Returns
  • A listenable future that contains the route result
Throws
IllegalArgumentException if portalItem is null

public static ListenableFuture<RouteResult> createRouteResultAsync (FeatureCollection featureCollection)

Imports a route result from a feature collection that represents a route layer.

Parameters
featureCollection the feature collection that contains directions, stops, route info, and barriers tables.
Returns
  • a listenable future that contains a route result
Throws
IllegalArgumentException if featureCollection is null

public Credential getCredential ()

Gets the Credential that is set on the network resource.

Returns
  • the Credential, or null if there is none

public CoreRouteTask getInternal ()

For internal use only.

public ArcGISRuntimeException getLoadError ()

Returns the most recent error that was encountered when the loadable resource transitioned to the FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.

If the resource subsequently transitions to LOADED, for example if a call to retryLoadAsync completes successfully, the error is cleared out.

Returns
  • the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.

public LoadStatus getLoadStatus ()

Returns the LoadStatus of the loadable resource.

Returns
  • the LoadStatus of the loadable resource

public RequestConfiguration getRequestConfiguration ()

Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.

Returns
  • the RequestConfiguration used to modify network requests

public RouteTaskInfo getRouteTaskInfo ()

Gets the metadata (specifying the default values of properties such as TravelModeName, SupportedLanguages.. etc.) about the ArcGIS Network Analyst service or the transportation network dataset being used by the route task.

Returns
  • the metadata

public TransportationNetworkDataset getTransportationNetworkDataset ()

Gets the transportation network dataset being used by this route task. Returns null if the route task was created from a service URL.

Returns
  • the transportation network dataset

public String getUri ()

Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.

Returns
  • the URI of this RemoteResource

public void loadAsync ()

Loads the metadata of the loadable resource asynchronously.

The load status changes from LoadStatus.NOT_LOADED to LoadStatus.LOADING. A listener can be added via addDoneLoadingListener(Runnable) that is invoked upon completion of the asynchronous load operation.

If the load operation completes successfully, the load status will be LoadStatus.LOADED, which means the resource has loaded its metadata.

If the load operation failed, the load status will be LoadStatus.FAILED_TO_LOAD and the error can be retrieved by calling getLoadError().

This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (LoadStatus.LOADING state) when loadAsync is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED or LoadStatus.FAILED_TO_LOAD state) when loadAsync is called, the done loading listener is immediately invoked when added to the loadable resource.

If a loadable resource has failed to load, calling loadAsync on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource, retryLoadAsync() needs to be used.

A load operation that is in progress (LoadStatus.LOADING state) can be cancelled by calling cancelLoad().

public boolean removeDoneLoadingListener (Runnable listener)

Removes a done loading listener from the loadable resource.

Parameters
listener the listener to be removed
Returns
  • true if the listener was removed, otherwise false

public boolean removeLoadStatusChangedListener (LoadStatusChangedListener listener)

Removes a LoadStatusChangedListener from the loadable resource.

Parameters
listener the LoadStatusChangedListener to be removed
Returns
  • true if the listener was removed, otherwise false

public void retryLoadAsync ()

Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).

For more details on the load process see loadAsync().

public void setCredential (Credential credential)

Sets a Credential to be used by the network resource in the event of an authentication challenge. The default credential is null.

Parameters
credential the Credential to be used for authentication

public void setRequestConfiguration (RequestConfiguration requestConfiguration)

Sets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource. If not set, the global RequestConfiguration will be used (see getGlobalRequestConfiguration()).

Parameters
requestConfiguration the RequestConfiguration used to modify network requests

public ListenableFuture<RouteResult> solveRouteAsync (RouteParameters routeParameters)

Executes an asynchronous operation to solve (calculate) the route based on the provided route parameters.

Parameters
routeParameters route parameters
Returns
  • a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation. Calling get() on the returned future may throw an ExecutionException if the operation fails.