Class MobileMapPackage

java.lang.Object
com.esri.arcgisruntime.mapping.MobileMapPackage
All Implemented Interfaces:
Loadable

public final class MobileMapPackage extends Object implements Loadable
A mobile map package.

Mobile map packages allow you to work with maps on a mobile device. A mobile map package contains all of the files necessary to work with your maps and is stored on a device as either:

  • A single archive file with an .mmpk extension.
  • A directory containing an unpacked mobile map package.
You can create a mobile map package using either: A mobile map package can encapsulate one or more maps along with their layers and data. Each package contains an Item with metadata about the package (description, thumbnail, etc.).

Mobile map packages created with ArcGIS Pro can also include transportation networks, locators, and links to online services. You can choose whether to use:

Online services (such as traffic or weather) can provide excellent contextual information for your users. If the mobile map package is going to be used in areas of poor connectivity, however, you must ensure that data critical to your workflow is stored locally on the device.

Mobile map packages implement the Loadable interface; you need to load the MobileMapPackage before you can access its content. Once loaded you can:

  • Determine the version of this package using getVersion(). This API supports mobile map packages up to and including major version 5. If the package is from an unsupported version, it will fail to load.
  • Discover if the mobile map package has expired using getExpiration().
  • Access the individual maps and display them in a MapView.
  • Programmatically add, modify, and remove layers in the map. Mobile map packages, however, are read-only and these changes to maps or layers are not persisted.
