Class ExportVectorTilesTask

  • All Implemented Interfaces:
    ApiKeyResource, RemoteResource, Loadable

    public final class ExportVectorTilesTask
    extends Object
    implements Loadable, RemoteResource, ApiKeyResource
    A task used to export vector tiles and optionally a portal item's vector tile style resources.

    Vector tiles are exported as a vector tile package (.vtpk) file, see VectorTileCache. A portal item can contain a custom style resources overriding the vector tile services default style and this can be checked with hasStyleResources(). The custom style is exported separately as an ItemResourceCache.

    The export vector tiles task can be initialized with a URL using ExportVectorTilesTask(String). The URL can be to:

    • A vector tile server that ends in "VectorTileServer" and is the REST end-point used to export vector tile packages. The vector tile service must be enabled for export or the task will fail to load.
    • A portal item for a vector tile service or a vector tiled layer with a custom style applied.
    • A vector basemap layer created using a BasemapStyle.
    Alternatively a PortalItem, referencing a vector tile service or a custom style for a vector tiled layer, can be used with ExportVectorTilesTask(PortalItem). When using Esri provided vector basemaps that do not support exporting tiles (such as the ArcGIS streets basemap - see BasemapStyle.ARCGIS_STREETS), an alternative service that supports exporting tiles will be used instead.
    Since:
    100.2.0
    • Constructor Detail

      • ExportVectorTilesTask

        public ExportVectorTilesTask​(String url)
        Creates an export vector tiles task with a URL to a vector tile service.

        The URL can be for:

        • A vector tile server that ends in "VectorTileServer" and is the REST end-point used to export vector tile packages. The vector tile service must be enabled for export or the task will fail to load.
        • A portal item for a vector tile service or a vector tiled layer with a custom style applied.
        • A vector basemap layer created using a BasemapStyle.
        If the URL represents a PortalItem that can be used to download vector tiles or style resources, the getPortalItem() property will be populated when the task is loaded.
        Parameters:
        url - the URL of a service or portal item to be used for exporting vector tiles
        Throws:
        IllegalArgumentException - if url is null or empty
        Since:
        100.2.0
      • ExportVectorTilesTask

        public ExportVectorTilesTask​(PortalItem portalItem)
        Creates an ExportVectorTilesTask from a portal item. The portal item must represent an ArcGIS vector tile service that supports vector tiles export.

        If the portal item is not of type PortalItem.Type.VECTOR_TILE_SERVICE, the task will fail to load.

        The portal item will reference a vector tile service, and once the task is loaded, the getUri() property will be populated to the backing service.

        This portal item can also contain custom style resources (hasStyleResources()) which can be exported with exportStyleResourceCache(String).

        Parameters:
        portalItem - a portal item instance
        Throws:
        IllegalArgumentException - if portalItem is null
        Since:
        100.2.0
    • Method Detail

      • 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.
        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the Credential to be used for authentication
      • getUri

        public String getUri()
        Gets URL for exporting vector tiles.

        The URL can be the URL of:

        • A vector tile server that ends in "VectorTileServer" and is the REST end-point used to export vector tile packages. The vector tile service must be enabled for export or the task will fail to load.
        • A portal item for a vector tile service or a vector tiled layer with a custom style applied.
        • A vector basemap layer created using a BasemapStyle.
        If the URL represents a PortalItem that can be used to download vector tiles or style resources, the getPortalItem() property will be populated when the task is loaded.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URL for exporting vector tiles, or null if the task has not been loaded
        Since:
        100.2.0
      • createDefaultExportVectorTilesParametersAsync

        public ListenableFuture<ExportVectorTilesParameters> createDefaultExportVectorTilesParametersAsync​(Geometry areaOfInterest,
                                                                                                           double maxScale)
        Creates a default set of export vector tile parameters asynchronously.

        Be careful when you provide a large area of interest or a small maxScale value as this could result in a large number of tiles being requested. If the number of tiles requested exceeds the service's maximum export tile count the ExportVectorTilesJob will fail.

        The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference.

        Where a Polygon is supplied, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service.

        Parameters:
        areaOfInterest - the geometry specifying the area to be exported, cannot be null.
        maxScale - the map scale '1:maxScale' below which levels of details should be exported, set the value to 0 to include all levels of detail in the service
        Returns:
        a ListenableFuture containing the ExportVectorTilesParameters object being created asynchronously
        Throws:
        IllegalArgumentException - if areaOfInterest is null, or not instance of an Envelope or a Polygon
        IllegalArgumentException - if maxScale is negative
        Since:
        100.2.0
      • exportVectorTiles

        public ExportVectorTilesJob exportVectorTiles​(ExportVectorTilesParameters exportVectorTilesParameters,
                                                      String vectorTileCachePath)
        Returns a new export vector tiles job that can be used to generate and download a vector tile package containing the vector tiles specified by the parameters.
        Parameters:
        exportVectorTilesParameters - specifying which vector tiles to include in the vector tile package
        vectorTileCachePath - the file path where the vector tiles will be saved on disk, including the desired file name ending with the .vtpk file extension
        Returns:
        a new ExportVectorTilesJob to export the vector tiles from a service; note you must call Job.start() to start the job
        Throws:
        IllegalArgumentException - if exportVectorTilesParameters is null or empty
        IllegalArgumentException - if vectorTileCachePath is null, empty, or missing file extension ".vtpk"
        Since:
        100.2.0
      • exportStyleResourceCache

        public ExportVectorTilesJob exportStyleResourceCache​(String itemResourceCachePath)
        Returns a new ExportVectorTilesJob that can be used to download a custom style from a portal item as an item resource cache without a vector tile cache.

        Getting the item resource cache without a vector tile cache is useful when a number of different styles are available from the same underlying vector tile service. This avoids exporting multiple copies of the same tiles.

        Parameters:
        itemResourceCachePath - the directory path where the style file will be saved on disk
        Returns:
        a new ExportVectorTilesJob to export the custom style; note you must call Job.start() to start the job
        Throws:
        IllegalArgumentException - if itemResourceCachePath is null or empty
        Since:
        100.2.0
      • exportVectorTiles

        public ExportVectorTilesJob exportVectorTiles​(ExportVectorTilesParameters exportVectorTilesParameters,
                                                      String vectorTileCachePath,
                                                      String itemResourceCachePath)
        Returns a new export vector tiles job that can be used to generate and download a vector tile package and related custom styles as an item resource cache.
        Parameters:
        exportVectorTilesParameters - specifying which tiles to include in the vector tile package
        vectorTileCachePath - the file path where the vector tiles will be saved on disk, including the desired file name ending with the .vtpk file extension
        itemResourceCachePath - the directory path where the style file will be saved on disk
        Returns:
        a new ExportVectorTilesJob to export the vector tiles and custom style; note you must call Job.start() to start the job
        Throws:
        IllegalArgumentException - if exportVectorTilesParameters is null
        IllegalArgumentException - if vectorTileCachePath is null, empty, or missing file extension ".vtpk"
        IllegalArgumentException - if itemResourceCachePath is null or empty
        Since:
        100.2.0
      • hasStyleResources

        public boolean hasStyleResources()
        Indicates whether the task's portal item has any associated style resources that override the default style of the vector tile service.

        Style resources can be exported as an ItemResourceCache.

        Returns:
        true if the export vector tile task has been loaded and the task's portal item has style resources, otherwise false
        Since:
        100.2.0
      • getVectorTileSourceInfo

        public VectorTileSourceInfo getVectorTileSourceInfo()
        Gets the vector tile source info of the task.
        Returns:
        a VectorTileSourceInfo object, or null if the task has not been loaded
        Since:
        100.2.0
      • getPortalItem

        public PortalItem getPortalItem()
        Gets the task's portal item representing a vector tile service.
        Returns:
        the portal item of the export vector tiles task, or null if the task was initialized with a service URL
        Since:
        100.2.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