public class

ExportTileCacheParameters

extends TaskParameters
java.lang.Object
   ↳ com.esri.core.internal.tasks.TaskParameters
     ↳ com.esri.core.tasks.tilecache.ExportTileCacheParameters

Class Overview

A class representing the parameters needed to create an offline tile cache or tile package from a tiled map service supporting this operation.

See also:

Summary

Nested Classes
enum ExportTileCacheParameters.ExportBy Enum used to indicate how layers in the map service will be selected. 
Public Constructors
ExportTileCacheParameters(boolean createAsTilePackage, int minLevelOfDetail, int maxLevelOfDetail, Geometry areaOfInterest, SpatialReference inSpatialRef)
Creates a new instance of this class to be used with the ExportTileCacheTask class.
ExportTileCacheParameters(boolean createAsTilePackage, double[] levels, ExportTileCacheParameters.ExportBy exportBy, Geometry areaOfInterest, SpatialReference inSpatialRef)
Creates a new instance of this class to be used with the ExportTileCacheTask class.
Public Methods
boolean equals(Object obj)
static ExportTileCacheParameters fromJson(JsonParser parser)
Creates an instance of this class from a JSON string representation.
Map<String, String> generateRequestParams()
Generates the input parameter used by this class
double[] getLevels()
int getMaxLevelOfDetail()
int getMinLevelOfDetail()
boolean getRecompressTileCache()
Gets whether the generated tiles will be recompressed to reduce their size.
int getRecompressionQuality()
Gets the quality of the compression used during optimization.
int hashCode()
boolean isOutputToGeoWarehouse()
void setLevels(double[] levels)
void setMaxLevelOfDetail(int maxLevelOfDetail)
void setMinLevelOfDetail(int minLevelOfDetail)
void setOutputToGeoWarehouse(boolean createItem)
void setRecompressTileCache(boolean compress)
Sets whether the generated tiles will be recompressed to reduce their size.
void setRecompressionQuality(int quality)
Sets the quality of the compression used during optimization; a larger value gives a greater quality and hence a larger file size.
String toJson()
Write these parameters out to a JSON string.
boolean validate()
[Expand]
Inherited Methods
From class com.esri.core.internal.tasks.TaskParameters
From class java.lang.Object

Public Constructors

public ExportTileCacheParameters (boolean createAsTilePackage, int minLevelOfDetail, int maxLevelOfDetail, Geometry areaOfInterest, SpatialReference inSpatialRef)

Creates a new instance of this class to be used with the ExportTileCacheTask class.

Parameters
createAsTilePackage boolean: true create as tile package, false to create as compact cache
minLevelOfDetail int: smallest level of detail to include in tile package
maxLevelOfDetail int: largest level of detail to include in tile package
areaOfInterest Geometry: the extent which the generated tile cache should cover
inSpatialRef SpatialReference: the spatial reference of the area of interest

public ExportTileCacheParameters (boolean createAsTilePackage, double[] levels, ExportTileCacheParameters.ExportBy exportBy, Geometry areaOfInterest, SpatialReference inSpatialRef)

Creates a new instance of this class to be used with the ExportTileCacheTask class.

Parameters
createAsTilePackage boolean: true create as tile package, false to create as compact cache
levels double: the layers to request in the tile package or compact cache. The meaning of this parameter is set by the exportBy parameter
exportBy ExportTileCacheParameters.ExportBy: indicates whether the levels parameter is LODs, scale values or resolution values.
areaOfInterest Geometry: the extent which the generated tile cache should cover
inSpatialRef SpatialReference: the spatial reference of the area of interest

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public static ExportTileCacheParameters fromJson (JsonParser parser)

Creates an instance of this class from a JSON string representation.

Parameters
parser JsonParser: the JSON parser
Returns
ExportTileCacheParameters a new instance of this class
Throws
Exception any exception on JSON parsing

public Map<String, String> generateRequestParams ()

Generates the input parameter used by this class

Returns
Map<String, String> a Map containing the input parameters
Throws
Exception

public double[] getLevels ()

Returns
double[]

public int getMaxLevelOfDetail ()

Returns
int

public int getMinLevelOfDetail ()

Returns
int

public boolean getRecompressTileCache ()

Gets whether the generated tiles will be recompressed to reduce their size.

Returns
boolean true if the tiles will be recompressd

public int getRecompressionQuality ()

Gets the quality of the compression used during optimization.

Returns
int the compression quality

public int hashCode ()

Returns
int

public boolean isOutputToGeoWarehouse ()

Returns
boolean

public void setLevels (double[] levels)

Parameters
levels double

public void setMaxLevelOfDetail (int maxLevelOfDetail)

Parameters
maxLevelOfDetail int

public void setMinLevelOfDetail (int minLevelOfDetail)

Parameters
minLevelOfDetail int

public void setOutputToGeoWarehouse (boolean createItem)

Parameters
createItem boolean

public void setRecompressTileCache (boolean compress)

Sets whether the generated tiles will be recompressed to reduce their size.

Parameters
compress boolean: if false then a service uses its default compression value.

public void setRecompressionQuality (int quality)

Sets the quality of the compression used during optimization; a larger value gives a greater quality and hence a larger file size. Only applies when setRecompressTileCache(boolean) is set to true. This value is not used by the estimate tile cache size task.

Note: There is no point specifying a value greater than the default compression already set on the original tile. For example, if the default value is 75, the value of recompression quality should be between 0 and 75. A value greater than 75 in this example will attempt to up sample an already compressed tile and will actually lead to a larger tile package that contains poorer quality data.

Parameters
quality int: Recompression quality. Must be in the range 0-100.
Throws
IllegalArgumentException If quality invalid.

public String toJson ()

Write these parameters out to a JSON string.

Returns
String the string
Throws
IOException Signals that an I/O exception has occurred.

public boolean validate ()

Returns
boolean