Class ClosestFacilityTask

  • All Implemented Interfaces:
    RemoteResource, Loadable

    public final class ClosestFacilityTask
    extends Object
    implements Loadable, RemoteResource
    A task to measure the cost of traveling between incidents and facilities and to determine which are nearest to one another.

    When finding closest facilities, you can specify how many to find and whether the direction of travel is toward or away from them. The ClosestFacilityTask can be used in an online workflow. To solve closest facilities using an ArcGIS Network Analyst service hosted on ArcGIS Online or on-premises with ArcGIS for Server, create a ClosestFacilityTask by passing in the URL of the service to the ClosestFacilityTask(Context, String) constructor. Create a set of default parameters ClosestFacilityParameters for solving a closest facility with this ClosestFacilityTask by calling createDefaultParametersAsync(). Get the modifiable lists of Incident and Facility and add your facilities and incidents to them. Solve the ClosestFacilityTask by calling solveClosestFacilityAsync(ClosestFacilityParameters), which returns a ListenableFuture for tracking when the operation is done and getting the ClosestFacilityResult.

    
     // create ClosestFacilityTask instances
     mClosestFacilityTask = new ClosestFacilityTask(context, "http://www.yourserver.com/arcgis/rest/services/NetworkAnalysis/CA/NAServer/Closest%20Facility");
     .....
    
     // get default parameters
     final ListenableFuture<ClosestFacilityParameters> paramsFuture = sClosestFacilityTask.createDefaultParametersAsync();
     paramsFeature.addDoneListener(new Runnable() {
       @Override
       public void run() {
         try {
           mClosestFacilityParameters = paramsFuture.get();
    
           // add your Facility
           List<Facility> facilities = mClosestFacilityParameters.getFacilities();
           facilities.add(new Facility(new Point(-13045663.744, 4039204.580, WEB_MERCATOR)));
    
           // add your Incident
           List<Incident> incidents = mClosestFacilityParameters.getIncidents();
           incidents.add(new Incident(new Point(-13052490.008, 4035542.739, WEB_MERCATOR)));
    
           // solve
           final ListenableFuture<ClosestFacilityResul> resultFuture = mClosestFacilityTask.solveClosestFacilityAsync(mClosestFacilityParameters);
           resultFuture.addDoneListener(new Runnable() {
             @Override
             public void run() {
               try {
                 // get ClosestFacilityRoute by facility and incident indexes
                 ClosestFacilityResult result = resultFuture.get();
                 mClosestFacilityRoute = result.getRoute(0, 0);
               } catch (Throwable e) {
                 Log.e(e);
               }
             }
           });
         } catch (Throwable e) {
           Log.e(e);
         }
       }
     });
    
     
    Since:
    100.1.0
    • Constructor Detail

      • ClosestFacilityTask

        public ClosestFacilityTask​(android.content.Context context,
                                   String url)
        Creates a ClosestFacilityTask with the given URL to a Closest Facility Service. The service may be hosted in the cloud on ArcGIS Online or on-premises with ArcGIS for Server.
        Parameters:
        context - the Context in which the task is running
        url - online service for closest facility
        Since:
        100.1.0
      • ClosestFacilityTask

        public ClosestFacilityTask​(android.content.Context context,
                                   String geodatabasePath,
                                   String networkName)
        Creates a ClosestFacilityTask with a path pointing to a geodatabase file and a network name.
        Parameters:
        context - the Context in which the task is running
        geodatabasePath - an absolute path to a geodatabase
        networkName - a network name
        Throws:
        IllegalArgumentException - if geodatabasePath is empty or null
        IllegalArgumentException - if networkName is empty or null
        Since:
        100.3.0
      • ClosestFacilityTask

        public ClosestFacilityTask​(android.content.Context context,
                                   TransportationNetworkDataset dataset)
        Creates a ClosestFacilityTask with a transportation network dataset.
        Parameters:
        context - the Context in which the task is running
        dataset - a transportation network dataset
        Throws:
        IllegalArgumentException - if dataset is null
        Since:
        100.3.0
    • Method Detail

      • getClosestFacilityTaskInfo

        public ClosestFacilityTaskInfo getClosestFacilityTaskInfo()
        Gets the metadata (specifying the default values of properties such as TravelModeName, SupportedLanguages, etc.) about the ArcGIS Network Analyst service being used by the closest facility task.
        Returns:
        the metadata
        Since:
        100.1.0
      • createDefaultParametersAsync

        public ListenableFuture<ClosestFacilityParameters> createDefaultParametersAsync()
        Executes an asynchronous operation to create a set of default parameters for solving a closest facility with this closest facility 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.1.0
      • solveClosestFacilityAsync

        public ListenableFuture<ClosestFacilityResult> solveClosestFacilityAsync​(ClosestFacilityParameters closestFacilityParameters)
        Executes an asynchronous operation to solve (calculate) the closest facility route based on the provided closest facility parameters.
        Parameters:
        closestFacilityParameters - closest facility 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.
        Throws:
        IllegalArgumentException - if closestFacilityParameters is null
        Since:
        100.1.0
      • getTransportationNetworkDataset

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

        public ArcGISRuntimeException getLoadError()
        Description copied from interface: Loadable
        Returns the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.

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

        Specified by:
        getLoadError in interface Loadable
        Returns:
        the most recent error that was encountered when the loadable resource transitioned to the LoadStatus.FAILED_TO_LOAD state.
      • getLoadStatus

        public LoadStatus getLoadStatus()
        Description copied from interface: Loadable
        Returns the LoadStatus of the loadable resource.
        Specified by:
        getLoadStatus in interface Loadable
        Returns:
        the LoadStatus of the loadable resource
      • 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
        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 Loadable.loadAsync().

        Specified by:
        retryLoadAsync in interface Loadable
      • cancelLoad

        public void cancelLoad()
        Description copied from interface: Loadable
        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 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, use the Loadable.addLoadStatusChangedListener(LoadStatusChangedListener) method 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
      • getCredential

        public Credential getCredential()
        Description copied from interface: RemoteResource
        Gets the Credential that is set on the network resource.
        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 resource in the event of an authentication challenge. The default credential is null.
        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
      • 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