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:
- Pass in Url of service to constructor
ServiceAreaTask(String)
. - Use the
createDefaultParametersAsync()
method to create a set ofServiceAreaParameters
with default values. - Make any necessary changes to parameters, for instance changing impedance value used in calculation.
ServiceAreaTaskInfo
stores all settings that can be changed in parameters. - Set
ServiceAreaFacility
s to parametersServiceAreaParameters.setFacilities(Iterable)
. Service areas will be generated around these facilities. At least one facility must be added, otherwise an exception is thrown. - Solve the ServiceAreaTask by calling
solveServiceAreaAsync(ServiceAreaParameters)
, which returns a ListenableFuture for tracking when the operation is done. - Get the
ServiceAreaResult
from the listener once the calculation is complete. - Get service areas from result using
ServiceAreaResult.getResultPolygons(int)
orServiceAreaResult.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:
ServiceAreaParameters
,ServiceAreaResult
,ServiceAreaTaskInfo
-
-
Constructor Summary
Constructors Constructor Description ServiceAreaTask(TransportationNetworkDataset dataset)
Creates a service area task with a transportation network dataset.ServiceAreaTask(String url)
Creates a ServiceAreaTask with the given URL to a service area service.ServiceAreaTask(String geodatabasePath, String networkName)
Creates a service area task with a path to a geodatabase.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.ListenableFuture<ServiceAreaParameters>
createDefaultParametersAsync()
Executes an asynchronous operation to create a set of default parameters for creating service areas.String
getApiKey()
Gets the API key to access API key enabled services and resources in ArcGIS Online.Credential
getCredential()
Gets theCredential
that is set on the network-enabled resource.ArcGISRuntimeException
getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
of the loadable resource.RequestConfiguration
getRequestConfiguration()
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.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.TransportationNetworkDataset
getTransportationNetworkDataset()
Gets the transportation network dataset.String
getUri()
Gets the URI of thisRemoteResource
.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 aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
Loads or retries loading metadata for the object asynchronously.void
setApiKey(String apiKey)
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
.ListenableFuture<ServiceAreaResult>
solveServiceAreaAsync(ServiceAreaParameters serviceAreaParameters)
Executes an asynchronous operation to solve (calculate) the service area task based on the given service area parameters.
-
-
-
Constructor Detail
-
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 geodatabasenetworkName
- a network name- Throws:
IllegalArgumentException
- if geodatabasePath is null or emptyIllegalArgumentException
- if networkName is null or empty- Since:
- 100.3.0
-
-
Method Detail
-
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:
ServiceAreaParameters
,ServiceAreaTaskInfo
,createDefaultParametersAsync()
-
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:
getServiceAreaTaskInfo()
-
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)
andServiceAreaParameters.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 setIllegalArgumentException
- if serviceAreaParameters is null- Since:
- 100.1.0
- See Also:
ServiceAreaParameters.setFacilities(Iterable)
,ServiceAreaParameters.setReturnPolylineBarriers(boolean)
,ServiceAreaParameters.setReturnPolygonBarriers(boolean)
-
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 theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- 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 theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- 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
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
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 interfaceLoadable
- 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 interfaceLoadable
- 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 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
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
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
-
getCredential
public Credential 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
public void setCredential(Credential credential)
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
public RequestConfiguration 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
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
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
public String 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
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 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 callApiKeyResource.setApiKey(String)
on any ArcGIS Runtime 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:
ApiKeyResource.setApiKey(String)
-
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 callsetApiKey(String)
on any ArcGIS Runtime 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:
ApiKeyResource.getApiKey()
-
-