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

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

All Implemented Interfaces:

GPTool

public class ManageMapServerCacheTiles
extends AbstractGPTool

Creates and updates tiles in an existing Map Service cache. This tool is used to create new tiles or to replace missing tiles, overwrite outdated tiles, or add new tiles in new areas by specific extents or by using a polygon feature class to generate tiles by feature extents, or, in the case of a multi-layer cache, from additional layers. The Manage Map Server Cache Tiles tool is contained in the Server Tools tool box.

Software restrictions: none

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

ManageMapServerCacheTiles()
Creates the Manage Map Server Cache Tiles tool with defaults.

ManageMapServerCacheTiles(String serverName, String objectName, String dataFrame, Object layer, Object levels, String updateMode)
Creates the Manage Map Server Cache Tiles 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 .
String	getIgnoreStatus() Returns the Cache areas for all features and ignore completion status field 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.
Object	getUpdateFeatureClass() Returns the Update Extents Feature Class parameter 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	setIgnoreStatus(String ignoreStatus) Sets the Cache areas for all features and ignore completion status field 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	setUpdateFeatureClass(Object updateFeatureClass) Sets the Update Extents Feature Class 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

ManageMapServerCacheTiles

public ManageMapServerCacheTiles()

Creates the Manage Map Server Cache Tiles tool with defaults.

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

ManageMapServerCacheTiles

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

Creates the Manage Map Server Cache Tiles 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 manage the cache.

objectName - String, the name of the Map Service to use to manage the cache.

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

layer - null

levels - String, a list of scale levels to manage tiles.

updateMode - String, choose a mode for updating the cache. The three modes are:

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

Parameters:

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

Parameters:

objectName - String, the name of the Map Service to use to manage the cache.

getDataFrame

public String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is String, the map documents data frame to cache. Make sure you select the same data frame that you selected for your map server. 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 documents data frame to cache. Make sure you select the same data frame that you selected for your map server. This is a required parameter.

Parameters:

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

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

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is String, a list of scale levels to manage tiles. 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, a list of scale levels to manage tiles. This is a required parameter.

Parameters:

levels - String, a list of scale levels to manage tiles.

getUpdateMode

public String getUpdateMode()

Returns the Update Mode parameter of this tool . This parameter is String, choose a mode for updating the cache. The three 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 String, choose a mode for updating the cache. The three modes are: This is a required parameter.

Parameters:

updateMode - String, choose a mode for updating the cache. The three modes are:

getConstrainingExtent

public Object getConstrainingExtent()

Returns the Update Extent parameter of this tool . This parameter is Extent, extent in the cache to manage tiles. 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, extent in the cache to manage tiles. This is an optional parameter.

Parameters:

constrainingExtent - Extent, extent in the cache to manage tiles.

getThreadCount

public int getThreadCount()

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

Parameters:

threadCount - Long, 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

getUpdateFeatureClass

public Object getUpdateFeatureClass()

Returns the Update Extents Feature Class parameter of this tool . This parameter is Feature Class, a polygon feature class used to derive the extents for which the cache should be updated. This is an optional parameter.

Returns:

the Update Extents Feature Class

setUpdateFeatureClass

public void setUpdateFeatureClass(Object updateFeatureClass)

Sets the Update Extents Feature Class parameter of this tool . This parameter is Feature Class, a polygon feature class used to derive the extents for which the cache should be updated. This is an optional parameter.

Parameters:

updateFeatureClass - Feature Class, a polygon feature class used to derive the extents for which the cache should be updated.

getIgnoreStatus

public String getIgnoreStatus()

Returns the Cache areas for all features and ignore completion status field parameter of this tool . This parameter is String, choose Cache all features and ignore completion status field to ignore the cache completion status field and cache all feature extents. Choose Track cache completion status for each feature option to update the cache completion status to a field named Cached. A status of "Yes" is written to the Cached field after successful completion of cache generation for that feature. This is an optional parameter.

Returns:

the Cache areas for all features and ignore completion status field

setIgnoreStatus

public void setIgnoreStatus(String ignoreStatus)

Sets the Cache areas for all features and ignore completion status field parameter of this tool . This parameter is String, choose Cache all features and ignore completion status field to ignore the cache completion status field and cache all feature extents. Choose Track cache completion status for each feature option to update the cache completion status to a field named Cached. A status of "Yes" is written to the Cached field after successful completion of cache generation for that feature. This is an optional parameter.

Parameters:

ignoreStatus - String, choose Cache all features and ignore completion status field to ignore the cache completion status field and cache all feature extents. Choose Track cache completion status for each feature option to update the cache completion status to a field named Cached. A status of "Yes" is written to the Cached field after successful completion of cache generation for that feature.

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