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

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

All Implemented Interfaces:

GPTool

public class UpdateMapServerCache
extends AbstractGPTool

Updates an existing Map Service cache to replace missing tiles, overwrite outdated tiles, or add new tiles in new areas or, in the case of a multi-layer cache, from additional layers. The Update Map Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• Use Recreate Empty Tiles mode to add tiles in an extent not previously cached.
• Use Recreate All Tiles to update outdated tiles.
• Before running this tool, configure the Map Service to use as many instances as possible. This will dramatically decrease cache update time.
• This tool does not accept any Environment Setting that have been specified.

Field Summary

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

vals

Constructor Summary

UpdateMapServerCache()
Creates the Update Map Server Cache tool with defaults.

UpdateMapServerCache(String serverName, String objectName, String dataFrame, Object layer, Object levels, String updateMode)
Creates the Update 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 .
Object	getConstrainingExtent() Returns the Update Extent parameter of this tool .
String	getDataFrame() Returns the Data Frame parameter of this tool .
Object	getLayer() Returns the Input Layers parameter of this tool .
Object	getLevels() Returns the Scales parameter of this tool .
String	getObjectName() Returns the Map Server 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	getServerName() Returns the Host parameter of this tool .
int	getThreadCount() Returns the Number of MapServer Instances 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.
String	getUpdateMode() Returns the Update Mode parameter 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	setConstrainingExtent(Object constrainingExtent) Sets the Update Extent parameter of this tool .
void	setDataFrame(String dataFrame) Sets the Data Frame 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	setObjectName(String objectName) Sets the Map Server 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	setUpdateMode(String updateMode) Sets the Update Mode 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

UpdateMapServerCache

public UpdateMapServerCache()

Creates the Update Map Server Cache tool with defaults.

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

UpdateMapServerCache

public UpdateMapServerCache(String serverName,
                            String objectName,
                            String dataFrame,
                            Object layer,
                            Object levels,
                            String updateMode)

Creates the Update 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 update the cache.

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

dataFrame - the map frame to cache.

layer - null

levels - a list of scale levels to update.

updateMode - choose a mode for updating the cache. The two modes are:

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 update 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 update the cache. This is a required parameter.

Parameters:

serverName - the host name of the ArcGIS Server to use to update 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 update 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 update the cache. This is a required parameter.

Parameters:

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

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the map frame 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 the map frame to cache. This is a required parameter.

Parameters:

dataFrame - the map frame to cache.

getLayer

public Object getLayer()

Returns the Input Layers parameter of this tool . This is a required parameter.

Returns:

the Input Layers

setLayer

public void setLayer(Object layer)

Sets the Input Layers parameter of this tool . This is a required parameter.

Parameters:

layer - null

getConstrainingExtent

public Object getConstrainingExtent()

Returns the Update Extent parameter of this tool . This parameter is extent in the cache to update. This is an optional parameter.

Returns:

the Update Extent

setConstrainingExtent

public void setConstrainingExtent(Object constrainingExtent)

Sets the Update Extent parameter of this tool . This parameter is extent in the cache to update. This is an optional parameter.

Parameters:

constrainingExtent - extent in the cache to update.

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is a list of scale levels to update. This is a required parameter.

Returns:

the Scales

setLevels

public void setLevels(Object levels)

Sets the Scales parameter of this tool . This parameter is a list of scale levels to update. This is a required parameter.

Parameters:

levels - a list of scale levels to update.

getUpdateMode

public String getUpdateMode()

Returns the Update Mode parameter of this tool . This parameter is choose a mode for updating the cache. The two modes are: This is a required parameter.

Returns:

the Update Mode

setUpdateMode

public void setUpdateMode(String updateMode)

Sets the Update Mode parameter of this tool . This parameter is choose a mode for updating the cache. The two modes are: This is a required parameter.

Parameters:

updateMode - choose a mode for updating the cache. The two modes are:

getThreadCount

public int getThreadCount()

Returns the Number of MapServer Instances parameter of this tool . This parameter is number of Map Server instances to use while updating 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 number of Map Server instances to use while updating the cache. This is an optional parameter.

Parameters:

threadCount - number of Map Server instances to use while updating the cache.

getAntialiasing

public String getAntialiasing()

Returns the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool . 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 is an optional parameter.

Parameters:

antialiasing - null

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