Package com.esri.arcgisruntime.tasks.tilecache

Class ExportTileCacheParameters

  • public final class ExportTileCacheParameters
extends java.lang.Object
    Represents the input parameters for export tile cache operations.
    Since:
    100.0.0

    • Constructor Summary

      Constructors 
      Constructor Description
      ExportTileCacheParameters()
      Creates an ExportTileCacheParameters instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Geometry getAreaOfInterest()
      Gets the geometry that represents the area of tiles to be exported.
      float getCompressionQuality()
      Gets the compression quality of the exported tiles.
      java.util.List<java.lang.Integer> getLevelIDs()
      Gets a modifiable list that specifies the tiled service levels to export.
      void setAreaOfInterest​(Geometry areaOfInterest)
      Sets the geometry that represents the area of tiles to be exported.
      void setCompressionQuality​(float compressionQuality)
      Sets the compression quality of the exported tiles.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ExportTileCacheParameters

        public ExportTileCacheParameters()
        Creates an ExportTileCacheParameters instance.
        Since:
        100.0.0

    • Method Detail

      • getAreaOfInterest

        public Geometry getAreaOfInterest()
        Gets the geometry that represents the area of tiles to be exported.

        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.

        Returns:
        the Geometry that represents the area of tiles to be exported. If null the full extent of the service will be exported.
        Since:
        100.0.0

      • setAreaOfInterest

        public void setAreaOfInterest​(Geometry areaOfInterest)
        Sets the geometry that represents the area of tiles to be exported.

        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 that represents the area of tiles to be exported; can be null in which case the full extent of the service will be exported.
        Throws:
        java.lang.IllegalArgumentException - if the geometry is not an Envelope or a Polygon
        Since:
        100.0.0

      • getCompressionQuality

        public float getCompressionQuality()
        Gets the compression quality of the exported tiles.
        Returns:
        the compression quality of the exported tiles; if the compression quality is not defined the return value is Float.NAN
        Since:
        100.0.0
        See Also:
        setCompressionQuality(float)

      • setCompressionQuality

        public void setCompressionQuality​(float compressionQuality)
        Sets the compression quality of the exported tiles. Compression quality is a value in the range of 0 and 100, or Float.NaN which represents "unset". The default value is Float.NaN.

        The value cannot be greater than the default compression already set on the original tile. For example, if the default value is 75, the value of compressionQuality must be between 0 and 75. A value greater than 75 in this example will attempt to up sample an already compressed tile and will further degrade the quality of tiles.

        Parameters:
        compressionQuality - the compression quality of the exported tiles
        Throws:
        java.lang.IllegalArgumentException - if compressionQuality is not Float.NaN and not in the range of 0 to 100
        Since:
        100.0.0

      • getLevelIDs

        public java.util.List<java.lang.Integer> getLevelIDs()
        Gets a modifiable list that specifies the tiled service levels to export. By default this list is empty but you must specify at least one level of detail. The values should correspond to Level IDs. You can specify consecutive levels (for example 1,2,3,4,5) or ranges (for example for the ranges 1-3 and 7-9 you would specify 1,2,3,7,8,9).
        Returns:
        a modifiable list of the tiled service levels to export
        Since:
        100.0.0