Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.offlinemap

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 a DownloadPreplannedOfflineMapJob. Create this job by passing the preplanned map area to the OfflineMapTask.downloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String) method on the OfflineMapTask.

To successfully load a PreplannedMapArea the getPackagingStatus() must be PreplannedPackagingStatus.COMPLETE.

Since:
100.2.0

  • Property Details

  • Constructor Details

    • PreplannedMapArea

      public PreplannedMapArea(PortalItem portalItem)
      Creates an offline map area instance with a portal item that is of type map area.
      Parameters:
      portalItem - a PortalItem that represents a preplanned offline map area
      Throws:
      IllegalArgumentException - if portalItem is null
      Since:
      100.2.0

  • Method Details

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

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

    • 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

    • 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

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

    • 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 an Envelope or a Polygon, depending on how the online map area was created.

      Returns:
      the area of interest, or null if this PreplannedMapArea is not loaded
      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
      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.
      Choose the approach that best suits your workflow, then select the appropriate DownloadPreplannedOfflineMapParameters.getUpdateMode(). For more details on how to update an offline map, see the OfflineMapSyncTask.

      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 the DownloadPreplannedOfflineMapParameters.getUpdateMode() to PreplannedUpdateMode.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 the DownloadPreplannedOfflineMapParameters.getUpdateMode() to PreplannedUpdateMode.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 the DownloadPreplannedOfflineMapParameters.getUpdateMode() to PreplannedUpdateMode.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

    • 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 a PreplannedPackagingStatus.COMPLETE state and ready to be downloaded. If you attempt to load a PreplannedMapArea that is not PreplannedPackagingStatus.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 is LoadStatus.NOT_LOADED.

      If the packaging status is PreplannedPackagingStatus.PROCESSING you can check it again following these steps:

      1. Create a new PreplannedMapArea using the portal item PreplannedMapArea(com.esri.arcgisruntime.portal.PortalItem).
      2. Load the PreplannedMapArea and check getPackagingStatus().
      Returns:
      an enum that describes the packaging status of the online map area
      Since:
      100.9.0