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

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

All Implemented Interfaces:

GPTool

public class GenerateMapServerCacheTilingScheme
extends AbstractGPTool

Generates an XML tiling scheme file that defines the scale levels, tile dimensions, and other properties for a map service cache. This tool is useful when creating a tiling scheme to use in multiple caches. You can load the tiling scheme file when you create a cache in ArcCatalog or Manager, or you can run Create Map Server Cache and pass in the tiling scheme file as a parameter. The Generate Map Server Cache Tiling Scheme tool is contained in the Server Tools tool box.

Usage tips:

• If you've already defined a cache in ArcCatalog or Manager, then you do not have to run this tool. You will already have a tiling scheme (conf.xml) in the cache folder, which you can reference when you create other caches.
• By default, the tiling origin starts at the upper left of the coordinate system used by the service's source map document.
• Once the cache has been created, the scale levels are the only part of the tiling scheme that can be changed. Use to add or remove scale levels.

Field Summary

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

vals

Constructor Summary

GenerateMapServerCacheTilingScheme()
Creates the Generate Map Server Cache Tiling Scheme tool with defaults.

GenerateMapServerCacheTilingScheme(Object mapDocument, String dataFrame, Object tileOrigin, Object tilingSchema, int cacheLevels, Object levels, int dpi, int tileWidth, int tileHeight)
Creates the Generate Map Server Cache Tiling Scheme tool with the required parameters.

Method Summary

int	getCacheLevels() Returns the Number of Scales 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	getLevels() Returns the Scales parameter of this tool .
Object	getMapDocument() Returns the Map Document 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 Output 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	setCacheLevels(int cacheLevels) Sets the Number of Scales 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	setLevels(Object levels) Sets the Scales parameter of this tool .
void	setMapDocument(Object mapDocument) Sets the Map Document 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 Output 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

GenerateMapServerCacheTilingScheme

public GenerateMapServerCacheTilingScheme()

Creates the Generate Map Server Cache Tiling Scheme tool with defaults.

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

GenerateMapServerCacheTilingScheme

public GenerateMapServerCacheTilingScheme(Object mapDocument,
                                          String dataFrame,
                                          Object tileOrigin,
                                          Object tilingSchema,
                                          int cacheLevels,
                                          Object levels,
                                          int dpi,
                                          int tileWidth,
                                          int tileHeight)

Creates the Generate Map Server Cache Tiling Scheme 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:

mapDocument - the source map document to be used for the tiling scheme.

dataFrame - the data frame to be used for the tiling scheme.

tileOrigin - the upper left corner of the tiling scheme in coordinates of the spatial reference of the source data frame.

tilingSchema - path and file name of the tiling scheme file to create.

cacheLevels - number of scale levels in the tiling scheme.

levels - scale levels to include in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on.

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 of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 512.

tileHeight - the height of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 512.

Method Detail

getMapDocument

public Object getMapDocument()

Returns the Map Document parameter of this tool . This parameter is the source map document to be used for the tiling scheme. This is a required parameter.

Returns:

the Map Document

setMapDocument

public void setMapDocument(Object mapDocument)

Sets the Map Document parameter of this tool . This parameter is the source map document to be used for the tiling scheme. This is a required parameter.

Parameters:

mapDocument - the source map document to be used for the tiling scheme.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the data frame to be used for the tiling scheme. 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 data frame to be used for the tiling scheme. This is a required parameter.

Parameters:

dataFrame - the data frame to be used for the tiling scheme.

getTileOrigin

public Object getTileOrigin()

Returns the Tiling origin in map units parameter of this tool . This parameter is the upper left corner of the tiling scheme in coordinates of the spatial reference of the source data frame. This is a required 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 the upper left corner of the tiling scheme in coordinates of the spatial reference of the source data frame. This is a required parameter.

Parameters:

tileOrigin - the upper left corner of the tiling scheme in coordinates of the spatial reference of the source data frame.

getTilingSchema

public Object getTilingSchema()

Returns the Output Tiling Scheme parameter of this tool . This parameter is path and file name of the tiling scheme file to create. This is a required parameter.

Returns:

the Output Tiling Scheme

setTilingSchema

public void setTilingSchema(Object tilingSchema)

Sets the Output Tiling Scheme parameter of this tool . This parameter is path and file name of the tiling scheme file to create. This is a required parameter.

Parameters:

tilingSchema - path and file name of the tiling scheme file to create.

getCacheLevels

public int getCacheLevels()

Returns the Number of Scales parameter of this tool . This parameter is number of scale levels in the tiling scheme. This is a required parameter.

Returns:

the Number of Scales

setCacheLevels

public void setCacheLevels(int cacheLevels)

Sets the Number of Scales parameter of this tool . This parameter is number of scale levels in the tiling scheme. This is a required parameter.

Parameters:

cacheLevels - number of scale levels in the tiling scheme.

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is scale levels to include in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on. This is a required parameter.

Returns:

the Scales

setLevels

public void setLevels(Object levels)

Sets the Scales parameter of this tool . This parameter is scale levels to include in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on. This is a required parameter.

Parameters:

levels - scale levels to include in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on.

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 of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 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 of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 512. This is a required parameter.

Parameters:

tileWidth - the width of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 512.

getTileHeight

public int getTileHeight()

Returns the Tile Height (in pixels) parameter of this tool . This parameter is the height of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 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 of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 512. This is a required parameter.

Parameters:

tileHeight - the height of the cache tiles in pixels. The default is 256. For the best balance between performance and manageability, avoid deviating from standard widths of 256 or 512.

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