Class ClosestFacilityTask
- All Implemented Interfaces:
ApiKeyResource
,RemoteResource
,Loadable
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(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<ClosestFacilityResult> 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) { e.printStackTrace(); } } }); } catch (Throwable e) { e.printStackTrace(); } } });
- Since:
- 100.1.0
-
Property Summary
TypePropertyDescriptionThe load error.The load status. -
Constructor Summary
ConstructorDescriptionCreates a closest facility task with a transportation network dataset.Creates a ClosestFacilityTask with the given URL to a Closest Facility Service.ClosestFacilityTask
(String geodatabasePath, String networkName) Creates a closest facility task with a path pointing to a geodatabase file and a network name. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable listener) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
Cancels loading metadata for the object.Executes an asynchronous operation to create a set of default parameters for solving a closest facility with this closest facility task.Gets the API key to access API key enabled services and resources in ArcGIS Online.Gets the metadata (specifying the default values of properties such as TravelModeName, SupportedLanguages..Gets theCredential
that is set on the network-enabled resource.Gets the value of theloadError
property.Gets the value of theloadStatus
property.Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.Gets the transportation network dataset.getUri()
Gets the URI of thisRemoteResource
.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.boolean
removeDoneLoadingListener
(Runnable listener) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.void
Sets the API key to access API key enabled services and resources in ArcGIS Online.void
setCredential
(Credential credential) Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge.void
setRequestConfiguration
(RequestConfiguration requestConfiguration) Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.solveClosestFacilityAsync
(ClosestFacilityParameters closestFacilityParameters) Executes an asynchronous operation to solve (calculate) the closest facility route based on the provided closest facility parameters.
-
Property Details
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- See Also:
-
-
Constructor Details
-
ClosestFacilityTask
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:
url
- online service for closest facility- Since:
- 100.1.0
-
ClosestFacilityTask
Creates a closest facility task with a path pointing to a geodatabase file and a network name.- Parameters:
geodatabasePath
- an absolute path to a geodatabasenetworkName
- a network name- Throws:
IllegalArgumentException
- if geodatabasePath is empty or nullIllegalArgumentException
- if networkName is empty or null- Since:
- 100.3.0
-
ClosestFacilityTask
Creates a closest facility task with a transportation network dataset.- Parameters:
dataset
- a transportation network dataset- Throws:
IllegalArgumentException
- if dataset is null- Since:
- 100.3.0
-
-
Method Details
-
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
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
Gets the transportation network dataset.- Returns:
- the transportation network dataset
- Since:
- 100.3.0
-
getLoadError
Gets the value of theloadError
property.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadError
property - See Also:
-
getLoadStatus
Gets the value of theloadStatus
property.- Specified by:
getLoadStatus
in interfaceLoadable
- 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
toLoadStatus.LOADING
. A listener can be added viaLoadable.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 callingLoadable.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) whenloadAsync
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
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
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 callingLoadable.cancelLoad()
. -
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 interfaceLoadable
-
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 fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.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 interfaceLoadable
-
addDoneLoadingListener
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 interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
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 interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadErrorProperty
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
getCredential
Description copied from interface:RemoteResource
Gets theCredential
that is set on the network-enabled resource.Only applicable if the resource is secured.
- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the Credential, or null if there is none
-
setCredential
Description copied from interface:RemoteResource
Sets aCredential
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 interfaceRemoteResource
- Parameters:
credential
- the Credential to be used for authentication
-
getRequestConfiguration
Description copied from interface:RemoteResource
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the
RequestConfiguration
used to modify network requests
-
setRequestConfiguration
Description copied from interface:RemoteResource
Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
. If not set, the globalRequestConfiguration
will be used (seeRequestConfiguration.getGlobalRequestConfiguration()
).- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- the RequestConfiguration used to modify network requests
-
getUri
Description copied from interface:RemoteResource
Gets the URI of thisRemoteResource
. Typically this is the URI used to instantiate the object.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of this RemoteResource
-
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 callApiKeyResource.setApiKey(String)
on any class that implementsApiKeyResource
. When you callsetApiKey(String)
on anAPIKeyResource
, it will override the default key at the global level (the key returned byArcGISRuntimeEnvironment.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 interfaceApiKeyResource
- Returns:
- the API key to access API key enabled services and resources in ArcGIS Online
- See Also:
-
setApiKey
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 callsetApiKey(String)
on any class that implementsApiKeyResource
. When you callsetApiKey(String)
on anAPIKeyResource
, it will override the default key at the global level (the key returned byArcGISRuntimeEnvironment.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 interfaceApiKeyResource
- Parameters:
ApiKey
- the API key to access API key enabled services and resources in ArcGIS Online- See Also:
-