Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.networkanalysis

Class RouteTask

java.lang.Object
com.esri.arcgisruntime.tasks.networkanalysis.RouteTask
All Implemented Interfaces:
ApiKeyResource, RemoteResource, Loadable
public final class RouteTask extends Object implements Loadable, RemoteResource, ApiKeyResource
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 RouteParameters.getAccumulateAttributeNames() to set these constraints.

Since:
100.0.0

  • Property Details

  • Constructor Details

    • RouteTask

      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
      Since:
      100.0.0

    • RouteTask

      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
      Since:
      100.0.0

    • RouteTask

      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
      Since:
      100.0.0

  • Method Details

    • createDefaultParametersAsync

      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.
      Since:
      100.0.0

    • createParametersAsync

      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:

      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
      Since:
      100.1.0
      See Also:

    • createParametersAsync

      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
      Since:
      100.3.0

    • getRouteTaskInfo

      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
      Since:
      100.0.0

    • getTransportationNetworkDataset

      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
      Since:
      100.0.0

    • solveRouteAsync

      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.
      Since:
      100.0.0

    • createRouteResultAsync

      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
      Since:
      100.3.0

    • createRouteResultAsync

      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
      Since:
      100.4.0

    • getApiKey

      public String getApiKey()
      Description copied from interface: ApiKeyResource
      Gets the API key to access API key enabled services and resources in ArcGIS Online.

      An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

      In addition to setting an API key at a global level for your application using ArcGISRuntimeEnvironment.setApiKey(String), you can call ApiKeyResource.setApiKey(String) on any class that implements ApiKeyResource. When you call setApiKey(String) on an APIKeyResource, it will override the default key at the global level (the key returned by ArcGISRuntimeEnvironment.getApiKey(), in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app.

      Classes that expose an API key property by implementing APIKeyResource include:

      Specified by:
      getApiKey in interface ApiKeyResource
      Returns:
      the API key to access API key enabled services and resources in ArcGIS Online
      See Also:

    • setApiKey

      public void setApiKey(String apiKey)
      Description copied from interface: ApiKeyResource
      Sets the API key to access API key enabled services and resources in ArcGIS Online.

      An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account.

      In addition to setting an API key at a global level for your application using ArcGISRuntimeEnvironment.setApiKey(String), you can call setApiKey(String) on any class that implements ApiKeyResource. When you call setApiKey(String) on an APIKeyResource, it will override the default key at the global level (the key returned by ArcGISRuntimeEnvironment.getApiKey(), in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app.

      Classes that expose an API key property by implementing APIKeyResource include:

      Specified by:
      setApiKey in interface ApiKeyResource
      Parameters:
      apiKey - the API key to access API key enabled services and resources in ArcGIS Online
      See Also:

    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the loadError property.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      Returns:
      the value of the loadError property
      See Also:

    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the loadStatus property.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the value of the loadStatus property
      See Also:

    • loadAsync

      public void loadAsync()
      Description copied from interface: Loadable
      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 Loadable.addDoneLoadingListener(java.lang.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 Loadable.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, Loadable.retryLoadAsync() needs to be used.

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

      Specified by:
      loadAsync in interface Loadable

    • retryLoadAsync

      public void retryLoadAsync()
      Description copied from interface: Loadable
      Loads or retries loading metadata for the object asynchronously.

      Will retry loading the metadata if the object's load status is LoadStatus.FAILED_TO_LOAD. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.

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

      Specified by:
      retryLoadAsync in interface Loadable

    • cancelLoad

      public void cancelLoad()
      Description copied from interface: Loadable
      Cancels loading metadata for the object.

      Cancels loading the metadata if the object is loading, and always invokes the done loading listener.

      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 Loadable.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.

      Specified by:
      cancelLoad in interface Loadable

    • addDoneLoadingListener

      public void addDoneLoadingListener(Runnable listener)
      Description copied from interface: Loadable
      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, add a listener to the Loadable.loadStatusProperty() instead.

      Specified by:
      addDoneLoadingListener in interface Loadable
      Parameters:
      listener - a Runnable that is invoked upon completion of the load operation

    • removeDoneLoadingListener

      public boolean removeDoneLoadingListener(Runnable listener)
      Description copied from interface: Loadable
      Removes a done loading listener from the loadable resource.
      Specified by:
      removeDoneLoadingListener in interface Loadable
      Parameters:
      listener - the listener to be removed
      Returns:
      true if the listener was removed, otherwise false

    • addLoadStatusChangedListener

      public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      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 Loadable.addDoneLoadingListener(Runnable) method.

      Specified by:
      addLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be added

    • removeLoadStatusChangedListener

      public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
      Description copied from interface: Loadable
      Removes a LoadStatusChangedListener from the loadable resource.
      Specified by:
      removeLoadStatusChangedListener in interface Loadable
      Parameters:
      listener - the LoadStatusChangedListener to be removed
      Returns:
      true if the listener was removed, otherwise false

    • loadStatusProperty

      public ReadOnlyObjectProperty<LoadStatus> loadStatusProperty()
      Description copied from interface: Loadable
      The load status.
      Specified by:
      loadStatusProperty in interface Loadable
      Returns:
      the loadStatus property
      See Also:

    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      Returns:
      the loadError property
      See Also:

    • getCredential

      public Credential getCredential()
      Description copied from interface: RemoteResource
      Gets the Credential that is set on the network-enabled resource.

      Only applicable if the resource is secured.

      Specified by:
      getCredential in interface RemoteResource
      Returns:
      the Credential, or null if there is none

    • setCredential

      public void setCredential(Credential credential)
      Description copied from interface: RemoteResource
      Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

      Only applicable if the resource is secured.

      Specified by:
      setCredential in interface RemoteResource
      Parameters:
      credential - the Credential to be used for authentication

    • getRequestConfiguration

      public RequestConfiguration getRequestConfiguration()
      Description copied from interface: RemoteResource
      Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
      Specified by:
      getRequestConfiguration in interface RemoteResource
      Returns:
      the RequestConfiguration used to modify network requests

    • setRequestConfiguration

      public void setRequestConfiguration(RequestConfiguration requestConfiguration)
      Description copied from interface: RemoteResource
      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 RequestConfiguration.getGlobalRequestConfiguration()).
      Specified by:
      setRequestConfiguration in interface RemoteResource
      Parameters:
      requestConfiguration - the RequestConfiguration used to modify network requests

    • getUri

      public String getUri()
      Description copied from interface: RemoteResource
      Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URI of this RemoteResource