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

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

public class CreateMapServerCache
extends AbstractGPTool

Creates the cache tiling scheme for a given map service based on the parameters specified in this tool. Once the tiling scheme is created use the Manage map Server Cache Tiles tool to generate tiles for your cache. The Create Map Server Cache 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
CreateMapServerCache()
          Creates the Create Map Server Cache tool with defaults.
CreateMapServerCache(String serverName, String objectName, String dataFrame, String outFolder, String tilingSchemeType, String scalesType, int numOfScales, int dpi, int tileWidth, int tileHeight)
          Creates the Create 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 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 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

CreateMapServerCache

public CreateMapServerCache()
Creates the Create Map Server Cache tool with defaults.

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


CreateMapServerCache

public CreateMapServerCache(String serverName,
                            String objectName,
                            String dataFrame,
                            String outFolder,
                            String tilingSchemeType,
                            String scalesType,
                            int numOfScales,
                            int dpi,
                            int tileWidth,
                            int tileHeight)
Creates the Create 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 - String, the host name of the ArcGIS Server to use to generate the cache.
objectName - String, the name of the Map Service to use to generate the cache.
dataFrame - String, the map from from the source map document to cache.
outFolder - String, the parent directory for this Map Service cache.
tilingSchemeType - String, nEW is the default.
scalesType - String, set the scale level
numOfScales - Long, the number of scale levels to create in the cache.
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

getServerName

public String getServerName()
Returns the Host parameter of this tool . This parameter is String, 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 String, the host name of the ArcGIS Server to use to generate the cache. This is a required parameter.

Parameters:
serverName - String, 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 String, 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 String, the name of the Map Service to use to generate the cache. This is a required parameter.

Parameters:
objectName - String, 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 String, the map from from the source map document to cache. 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 map from from the source map document to cache. This is a required parameter.

Parameters:
dataFrame - String, the map from from the source map document to cache.

getOutFolder

public String getOutFolder()
Returns the Server Cache Directory parameter of this tool . This parameter is String, 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 String, the parent directory for this Map Service cache. This is a required parameter.

Parameters:
outFolder - String, the parent directory for this Map Service cache.

getTilingSchemeType

public String getTilingSchemeType()
Returns the Tiling Scheme parameter of this tool . This parameter is String, 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 String, nEW is the default. This is a required parameter.

Parameters:
tilingSchemeType - String, nEW is the default.

getScalesType

public String getScalesType()
Returns the Scales parameter of this tool . This parameter is String, 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 String, set the scale level This is a required parameter.

Parameters:
scalesType - String, set the scale level

getNumOfScales

public int getNumOfScales()
Returns the Number of Scales parameter of this tool . This parameter is Long, 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 Long, the number of scale levels to create in the cache. This is a required parameter.

Parameters:
numOfScales - Long, 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 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.

getMapOrLayers

public String getMapOrLayers()
Returns the Cache Type parameter of this tool . This parameter is String, 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 String, choose to generate a FUSED or MULTI_LAYER cache: This is an optional parameter.

Parameters:
mapOrLayers - String, 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 String, 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 String, path to a pre-defined tiling scheme. This is an optional parameter.

Parameters:
tilingSchema - String, 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 String, 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 String, 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 - String, 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 String, 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 String, scales at which to cache the Map Service. This is an optional parameter.

Parameters:
levels - String, 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

getAntialiasing

public String getAntialiasing()
Returns the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool . This parameter is String, 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 String, 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 - String, 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 String, choose either PNG8, PNG24, PNG32 or JPEG file format for the tiles in the cache. PNG8 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 String, choose either PNG8, PNG24, PNG32 or JPEG file format for the tiles in the cache. PNG8 is the default. This is an optional parameter.

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

getTileCompressionQuality

public int getTileCompressionQuality()
Returns the Tile Compression Quality parameter of this tool . This parameter is Long, 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 Long, 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 - Long, 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