Class PreplannedMapArea
- java.lang.Object
-
- com.esri.arcgisruntime.tasks.offlinemap.PreplannedMapArea
-
- All Implemented Interfaces:
Loadable
public final class PreplannedMapArea extends Object implements Loadable
Represents a single preplanned offline map area.Offline map areas are specific work areas or major incident areas that are defined by an online map author ahead of time. Each online map can contain a number of offline map areas. These can be provided in a list by the
OfflineMapTask.getPreplannedMapAreasAsync()
method. Each preplanned map area uses map content that is stored online. Download this map content by running aDownloadPreplannedOfflineMapJob
. Create this job by passing the preplanned map area to theOfflineMapTask.downloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String)
method on theOfflineMapTask
.To successfully load a PreplannedMapArea the
getPackagingStatus()
must bePreplannedPackagingStatus.COMPLETE
.- Since:
- 100.2.0
-
-
Constructor Summary
Constructors Constructor Description PreplannedMapArea(PortalItem portalItem)
Create an offline map area instance with a portal item that is of type map area.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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.Geometry
getAreaOfInterest()
Gets the area of interest bounding the offline map area.ListenableFuture<List<PortalItem>>
getContentItemsAsync()
Deprecated.100.14.0.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.ListenableList<PortalItem>
getPackageItems()
Portal items for packages related to this preplanned map area.PreplannedPackagingStatus
getPackagingStatus()
Describes the packaging status of the online map area.PortalItem
getPortalItem()
Gets the portal item that this offline map area was created from.OfflineMapUpdateCapabilities
getUpdateCapabilities()
Describes the methods for obtaining updates that are supported for this offline map area.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.
-
-
-
Constructor Detail
-
PreplannedMapArea
public PreplannedMapArea(PortalItem portalItem)
Create an offline map area instance with a portal item that is of type map area.- Parameters:
portalItem
-PortalItem
that represents a preplanned offline map area- Throws:
IllegalArgumentException
- if portalItem is null- Since:
- 100.2.0
-
-
Method Detail
-
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
-
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.
-
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
-
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
-
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
-
getAreaOfInterest
public Geometry getAreaOfInterest()
Gets the area of interest bounding the offline map area.The area of interest is returned as a
Geometry
, which can be either anEnvelope
or aPolygon
depending on how the online map area was created.- Returns:
- the area of interest bounding the offline map area, or null if none
- Since:
- 100.2.0
-
getPackageItems
public ListenableList<PortalItem> getPackageItems()
Portal items for packages related to this preplanned map area.When the offline map area has successfully loaded, this collection contains the portal items for the packages (tile packages or geodatabases) holding the offline data for the map area.
- Returns:
- portal items for packages related to this preplanned map area
- Since:
- 100.14.0
-
getPortalItem
public PortalItem getPortalItem()
Gets the portal item that this offline map area was created from.- Returns:
- the portal item that this offline map area was created from, or null if none
- Since:
- 100.2.0
-
getUpdateCapabilities
public OfflineMapUpdateCapabilities getUpdateCapabilities()
Describes the methods for obtaining updates that are supported for this offline map area.There are two approaches for updating the features in a preplanned offline map area:
- Syncing directly with feature services.
- Downloading scheduled updates (or update packages) from the online map area.
DownloadPreplannedOfflineMapParameters.getUpdateMode()
. For more details on how to update an offline map, see theOfflineMapSyncTask
.If
OfflineMapUpdateCapabilities.isSupportsSyncWithFeatureServices()
is true, you can sync directly with feature services. This mode gives you full control over when you upload and download changes. However, performing a download sync places significant load on the backing feature service, so this approach does not scale well for very large deployments. Set theDownloadPreplannedOfflineMapParameters.getUpdateMode()
toPreplannedUpdateMode.SYNC_WITH_FEATURE_SERVICES
to use this approach.If
OfflineMapUpdateCapabilities.isSupportsScheduledUpdatesForFeatures()
is true, you can download read-only update packages from the online map area. Updates are prepared on a regular schedule and cached for download by all users of the offline map area. Sharing a single set of cached updates, rather than performing individual sync operations, reduces the load on the back-end services. This approach is scalable for large deployments but does not support offline editing. Set theDownloadPreplannedOfflineMapParameters.getUpdateMode()
toPreplannedUpdateMode.DOWNLOAD_SCHEDULED_UPDATES
to use this approach.Note that scheduled updates is an optimization that must be enabled by the web map author when the map area is created.
If both of the above
OfflineMapUpdateCapabilities
are true, and the feature services in your online map support creating new features, you can adopt a hybrid update model where you download read-only update packages while uploading new features directly to the feature service. This approach combines the scalability of downloading scheduled updates with the ability to collect data in the field. However, note that this approach is strictly add only, meaning that you cannot delete or edit features once they have been uploaded to the feature service. Set theDownloadPreplannedOfflineMapParameters.getUpdateMode()
toPreplannedUpdateMode.DOWNLOAD_SCHEDULED_UPDATES_AND_UPLOAD_NEW_FEATURES
to use this approach.This property will return null until the preplanned map area is loaded.
- Returns:
- describes the methods for obtaining updates that are supported for this offline map area, or null if none
- Since:
- 100.6.0
-
getContentItemsAsync
@Deprecated public ListenableFuture<List<PortalItem>> getContentItemsAsync()
Deprecated.100.14.0. Replaced by loading the PreplannedMapArea and accessing the items withgetPackageItems()
.Returns an asyncListenableFuture
which when successful, contains a list of package items for this preplanned map area, if there are any. The package items will also be available ingetPackageItems()
.- Returns:
- returns a task with element type
List
containing elements of typePortalItem
- Since:
- 100.3.0
-
getPackagingStatus
public PreplannedPackagingStatus getPackagingStatus()
Describes the packaging status of the online map area. This property allows you to check whether an online PreplannedMapArea is in aPreplannedPackagingStatus.COMPLETE
state and ready to be downloaded. If you attempt to load a PreplannedMapArea that is notPreplannedPackagingStatus.COMPLETE
the PreplannedMapArea will fail to load.There are four possible values:
-
PreplannedPackagingStatus.COMPLETE
indicates the map area is ready for download and the data has been packaged. -
PreplannedPackagingStatus.PROCESSING
indicates that the online map area is not yet ready to be downloaded. The packages required for the map area have not been packaged yet. This status will be available after the PreplannedMapArea fails to load. -
PreplannedPackagingStatus.FAILED
indicates that an error was encountered while preparing the online map area or its packages. In this scenario, the map area cannot be downloaded until the web map author has resolved the errors. This status will be available after the PreplannedMapArea fails to load. -
PreplannedPackagingStatus.UNKNOWN
indicates that the metadata for the map area has not been fetched. This will be the value when the map area isLoadStatus.NOT_LOADED
.
If the packaging status is
PreplannedPackagingStatus.PROCESSING
you can check it again following these steps:- Create a new PreplannedMapArea using the portal item
PreplannedMapArea(com.esri.arcgisruntime.portal.PortalItem)
. - Load the PreplannedMapArea and check
getPackagingStatus()
.
- Returns:
- an enum that describes the packaging status of the online map area
- Since:
- 100.9.0
-
-
-