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

Class ServiceAreaTask

java.lang.Object
com.esri.arcgisruntime.tasks.networkanalysis.ServiceAreaTask
All Implemented Interfaces:
ApiKeyResource, RemoteResource, Loadable
public final class ServiceAreaTask extends Object implements Loadable, RemoteResource, ApiKeyResource
A task to compute areas that can be serviced (reached) from a given location using an ArcGIS Network Analyst service.

A service area is a region that encompasses all accessible streets, that is, streets that lie within a specified impedance around a given facility. For instance, a 10-minute service area includes all the streets that can be reached within 10 minutes from that facility.

To solve for service areas:

  1. Pass in Url of service to constructor ServiceAreaTask(String).
  2. Use the createDefaultParametersAsync() method to create a set of ServiceAreaParameters with default values.
  3. Make any necessary changes to parameters, for instance changing impedance value used in calculation. ServiceAreaTaskInfo stores all settings that can be changed in parameters.
  4. Set ServiceAreaFacilitys to parameters ServiceAreaParameters.setFacilities(Iterable). Service areas will be generated around these facilities. At least one facility must be added, otherwise an exception is thrown.
  5. Solve the ServiceAreaTask by calling solveServiceAreaAsync(ServiceAreaParameters), which returns a ListenableFuture for tracking when the operation is done.
  6. Get the ServiceAreaResult from the listener once the calculation is complete.
  7. Get service areas from result using ServiceAreaResult.getResultPolygons(int) or ServiceAreaResult.getResultPolylines(int). Polygons display an area around a facility that can be serviced within the impedance that was set. Polylines display all streets that can be serviced within that same area.

Displaying ServiceAreaPolygons using a ServiceAreaTask from an URL: 

 // create service area task from url
 final String SanFranciscoRegion = "http://qadev000238.esri.com/server/rest/services/NA/SanFran_WithTM/NAServer/Service_Area_Defaults";
 serviceAreaTask = new ServiceAreaTask(SanFranciscoRegion);
 serviceAreaTask.loadAsync();

 ListenableFuture<ServiceAreaParameters> parameters = serviceAreaTask.createDefaultParametersAsync();
 parameters.addDoneListener(() -> {
   try {
     serviceAreaParameters = parameters.get();
   } catch (ExecutionException | InterruptedException e) {
     e.printStackTrace();
   }
 });

 serviceAreaParameters.setFacilities(serviceAreaFacilities);
 // find service areas around facility using parameters that were set
 ListenableFuture<ServiceAreaResult> result = serviceAreaTask.solveServiceAreaAsync(serviceAreaParameters);
 result.addDoneListener(() -> {
   try {
      // display all service areas that were found to mapview
      List<Graphic> graphics = serviceAreasOverlay.getGraphics();
      ServiceAreaResult serviceAreaResult = result.get();
      for (int i = 0; i < serviceAreaFacilities.size(); i++) {
        List<ServiceAreaPolygon> polygons = serviceAreaResult.getResultPolygons(i);
        // could be more than one service area
        for (int j = 0; j < polygons.size(); j++) {
          graphics.add(new Graphic(polygons.get(j).getGeometry(), fillSymbols.get(j % 2)));
        }
      }
   } catch (ExecutionException | InterruptedException e) {
     e.printStackTrace();
   }
 });
Since:
100.1.0
See Also:

  • Property Details

  • Constructor Details

    • ServiceAreaTask

      public ServiceAreaTask(String url)
      Creates a ServiceAreaTask with the given URL to a service area service. The service may be hosted in the cloud on ArcGIS Online or on-premises with ArcGIS for Server.
      Parameters:
      url - online service for service area
      Throws:
      IllegalArgumentException - if url is null or empty
      Since:
      100.1.0

    • ServiceAreaTask

      public ServiceAreaTask(TransportationNetworkDataset dataset)
      Creates a service area task with a transportation network dataset.
      Parameters:
      dataset - a transportation network dataset
      Throws:
      IllegalArgumentException - if dataset or resources is null
      Since:
      100.3.0

    • ServiceAreaTask

      public ServiceAreaTask(String geodatabasePath, String networkName)
      Creates a service area task with a path to a geodatabase.
      Parameters:
      geodatabasePath - an absolute path to a geodatabase
      networkName - a network name
      Throws:
      IllegalArgumentException - if geodatabasePath is null or empty
      IllegalArgumentException - if networkName is null or empty
      Since:
      100.3.0

  • Method Details

    • getServiceAreaTaskInfo

      public ServiceAreaTaskInfo getServiceAreaTaskInfo()
      Gets the metadata (default and possible values of properties such as travel modes, supported languages, etc.) about the network service used by this task. Use this information to help set the service area parameters that are used to create service areas.
      Returns:
      metadata about the network service
      Since:
      100.1.0
      See Also:

    • createDefaultParametersAsync

      public ListenableFuture<ServiceAreaParameters> createDefaultParametersAsync()
      Executes an asynchronous operation to create a set of default parameters for creating service areas.
      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.1.0
      See Also:

    • solveServiceAreaAsync

      public ListenableFuture<ServiceAreaResult> solveServiceAreaAsync(ServiceAreaParameters serviceAreaParameters)
      Executes an asynchronous operation to solve (calculate) the service area task based on the given service area parameters.

      At least one service area facility must be added to parameters otherwise an exception is thrown.

      Service area polygons and service area polylines will only be returned if ServiceAreaParameters.setReturnPolygons(boolean) and ServiceAreaParameters.setReturnPolylines(boolean) is set to true.

      Barriers (Points, Polylines, or Polygons) will only be returned in the result if their corresponding return value is set to true. For instance, to set point barriers set ServiceAreaParameters.setReturnPointBarriers(boolean) to true.

      Parameters:
      serviceAreaParameters - service area parameters used for solving 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.
      Throws:
      ArcGISRuntimeException - if given parameters has no facility set
      IllegalArgumentException - if serviceAreaParameters is null
      Since:
      100.1.0
      See Also:

    • getTransportationNetworkDataset

      public TransportationNetworkDataset getTransportationNetworkDataset()
      Gets the transportation network dataset.
      Returns:
      the transportation network dataset
      Since:
      100.3.0

    • 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

    • 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: