Package com.esri.arcgisruntime.mapping

Class LocalItem

    • Method Detail

      • getType

        public LocalItem.Type getType()
        Gets the type.
        Returns:
        the type
        Since:
        100.0.0

      • getOriginalPortalItemID

        public String getOriginalPortalItemID()
        Gets the original portal item id.
        Returns:
        the original portal item id
        Since:
        100.0.0

      • getPath

        public String getPath()
        Gets the path.
        Returns:
        the path
        Since:
        100.0.0

      • getPortalUrl

        public String getPortalUrl()
        Gets the URL of the portal from which this local item was downloaded.

        This property can be used in conjunction with the getOriginalPortalItemID() to find the URL of the portal from which this local item was downloaded. This can be useful when following offline map workflows as it allows you to find the URL of the online webmap. It will be empty when the local item was not created from an online resource - for example if exported from ArcGIS Pro.

        Returns:
        the portal URL, or an empty string when the local item was not created from an online resource
        Since:
        100.6.0

      • fetchDataAsync

        public ListenableFuture<InputStream> fetchDataAsync()
        Description copied from class: Item
        Executes an asynchronous operation to fetch the item data. The result is an InputStream object. You are responsible for closing the InputStream after using it.
        Specified by:
        fetchDataAsync in class Item
        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 with its cause set to an exception as follows:

      • getLoadStatus

        public LoadStatus getLoadStatus()
        Description copied from interface: Loadable
        Returns the LoadStatus of the loadable resource.
        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 the Loadable.loadAsync() or Loadable.retryLoadAsync() method.

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

        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.

      • 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().

      • 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().

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

        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.
        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.

        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.
        Parameters:
        listener - the LoadStatusChangedListener to be removed
        Returns:
        true if the listener was removed, otherwise false

      • fetchThumbnailAsync

        public ListenableFuture<byte[]> fetchThumbnailAsync()
        Executes an asynchronous operation to fetch the thumbnail for this local item. The result is a byte[] containing the thumbnail data, or null if there is no thumbnail for this local item.
        Specified by:
        fetchThumbnailAsync in class Item
        Returns:
        a ListenableFuture for tracking when the operation is done and getting the result; also allows cancellation.
        Since:
        100.0.0

      • getThumbnailData

        public byte[] getThumbnailData()
        Gets the thumbnail data for this local item.
        Specified by:
        getThumbnailData in class Item
        Returns:
        the thumbnail data, or null if there is no thumbnail for this local item
        Since:
        100.0.0

      • setThumbnailData

        public void setThumbnailData​(byte[] thumbnailData)
        Sets the thumbnail data for this local item.
        Specified by:
        setThumbnailData in class Item
        Parameters:
        thumbnailData - a byte array representing the thumbnail, or null to set no thumbnail
        Since:
        100.0.0

      • updateItemPropertiesAsync

        public ListenableFuture<Void> updateItemPropertiesAsync()
        Executes an asynchronous operation to update any local item properties that have been changed (using the setter methods). This causes the values that have been changed to be updated in the original file on disk.

        Updating properties can only be done for local items that are unpacked. For example a mobile map package file (.mmpk) can be unpacked using MobileMapPackage.unpackAsync(String, String). Once unpacked, local items within the package can be updated. To access the local item see MobileMapPackage.getItem(), and for any maps use GeoModel.getItem(). As well as mobile map packages, the local item available from an item resource cache can be updated. This is accessed using ItemResourceCache.getItem().

        Specified by:
        updateItemPropertiesAsync in class Item
        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 with its cause set to an exception as follows:
        Since:
        100.4.0