Example to load an ArcGISMap from a MobileMapPackage into a MapView:
 // create the mobile map package
 mapPackage = new MobileMapPackage("MyMobileMapPackage.mmpk");
 // load the mobile map package asynchronously
 mapPackage.loadAsync();
 // add done listener which will invoke when mobile map package has loaded
 mapPackage.addDoneLoadingListener(() -> {
   // check load status and that the mobile map package has maps
   if(mapPackage.getLoadStatus() == LoadStatus.LOADED && mapPackage.getMaps().size() > 0){
     // add the map from the mobile map package to the view
     mapView.setMap(mapPackage.getMaps().get(0));
 });
 
Since:
100.0.0
See Also:
  • Property Details

  • Constructor Details

    • MobileMapPackage

      public MobileMapPackage(String path)
      Creates a new MobileMapPackage from the .mmpk file or an unpacked mobile map package at the given path. An unpacked mobile map package is created when a map is taken offline by OfflineMapTask.generateOfflineMap(GenerateOfflineMapParameters, String).

      Call loadAsync before accessing the package's contents.

      Parameters:
      path - the path to a .mmpk file or a folder containing an exploded mobile map package
      Throws:
      IllegalArgumentException - if path is null or empty
      Since:
      100.0.0
  • Method Details

    • getMaps

      public List<ArcGISMap> getMaps()
      An unmodifiable list of ArcGISMap objects from the MobileMapPackage.

      To use the maps in a MobileMapPackage , you first need to load the package. If the mobile map package was created with ArcGIS Pro, the maps are presented in the same order in which they were packaged. Mobile map packages created with the OfflineMapTask will only contain one map.

      If you display the map by setting the map on a MapView, the map will automatically load. If you only need to access the map's content or metadata, you will need to load it by calling GeoModel.loadAsync().

      If the package is not loaded, an empty collection is returned.

      Returns:
      a list of maps in the mobile map package
      Since:
      100.0.0
    • getItem

      public Item getItem()
      The mobile map package's Item describing metadata about the mobile map package. The item includes the metadata about the mobile map package, such as:
      • Title
      • Snippet (summary)
      • Description
      • Tags
      • Thumbnail
      If the package was created with ArcGIS Pro, the metadata was provided by the package author. If the package was created using OfflineMapTask, the metadata was provided by the originating web map.

      A package's item will be an instance of a LocalItem.

      Returns:
      Item
      Since:
      100.0.0
    • getPath

      public String getPath()
      Gets the path to the mobile map package.

      The path can refer to a file with an .mmpk extension or a directory containing an unpacked mobile map package.

      Returns:
      path to the .mmpk file or exploded mobile map package
      Since:
      100.0.0
      See Also:
    • getVersion

      public String getVersion()
      The mobile map package's version.

      The mobile map package version is set when the package is authored in ArcGIS Pro or when it is generated by the OfflineMapTask.

      This property will be populated when you attempt to load the package. The version property will always be populated for you to examine, even if the package is an unsupported version.

      This API supports mobile map packages up to and including major version 5.

      You may wish to check the version property before trying to access specific functionality. For example:

      • Expiration details are only available from mobile map package version 3.1 onwards.
      • Links to online services are only available from mobile map package version 4.0 onwards.
      If the package fails to load, check that the version number has not exceeded the supported major version.
      Returns:
      the mobile map package version
      Since:
      100.0.0
    • getLocatorTask

      public LocatorTask getLocatorTask()
      A LocatorTask from the mobile map package.

      Use this task to geocode and reverse-geocode addresses and places. There is only one LocatorTask in each mobile map package but it can be used by all maps.

      Returns null if there is no LocatorTask in the package or the package is not loaded.

      Returns:
      the mobile map package's locator task
      Since:
      100.0.0
    • getExpiration

      public Expiration getExpiration()
      Expiration details for this mobile map package, if provided.

      Expiration details provide:

      • The package‚Äôs expiration date and time.
      • If the maps can be accessed after expiration.
      • Any messages relevant for the user.
      These expiration details can be specified when the author creates a mobile map package using ArcGIS Pro (from version 2.4). This requires the ArcGIS Pro Publisher Extension. Mobile map packages created with the OfflineMapTask do not support expiration.

      By publishing a package with expiration details, the author can control the experience an end-user has when they try to access information that is no longer valid. For example, for time limited data (such as major sporting events), the author can ensure that the data cannot be accessed after the expiry date.

      During package loading, the API will determine whether the mobile map package was authored with expiration. If so, then this property will be populated.

      If the package has expired and was authored as ExpirationType.PREVENT_EXPIRED_ACCESS, loading will fail and you will not be able to access the maps. The expiration details will be accessible for you to examine and/or communicate to the user.

      Returns:
      the expiration details for this mobile map package, or null if the package is not loaded or no expiration date has been set
      Since:
      100.5.0
      See Also:
    • close

      public void close()
      Closes a mobile map package and frees file locks on the underlying .mmpk file or directory.

      All references to mobile map package data (maps, layers, tables, networks, locators, etc.) should be released before closing the package. If active references to mobile map package data exist, this method will still close the package, but subsequent rendering and data access methods will fail. Results of accessing mobile map package data after close are undefined.

      After closing a mobile map package, the underlying .mmpk file or directory can be moved or deleted.

      Closing a mobile map package is not necessary if the package has not been loaded.

      Since:
      100.6.0
      See Also:
    • unpackAsync

      public static ListenableFuture<Void> unpackAsync(String path, String destinationFolder)
      Unpacks a mobile map package file (.mmpk) to an output directory.

      If the last level of the output directory is not present, it will be created as part of the unpack task. The returned future can be canceled with Future.cancel(boolean) to abort the unpack.

      The unpack task writes the full content of the mobile map package to the output directory. Care should be taken on devices with limited storage space, especially if the original package is very large. After unpacking, you can remove the original .mmpk file from the device.

      Note that unpacking will fail if the package is expired and was authored as ExpirationType.PREVENT_EXPIRED_ACCESS.

      Parameters:
      path - the path to a .mmpk file
      destinationFolder - the folder to place the unpacked .mmpk
      Returns:
      a ListenableFuture. Add a listener to this to know when the unpack is done.
      Throws:
      IllegalArgumentException - if path is null or empty
      IllegalArgumentException - if destinationFolder is null or empty
      Since:
      100.2.1
    • getLoadStatus

      public LoadStatus getLoadStatus()
      Gets the value of the property loadStatus.
      Specified by:
      getLoadStatus in interface Loadable
      Property description:
      Returns:
      the LoadStatus of the loadable resource
    • getLoadError

      public ArcGISRuntimeException getLoadError()
      Gets the value of the property loadError.
      Specified by:
      getLoadError in interface Loadable
      Property description:
      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 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
      See Also:
    • loadErrorProperty

      public ReadOnlyObjectProperty<ArcGISRuntimeException> loadErrorProperty()
      Description copied from interface: Loadable
      The load error.
      Specified by:
      loadErrorProperty in interface Loadable
      See Also: