com.esri.arcgis.geoprocessing.tools.servertools
Class GenerateMapServerCache

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.servertools.GenerateMapServerCache

All Implemented Interfaces:

GPTool

public class GenerateMapServerCache
extends AbstractGPTool

Generates a cache of static image tiles for an ArcGIS Server Map Service. The Generate Map Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• This tool only works with ArcGIS Server MapServices.
• Before running this tool, configure the MapService to use as many instances as possible. This will dramatically decrease cache generation time.
• Only one data frame can be cached at a time. If other data frames are needed, separate caches must be generated that associated with separate MapServices.
• The tiling scheme determines how the client should reference the tiles in the cache. A new tiling scheme can be created, or an existing tiling scheme created with the Generate Map Server Cache Tiling Scheme tool can be used.
• Use Fused caches for most cases. All the layers in the map are composited into single images for each specified scale level, then split into many tiles.
• Use Multi-layer caches for cases where you want to toggle layers on and off.
• The Number of Scales parameter is the number of different map scales the tool will create layers for in the cache.
• Computing large map scale levels for very large map extents (such as a large state, province, or country) can result in large creation times. For example, computing a tile size for map scales larger than 1:100,000 for all of North America.
• The primary benefit of employing image-compression in your cache is to reduce the size of the image tiles to improve performance over the network. Because less data is transmitted between the client and the server, it is possible to cache large, seamless raster datasets (as large as several terabytes) and serve them quickly to a client for display. An added benefit is the significantly reduced size of the cache on disk.
• When using this tool to add additional levels (scales) to an existing cache, make sure to specify the same compression factor that was used in the original levels.
• JPEG is best used with raster data. When used with vector data, lines and text may be blurred.
• JPEG file format is not supported for multi-layer caches.
• The cache tile format cannot be changed once the cache is generated. The cache must first be deleted before switching to a different file format.
• For best performance of streaming cache tiles to clients choose the JPEG image format. For the best combination of performance and transparency support, choose the PNG8 image format.
• The Antialiasing option smoothes out the edges of lines and text, but offers little enhancement for raster images.
• This tool does not accept any Environment Settings that have been specified.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

GenerateMapServerCache()
Creates the Generate Map Server Cache tool with defaults.

GenerateMapServerCache(String serverName, String objectName, String dataFrame, String outFolder, String tilingSchemeType, String scalesType, int numOfScales, int dpi, int tileWidth, int tileHeight)
Creates the Generate Map Server Cache tool with the required parameters.

Method Summary

String	getAntialiasing() Returns the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool .
String	getCacheFormat() Returns the Cache Tile Format parameter of this tool .
String	getDataFrame() Returns the Data Frame parameter of this tool .
int	getDpi() Returns the Dots(Pixels) Per Inch parameter of this tool .
Object	getLayer() Returns the Input Layers parameter of this tool .
Object	getLevels() Returns the Scales parameter of this tool .
String	getMapOrLayers() Returns the Cache Type parameter of this tool .
int	getNumOfScales() Returns the Number of Scales parameter of this tool .
String	getObjectName() Returns the Map Server parameter of this tool .
String	getOutFolder() Returns the Server Cache Directory parameter of this tool .
String	getOutObjectName() Returns the Output Map Server parameter of this tool (Read only).
String	getOutServerName() Returns the Output Host parameter of this tool (Read only).
String	getScalesType() Returns the Scales parameter of this tool .
String	getServerName() Returns the Host parameter of this tool .
int	getThreadCount() Returns the Number of MapServer Instances parameter of this tool .
int	getTileCompressionQuality() Returns the Tile Compression Quality parameter of this tool .
int	getTileHeight() Returns the Tile Height (in pixels) parameter of this tool .
Object	getTileOrigin() Returns the Tiling origin in map units parameter of this tool .
int	getTileWidth() Returns the Tile Width (in pixels) parameter of this tool .
Object	getTilingSchema() Returns the Predefined Tiling Scheme parameter of this tool .
String	getTilingSchemeType() Returns the Tiling Scheme parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setAntialiasing(String antialiasing) Sets the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool .
void	setCacheFormat(String cacheFormat) Sets the Cache Tile Format parameter of this tool .
void	setDataFrame(String dataFrame) Sets the Data Frame parameter of this tool .
void	setDpi(int dpi) Sets the Dots(Pixels) Per Inch parameter of this tool .
void	setLayer(Object layer) Sets the Input Layers parameter of this tool .
void	setLevels(Object levels) Sets the Scales parameter of this tool .
void	setMapOrLayers(String mapOrLayers) Sets the Cache Type parameter of this tool .
void	setNumOfScales(int numOfScales) Sets the Number of Scales parameter of this tool .
void	setObjectName(String objectName) Sets the Map Server parameter of this tool .
void	setOutFolder(String outFolder) Sets the Server Cache Directory parameter of this tool .
void	setScalesType(String scalesType) Sets the Scales parameter of this tool .
void	setServerName(String serverName) Sets the Host parameter of this tool .
void	setThreadCount(int threadCount) Sets the Number of MapServer Instances parameter of this tool .
void	setTileCompressionQuality(int tileCompressionQuality) Sets the Tile Compression Quality parameter of this tool .
void	setTileHeight(int tileHeight) Sets the Tile Height (in pixels) parameter of this tool .
void	setTileOrigin(Object tileOrigin) Sets the Tiling origin in map units parameter of this tool .
void	setTileWidth(int tileWidth) Sets the Tile Width (in pixels) parameter of this tool .
void	setTilingSchema(Object tilingSchema) Sets the Predefined Tiling Scheme parameter of this tool .
void	setTilingSchemeType(String tilingSchemeType) Sets the Tiling Scheme parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateMapServerCache

public GenerateMapServerCache()

Creates the Generate Map Server Cache tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

GenerateMapServerCache

public GenerateMapServerCache(String serverName,
                              String objectName,
                              String dataFrame,
                              String outFolder,
                              String tilingSchemeType,
                              String scalesType,
                              int numOfScales,
                              int dpi,
                              int tileWidth,
                              int tileHeight)

Creates the Generate Map Server Cache tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

serverName - the host name of the ArcGIS Server to use to generate the cache.

objectName - the name of the Map Service to use to generate the cache.

dataFrame - the map documents data frame to cache. Make sure you select the same data frame that you selected for your map service.

outFolder - the parent directory for this Map Service cache.

tilingSchemeType - choose to use a NEW or PREDEFINED tiling scheme. A new tiling scheme can be defined in this tool, or a predefined scheme file (.xml) can be loaded. A predefined scheme can be created by running the Generate Map Server Cache Tiling Scheme GP Tool. nEW is the default.

scalesType - set the scale level

numOfScales - the number of scale levels to create in the cache.

dpi - the dots per inch of the intended output device. If a DPI is chosen that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96.

tileWidth - the width, in pixels, of output map tiles. Small widths map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile width is 512.

tileHeight - the height, in pixels, of output map tiles. Small heights map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile height is 512.

Method Detail

getServerName

public String getServerName()

Returns the Host parameter of this tool . This parameter is the host name of the ArcGIS Server to use to generate the cache. This is a required parameter.

Returns:

the Host

setServerName

public void setServerName(String serverName)

Sets the Host parameter of this tool . This parameter is the host name of the ArcGIS Server to use to generate the cache. This is a required parameter.

Parameters:

serverName - the host name of the ArcGIS Server to use to generate the cache.

getObjectName

public String getObjectName()

Returns the Map Server parameter of this tool . This parameter is the name of the Map Service to use to generate the cache. This is a required parameter.

Returns:

the Map Server

setObjectName

public void setObjectName(String objectName)

Sets the Map Server parameter of this tool . This parameter is the name of the Map Service to use to generate the cache. This is a required parameter.

Parameters:

objectName - the name of the Map Service to use to generate the cache.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the map documents data frame to cache. Make sure you select the same data frame that you selected for your map service. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is the map documents data frame to cache. Make sure you select the same data frame that you selected for your map service. This is a required parameter.

Parameters:

dataFrame - the map documents data frame to cache. Make sure you select the same data frame that you selected for your map service.

getOutFolder

public String getOutFolder()

Returns the Server Cache Directory parameter of this tool . This parameter is the parent directory for this Map Service cache. This is a required parameter.

Returns:

the Server Cache Directory

setOutFolder

public void setOutFolder(String outFolder)

Sets the Server Cache Directory parameter of this tool . This parameter is the parent directory for this Map Service cache. This is a required parameter.

Parameters:

outFolder - the parent directory for this Map Service cache.

getTilingSchemeType

public String getTilingSchemeType()

Returns the Tiling Scheme parameter of this tool . This parameter is choose to use a NEW or PREDEFINED tiling scheme. A new tiling scheme can be defined in this tool, or a predefined scheme file (.xml) can be loaded. A predefined scheme can be created by running the Generate Map Server Cache Tiling Scheme GP Tool. nEW is the default. This is a required parameter.

Returns:

the Tiling Scheme

setTilingSchemeType

public void setTilingSchemeType(String tilingSchemeType)

Sets the Tiling Scheme parameter of this tool . This parameter is choose to use a NEW or PREDEFINED tiling scheme. A new tiling scheme can be defined in this tool, or a predefined scheme file (.xml) can be loaded. A predefined scheme can be created by running the Generate Map Server Cache Tiling Scheme GP Tool. nEW is the default. This is a required parameter.

Parameters:

tilingSchemeType - choose to use a NEW or PREDEFINED tiling scheme. A new tiling scheme can be defined in this tool, or a predefined scheme file (.xml) can be loaded. A predefined scheme can be created by running the Generate Map Server Cache Tiling Scheme GP Tool. nEW is the default.

getScalesType

public String getScalesType()

Returns the Scales parameter of this tool . This parameter is set the scale level This is a required parameter.

Returns:

the Scales

setScalesType

public void setScalesType(String scalesType)

Sets the Scales parameter of this tool . This parameter is set the scale level This is a required parameter.

Parameters:

scalesType - set the scale level

getNumOfScales

public int getNumOfScales()

Returns the Number of Scales parameter of this tool . This parameter is the number of scale levels to create in the cache. This is a required parameter.

Returns:

the Number of Scales

setNumOfScales

public void setNumOfScales(int numOfScales)

Sets the Number of Scales parameter of this tool . This parameter is the number of scale levels to create in the cache. This is a required parameter.

Parameters:

numOfScales - the number of scale levels to create in the cache.

getDpi

public int getDpi()

Returns the Dots(Pixels) Per Inch parameter of this tool . This parameter is the dots per inch of the intended output device. If a DPI is chosen that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96. This is a required parameter.

Returns:

the Dots(Pixels) Per Inch

setDpi

public void setDpi(int dpi)

Sets the Dots(Pixels) Per Inch parameter of this tool . This parameter is the dots per inch of the intended output device. If a DPI is chosen that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96. This is a required parameter.

Parameters:

dpi - the dots per inch of the intended output device. If a DPI is chosen that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96.

getTileWidth

public int getTileWidth()

Returns the Tile Width (in pixels) parameter of this tool . This parameter is the width, in pixels, of output map tiles. Small widths map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile width is 512. This is a required parameter.

Returns:

the Tile Width (in pixels)

setTileWidth

public void setTileWidth(int tileWidth)

Sets the Tile Width (in pixels) parameter of this tool . This parameter is the width, in pixels, of output map tiles. Small widths map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile width is 512. This is a required parameter.

Parameters:

tileWidth - the width, in pixels, of output map tiles. Small widths map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile width is 512.

getTileHeight

public int getTileHeight()

Returns the Tile Height (in pixels) parameter of this tool . This parameter is the height, in pixels, of output map tiles. Small heights map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile height is 512. This is a required parameter.

Returns:

the Tile Height (in pixels)

setTileHeight

public void setTileHeight(int tileHeight)

Sets the Tile Height (in pixels) parameter of this tool . This parameter is the height, in pixels, of output map tiles. Small heights map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile height is 512. This is a required parameter.

Parameters:

tileHeight - the height, in pixels, of output map tiles. Small heights map improve performance of the application requesting tiles from the cache as less data will travel over the wire. However, smaller tile size results in a larger cache size and longer creation time. The default tile height is 512.

getMapOrLayers

public String getMapOrLayers()

Returns the Cache Type parameter of this tool . This parameter is choose to generate a FUSED or MULTI_LAYER cache: This is an optional parameter.

Returns:

the Cache Type

setMapOrLayers

public void setMapOrLayers(String mapOrLayers)

Sets the Cache Type parameter of this tool . This parameter is choose to generate a FUSED or MULTI_LAYER cache: This is an optional parameter.

Parameters:

mapOrLayers - choose to generate a FUSED or MULTI_LAYER cache:

getTilingSchema

public Object getTilingSchema()

Returns the Predefined Tiling Scheme parameter of this tool . This parameter is path to a pre-defined tiling scheme. This is an optional parameter.

Returns:

the Predefined Tiling Scheme

setTilingSchema

public void setTilingSchema(Object tilingSchema)

Sets the Predefined Tiling Scheme parameter of this tool . This parameter is path to a pre-defined tiling scheme. This is an optional parameter.

Parameters:

tilingSchema - path to a pre-defined tiling scheme.

getTileOrigin

public Object getTileOrigin()

Returns the Tiling origin in map units parameter of this tool . This parameter is specify the origin (upper left corner) of the tiling scheme in coordinates of the spatial reference of the source map document. The extent of the source map document must be within (but does not need to coincide) with this region. This is an optional parameter.

Returns:

the Tiling origin in map units

setTileOrigin

public void setTileOrigin(Object tileOrigin)

Sets the Tiling origin in map units parameter of this tool . This parameter is specify the origin (upper left corner) of the tiling scheme in coordinates of the spatial reference of the source map document. The extent of the source map document must be within (but does not need to coincide) with this region. This is an optional parameter.

Parameters:

tileOrigin - specify the origin (upper left corner) of the tiling scheme in coordinates of the spatial reference of the source map document. The extent of the source map document must be within (but does not need to coincide) with this region.

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is scales at which to cache the Map Service. This is an optional parameter.

Returns:

the Scales

setLevels

public void setLevels(Object levels)

Sets the Scales parameter of this tool . This parameter is scales at which to cache the Map Service. This is an optional parameter.

Parameters:

levels - scales at which to cache the Map Service.

getLayer

public Object getLayer()

Returns the Input Layers parameter of this tool . This is an optional parameter.

Returns:

the Input Layers

setLayer

public void setLayer(Object layer)

Sets the Input Layers parameter of this tool . This is an optional parameter.

Parameters:

layer - null

getThreadCount

public int getThreadCount()

Returns the Number of MapServer Instances parameter of this tool . This parameter is the number of MapServer Instances to use while generating the cache. This is an optional parameter.

Returns:

the Number of MapServer Instances

setThreadCount

public void setThreadCount(int threadCount)

Sets the Number of MapServer Instances parameter of this tool . This parameter is the number of MapServer Instances to use while generating the cache. This is an optional parameter.

Parameters:

threadCount - the number of MapServer Instances to use while generating the cache.

getAntialiasing

public String getAntialiasing()

Returns the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool . This parameter is choose whether to use antialiasing when rendering the tiles. If ANTIALIASING is chosen, edges of lines, borders, and text will be smoothed. There is a performance cost for this option. No benefit will be gained on raster data. This is an optional parameter.

Returns:

the Antialiasing (Smoothes edges of labels and lines for improved display quality)

setAntialiasing

public void setAntialiasing(String antialiasing)

Sets the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool . This parameter is choose whether to use antialiasing when rendering the tiles. If ANTIALIASING is chosen, edges of lines, borders, and text will be smoothed. There is a performance cost for this option. No benefit will be gained on raster data. This is an optional parameter.

Parameters:

antialiasing - choose whether to use antialiasing when rendering the tiles. If ANTIALIASING is chosen, edges of lines, borders, and text will be smoothed. There is a performance cost for this option. No benefit will be gained on raster data.

getCacheFormat

public String getCacheFormat()

Returns the Cache Tile Format parameter of this tool . This parameter is choose either PNG8, PNG24, PNG32 or JPEG file format for the tiles in the cache. PNG24 is the default. This is an optional parameter.

Returns:

the Cache Tile Format

setCacheFormat

public void setCacheFormat(String cacheFormat)

Sets the Cache Tile Format parameter of this tool . This parameter is choose either PNG8, PNG24, PNG32 or JPEG file format for the tiles in the cache. PNG24 is the default. This is an optional parameter.

Parameters:

cacheFormat - choose either PNG8, PNG24, PNG32 or JPEG file format for the tiles in the cache. PNG24 is the default.

getTileCompressionQuality

public int getTileCompressionQuality()

Returns the Tile Compression Quality parameter of this tool . This parameter is enter a value between 1 and 100 for the JPEG compression quality. The default value is 75 for JPEG tile format and zero for other formats. compression is supported only for JPEG format. The level of compression will depend on the data, but can also be controlled by changing the compression quality. Choosing a higher value will result in less compression and a higher-quality image. Choosing a lower value will result in more compression but a lower-quality image. This is an optional parameter.

Returns:

the Tile Compression Quality

setTileCompressionQuality

public void setTileCompressionQuality(int tileCompressionQuality)

Sets the Tile Compression Quality parameter of this tool . This parameter is enter a value between 1 and 100 for the JPEG compression quality. The default value is 75 for JPEG tile format and zero for other formats. compression is supported only for JPEG format. The level of compression will depend on the data, but can also be controlled by changing the compression quality. Choosing a higher value will result in less compression and a higher-quality image. Choosing a lower value will result in more compression but a lower-quality image. This is an optional parameter.

Parameters:

tileCompressionQuality - enter a value between 1 and 100 for the JPEG compression quality. The default value is 75 for JPEG tile format and zero for other formats. compression is supported only for JPEG format. The level of compression will depend on the data, but can also be controlled by changing the compression quality. Choosing a higher value will result in less compression and a higher-quality image. Choosing a lower value will result in more compression but a lower-quality image.

getOutServerName

public String getOutServerName()

Returns the Output Host parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Host

getOutObjectName

public String getOutObjectName()

Returns the Output Map Server parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Map Server

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias