Class MobileMapPackage

  • All Implemented Interfaces:
    Loadable

    public final class MobileMapPackage
    extends Object
    implements Loadable
    A mobile map package is a transport mechanism for mobile maps. It contains metadata about the package (description, thumbnail, etc.), one or more mobile maps, layers, data, and optionally networks and locators. Mobile map packages may contain MobileBasemapLayers. Packages are created in ArcGIS Pro.

    Mobile map packages are a major part of the offline workflow. Maps in a mobile map package can be accessed and layers can be added and removed programmatically, however mobile map packages are read-only; edits are not persisted to disk.

    MobileMapPackage implements the Loadable interface; the mobile map package contents can be accessed after the mobile map package has loaded.

    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:
    ArcGISMap, LocatorTask, TransportationNetworkDataset
    • Constructor Detail

      • MobileMapPackage

        public MobileMapPackage​(String path)
        Creates a new MobileMapPackage from the .mmpk file or exploded mobile map package at the given path. An exploded 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 Detail

      • getMaps

        public List<ArcGISMap> getMaps()
        Gets an unmodifiable list of maps contained in the mobile map package. Call loadAsync on a map before using it.
        Returns:
        a list of maps in the mobile map package
        Since:
        100.0.0
      • getItem

        public Item getItem()
        Gets the item which provides metadata of the mobile map package.
        Returns:
        Item
        Since:
        100.0.0
      • getPath

        public String getPath()
        Gets the path to the .mmpk file or exploded mobile map package that this MobileMapPackage was constructed from.
        Returns:
        path to the .mmpk file or exploded mobile map package
        Since:
        100.0.0
        See Also:
        MobileMapPackage(String)
      • getVersion

        public String getVersion()
        Gets the mobile map package version. It can be used to determine if an app can support the mobile map package.

        Compatibility is maintained for all minor version changes of a mobile map package; however a change to the major version of a mobile map package may render it incompatible with this version of the runtime. Refer to System Requirements in the Guide for more information about supported ArcGIS versions.

        If the version string is empty, then the mobile map package is not supported with this version of the runtime.

        Returns:
        the mobile map package version
        Since:
        100.0.0
      • getLocatorTask

        public LocatorTask getLocatorTask()
        Gets the locator task if the mobile map package has one. If a mobile map package is made in ArcGIS Pro using multiple locator tasks, they will be merged into one in the package. A geocode result from the locator task will contain information about which original locator task it came from.
        Returns:
        the mobile map package's locator task
        Since:
        100.0.0
        See Also:
        LocatorTask
      • getExpiration

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

        If the mobile map package was authored with expiration, this property will be populated when the package is loaded or fails to load. If the mobile map package has expired and was authored as ExpirationType.PREVENT_EXPIRED_ACCESS the loading will fail and the package can no longer be used.

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

        public static ListenableFuture<Boolean> isDirectReadSupportedAsync​(String path)
        Checks if a mobile map package file (.mmpk) contains data or functionality that can be used without unpacking. If necessary a package can be unpacked using unpackAsync(String, String).
        Parameters:
        path - the path to a .mmpk file
        Returns:
        a ListenableFuture. Add a listener to this to know when the result is ready. The result of the future indicates if direct read is supported or not.
        Throws:
        IllegalArgumentException - if path is null or empty
        Since:
        100.2.1
      • unpackAsync

        public static ListenableFuture<Void> unpackAsync​(String path,
                                                         String destinationFolder)
        Unpacks a mobile map package file (.mmpk) to an output directory. Use isDirectReadSupportedAsync(String) to determine if a package can be read without being unpacked. If the last level of the destination directory is not present, it will be created as part of unpacking.
        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()
        Description copied from interface: Loadable
        Returns the LoadStatus of the loadable resource.
        Specified by:
        getLoadStatus in interface Loadable
        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 the LoadStatus.FAILED_TO_LOAD state, either due to calling loadAsync or retryLoadAsync.

        If the resource subsequently transitions to LoadStatus.LOADED, for example if a call to retryLoadAsync completes successfully, the error is cleared out.

        Specified by:
        getLoadError in interface Loadable
        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 a pending load operation.

        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
        Tries to reload the metadata of the loadable resource asynchronously, but only if the resource failed to load previously (LoadStatus.FAILED_TO_LOAD state) or wasn't loaded to begin with ( LoadStatus.NOT_LOADED state).

        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, use the Loadable.addLoadStatusChangedListener(LoadStatusChangedListener) method 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