Package com.esri.arcgisruntime.tasks.tilecache

Class ExportTileCacheTask

    • Constructor Detail

      • ExportTileCacheTask

        public ExportTileCacheTask​(String url)
        Creates an ExportTileCacheTask from a URL to an ArcGIS Map Service or Image Service.
        Parameters:
        url - a URL to an ArcGIS Map Service or Image Service
        Throws:
        IllegalArgumentException - if the url is null or empty
        Since:
        100.0.0

    • Method Detail

      • getCredential

        public Credential getCredential()
        Description copied from interface: RemoteResource
        Gets the Credential that is set on the network-enabled resource.

        Only applicable if the resource is secured.

        Specified by:
        getCredential in interface RemoteResource
        Returns:
        the Credential, or null if there is none

      • setCredential

        public void setCredential​(Credential credential)
        Description copied from interface: RemoteResource
        Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

        Only applicable if the resource is secured.

        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the Credential to be used for authentication

      • getUri

        public String getUri()
        Description copied from interface: RemoteResource
        Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URI of this RemoteResource

      • getMapServiceInfo

        public ArcGISMapServiceInfo getMapServiceInfo()
        Gets the task's map service info. If the ExportTileCacheTask instance is created with a URL, this property will be populated after the task has been loaded.

        In the case of Esri provided image basemaps or elevation sources, the meta-data will be for the exported-enabled version of the service.

        Returns:
        the task's map service info
        Since:
        100.0.0

      • estimateTileCacheSize

        public EstimateTileCacheSizeJob estimateTileCacheSize​(ExportTileCacheParameters exportTileCacheParameters)
        Returns a new EstimateTileCacheSizeJob.

        Note - you need to call Job.start() to start the job.

        Parameters:
        exportTileCacheParameters - export tile cache parameters to be used in estimating
        Returns:
        an EstimateTileCacheSizeJob representing the async operation of estimating a tile cache size, the result will be an EstimateTileCacheSizeResult object if completed successfully
        Throws:
        IllegalArgumentException - if exportTileCacheParameters is null
        Since:
        100.4.0

      • exportTileCacheAsync

        @Deprecated
public ExportTileCacheJob exportTileCacheAsync​(ExportTileCacheParameters exportTileCacheParameters,
                                               String fileNameWithPath)
        Deprecated.
        As of 100.4.0, replaced by exportTileCache(ExportTileCacheParameters, String).
        Returns a new ExportTileCacheJob.

        Note - you need to call Job.start() to start the job.

        Parameters:
        exportTileCacheParameters - export tile cache parameters to be used in exporting
        fileNameWithPath - a file path, including filename, specifying the destination of the tpk when downloaded to the device. The file name must have a file extension of ".tpk", for example "/data/streets.tpk".
        Returns:
        an ExportTileCacheJob representing the async operation of exporting a tile cache, the result will be a TileCache object if completed successfully
        Throws:
        IllegalArgumentException - if exportTileCacheParameters is null
        IllegalArgumentException - if fileNameWithPath is null or doesn't end in ".tpk"
        Since:
        100.0.0

      • exportTileCache

        public ExportTileCacheJob exportTileCache​(ExportTileCacheParameters exportTileCacheParameters,
                                          String fileNameWithPath)
        Return a new export tile cache job.

        The resulting job will export tiles from the service, which is referenced by the getUri() property (or its export-enabled alternative), to a local tile cache at the fileNameWithPath. The format of the tile cache is determined by the file extension supplied in the fileNameWithPath parameter.

        • If the download file path ends with ".tpk", the tile cache will use the legacy compact format.
        • If the download file path ends with ".tpkx", the tile cache will use the current compact version 2 format.
        The job will fail if the service does not support exporting tiles, and if a .tpkx format was requested but the format is not supported by the service. The precise reason for failure is reported by ArcGISRuntimeException.getErrorCode().
        Parameters:
        exportTileCacheParameters - export tile cache parameters to be used in exporting
        fileNameWithPath - downloaded tile cache file path that ends with .tpk or .tpkx, depending on the desired format.
        Throws:
        IllegalArgumentException - if exportTileCacheParameters is null
        IllegalArgumentException - if fileNameWithPath is null
        Since:
        100.4.0
        See Also:
        ArcGISMapServiceInfo.isExportTileCacheCompactV2Allowed()

      • createDefaultExportTileCacheParametersAsync

        public ListenableFuture<ExportTileCacheParameters> createDefaultExportTileCacheParametersAsync​(Geometry areaOfInterest,
                                                                                               double minScale,
                                                                                               double maxScale)
        Creates a default set of export tile cache parameters asynchronously.

        This function is asynchronous because it makes use of the service metadata to build a ExportTileCacheParameters object. Calling the function will trigger load of the ExportTileCacheTask, unless it's already loaded.

        The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference. When a Polygon is supplied, tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting tile package. Note that the filtered set of tiles may vary, depending on the underlying service.

        The value of min_scale must be larger than the value of max_scale, unless they are 0. A min_scale value of 0 will result in this method choosing the services smallest level number, typically level 0.

        Similarly, a max_scale of 0 will result in the services largest level number being used, representing the closest in view being visible when taken offline. If min_scale is between the scales of tile levels the previous smallest level is used.

        If max_scale is between tile levels the next level is taken to ensure it is displayed. For example a simple service has 4 levels: level 0 scale 2000000; level 1 scale 1000000; level 2 scale 500000; level 3 scale 250000.

        A min_scale of 0 and max_scale of 0 selects all levels 0,1,2,3.

        A min_scale of 750000 (between levels 1 and 2) and a max_scale of 25000 (at level 3) will select levels 1,2,3.

        A min_scale of 0 and a max_scale 750000 (between 1 and 2) will select levels 0,1,2.

        A min_scale of 1000000 and a max_scale of 0 will select all levels from 1 onwards 1,2,3.

        Be careful when combining a large extent or a wide range of scales, this can result in the export failing due to exceeding the services maximum export tile count.

        Parameters:
        areaOfInterest - the geometry specifying the area to be exported, must be an Envelope or a Polygon
        minScale - the map scale '1:minScale' above which LODs should be exported, can be 0 in which case this parameter is ignored
        maxScale - the map scale '1:maxScale' below which LODs should be exported, can be 0 in which case this parameter is ignored
        Returns:
        a ListenableFuture containing the ExportTileCacheParameters object being created asynchronously
        Throws:
        IllegalArgumentException - if areaOfInterest is null or anything other than an Envelope or a Polygon
        Since:
        100.0.0

      • 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

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