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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.servertools.GenerateMapServerCacheTilingScheme
All Implemented Interfaces:
GPTool

public class GenerateMapServerCacheTilingScheme
extends AbstractGPTool

Generates a tiling scheme xml file for use when creating a static Map Service cache. A tiling scheme describes how clients should reference the tiles in a cache and is a mapping between the spatial reference of the source map document and the tiling grid. The tiling grid uses a level-of-detail (scale-level), row, and column reference scheme. The scheme also defines the scale levels (levels of detail) at which the cache has tiles, the size of the tiles in pixels, and the screen resolution for which the tiles are intended to be most commonly displayed. A tiling scheme is needed to generate a map cache. The file created by this tool can be used in the Generate map Server Cache geoprocessing tool. The Generate Map Server Cache Tiling Scheme tool is contained in the Server Tools tool box.

Software restrictions: none

Usage tips:


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 - String, the source map document for the tiling scheme.
dataFrame - String, the data frame from the map document used for the tiling scheme.
tileOrigin - String, the upper left corner of the tiling scheme in coordinates of the spatial reference of the source data.
tilingSchema - String, path and filename of the tiling scheme file to create.
cacheLevels - String, number of scales in the tiling scheme.
levels - String, the scale values for the tiling scheme.
dpi - Long, 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 - Long, 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 - Long, 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

getMapDocument

public Object getMapDocument()
Returns the Map Document parameter of this tool . This parameter is String, the source map document 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 String, the source map document for the tiling scheme. This is a required parameter.

Parameters:
mapDocument - String, the source map document for the tiling scheme.

getDataFrame

public String getDataFrame()
Returns the Data Frame parameter of this tool . This parameter is String, the data frame from the map document 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 String, the data frame from the map document used for the tiling scheme. This is a required parameter.

Parameters:
dataFrame - String, the data frame from the map document used for the tiling scheme.

getTileOrigin

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

Parameters:
tileOrigin - String, the upper left corner of the tiling scheme in coordinates of the spatial reference of the source data.

getTilingSchema

public Object getTilingSchema()
Returns the Output Tiling Scheme parameter of this tool . This parameter is String, path and filename 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 String, path and filename of the tiling scheme file to create. This is a required parameter.

Parameters:
tilingSchema - String, path and filename of the tiling scheme file to create.

getCacheLevels

public int getCacheLevels()
Returns the Number of Scales parameter of this tool . This parameter is String, number of scales 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 String, number of scales in the tiling scheme. This is a required parameter.

Parameters:
cacheLevels - String, number of scales in the tiling scheme.

getLevels

public Object getLevels()
Returns the Scales parameter of this tool . This parameter is String, the scale values for the tiling scheme. This is a required parameter.

Returns:
the Scales

setLevels

public void setLevels(Object levels)
Sets the Scales parameter of this tool . This parameter is String, the scale values for the tiling scheme. This is a required parameter.

Parameters:
levels - String, the scale values for the tiling scheme.

getDpi

public int getDpi()
Returns the Dots(Pixels) Per Inch parameter of this tool . This parameter is Long, 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 Long, 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 - Long, 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 Long, 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 Long, 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 - Long, 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 Long, 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 Long, 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 - Long, 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.

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