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, replace missing tiles, overwrite outdated tiles, and delete tiles. The Manage Map Server Cache Tiles tool is contained in the Server Tools tool box.

Usage tips:

• This tool may take a long time to run for caches that cover a large geographic extent or very large map scales. If the tool is cancelled, tile creation is stopped, but the existing tiles are not deleted. This means you can cancel the tool if you run out of time and re-run it later on the same cache using the "Recreate Empty Tiles" update mode. Another way you can continue where you've left off is to use the status tracking described below in the description of the final parameter Ignore Status.

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(java.lang.String serverName, java.lang.String objectName, java.lang.String dataFrame, java.lang.Object layer, java.lang.Object levels, java.lang.String updateMode)
Creates the Manage Map Server Cache Tiles tool with the required parameters.

Method Summary

java.lang.String	getAntialiasing() Returns the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool .
java.lang.Object	getConstrainingExtent() Returns the Update Extent parameter of this tool .
java.lang.String	getDataFrame() Returns the Data Frame parameter of this tool .
java.lang.String	getIgnoreStatus() Returns the Cache areas for all features and ignore completion status field parameter of this tool .
java.lang.Object	getLayer() Returns the Input Layers parameter of this tool .
java.lang.Object	getLevels() Returns the Scales parameter of this tool .
java.lang.String	getObjectName() Returns the Map Server parameter of this tool .
java.lang.String	getOutObjectName() Returns the Output Map Server parameter of this tool (Read only).
java.lang.String	getOutServerName() Returns the Output Host parameter of this tool (Read only).
java.lang.String	getServerName() Returns the Host parameter of this tool .
int	getThreadCount() Returns the Number of MapServer Instances parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
java.lang.Object	getUpdateFeatureClass() Returns the Update Extents Feature Class parameter of this tool .
java.lang.String	getUpdateMode() Returns the Update Mode parameter of this tool .
void	setAntialiasing(java.lang.String antialiasing) Sets the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool .
void	setConstrainingExtent(java.lang.Object constrainingExtent) Sets the Update Extent parameter of this tool .
void	setDataFrame(java.lang.String dataFrame) Sets the Data Frame parameter of this tool .
void	setIgnoreStatus(java.lang.String ignoreStatus) Sets the Cache areas for all features and ignore completion status field parameter of this tool .
void	setLayer(java.lang.Object layer) Sets the Input Layers parameter of this tool .
void	setLevels(java.lang.Object levels) Sets the Scales parameter of this tool .
void	setObjectName(java.lang.String objectName) Sets the Map Server parameter of this tool .
void	setServerName(java.lang.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(java.lang.Object updateFeatureClass) Sets the Update Extents Feature Class parameter of this tool .
void	setUpdateMode(java.lang.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(java.lang.String serverName,
                                 java.lang.String objectName,
                                 java.lang.String dataFrame,
                                 java.lang.Object layer,
                                 java.lang.Object levels,
                                 java.lang.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 - the ArcGIS Server machine hosting the map service whose tiles you want to update.

objectName - the map service whose cache tiles you want to update. make sure you have a tiling scheme defined for your map service before using this tool. You can use the Caching tab of the Service Properties dialog box or the Create Map Server Cache tool to create the tiling scheme.

dataFrame - the source data frame for the map service.

layer - layers to remove from the cache.

levels - the scale levels at which you will create or delete tiles when running this tool, depending on the Update Mode.

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

Method Detail

getServerName

public java.lang.String getServerName()

Returns the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the map service whose tiles you want to update. This is a required parameter.

Returns:

the Host

setServerName

public void setServerName(java.lang.String serverName)

Sets the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the map service whose tiles you want to update. This is a required parameter.

Parameters:

serverName - the ArcGIS Server machine hosting the map service whose tiles you want to update.

getObjectName

public java.lang.String getObjectName()

Returns the Map Server parameter of this tool . This parameter is the map service whose cache tiles you want to update. make sure you have a tiling scheme defined for your map service before using this tool. You can use the Caching tab of the Service Properties dialog box or the Create Map Server Cache tool to create the tiling scheme. This is a required parameter.

Returns:

the Map Server

setObjectName

public void setObjectName(java.lang.String objectName)

Sets the Map Server parameter of this tool . This parameter is the map service whose cache tiles you want to update. make sure you have a tiling scheme defined for your map service before using this tool. You can use the Caching tab of the Service Properties dialog box or the Create Map Server Cache tool to create the tiling scheme. This is a required parameter.

Parameters:

objectName - the map service whose cache tiles you want to update. make sure you have a tiling scheme defined for your map service before using this tool. You can use the Caching tab of the Service Properties dialog box or the Create Map Server Cache tool to create the tiling scheme.

getDataFrame

public java.lang.String getDataFrame()

Returns the Data Frame parameter of this tool . This parameter is the source data frame for the map service. This is a required parameter.

Returns:

the Data Frame

setDataFrame

public void setDataFrame(java.lang.String dataFrame)

Sets the Data Frame parameter of this tool . This parameter is the source data frame for the map service. This is a required parameter.

Parameters:

dataFrame - the source data frame for the map service.

getLayer

public java.lang.Object getLayer()

Returns the Input Layers parameter of this tool . This parameter is layers to remove from the cache. This is a required parameter.

Returns:

the Input Layers

setLayer

public void setLayer(java.lang.Object layer)

Sets the Input Layers parameter of this tool . This parameter is layers to remove from the cache. This is a required parameter.

Parameters:

layer - layers to remove from the cache.

getLevels

public java.lang.Object getLevels()

Returns the Scales parameter of this tool . This parameter is the scale levels at which you will create or delete tiles when running this tool, depending on the Update Mode. This is a required parameter.

Returns:

the Scales

setLevels

public void setLevels(java.lang.Object levels)

Sets the Scales parameter of this tool . This parameter is the scale levels at which you will create or delete tiles when running this tool, depending on the Update Mode. This is a required parameter.

Parameters:

levels - the scale levels at which you will create or delete tiles when running this tool, depending on the Update Mode.

getUpdateMode

public java.lang.String getUpdateMode()

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

Returns:

the Update Mode

setUpdateMode

public void setUpdateMode(java.lang.String updateMode)

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

Parameters:

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

getConstrainingExtent

public java.lang.Object getConstrainingExtent()

Returns the Update Extent parameter of this tool . This parameter is rectangular extent at which to create or delete tiles, depending on the Update Mode. This is an optional parameter.

Returns:

the Update Extent

setConstrainingExtent

public void setConstrainingExtent(java.lang.Object constrainingExtent)

Sets the Update Extent parameter of this tool . This parameter is rectangular extent at which to create or delete tiles, depending on the Update Mode. This is an optional parameter.

Parameters:

constrainingExtent - rectangular extent at which to create or delete tiles, depending on the Update Mode.

getThreadCount

public int getThreadCount()

Returns the Number of MapServer Instances parameter of this tool . This parameter is number of map service instances to use while running this tool. By default the maximum allowable number of instances will be used (default for an ArcGIS Server service is 2) . If you have more server power, you can raise the maximum allowable number of instances in the service's Service Properties dialog box, then raise this parameter when you run the tool. 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 service instances to use while running this tool. By default the maximum allowable number of instances will be used (default for an ArcGIS Server service is 2) . If you have more server power, you can raise the maximum allowable number of instances in the service's Service Properties dialog box, then raise this parameter when you run the tool. This is an optional parameter.

Parameters:

threadCount - number of map service instances to use while running this tool. By default the maximum allowable number of instances will be used (default for an ArcGIS Server service is 2) . If you have more server power, you can raise the maximum allowable number of instances in the service's Service Properties dialog box, then raise this parameter when you run the tool.

getAntialiasing

public java.lang.String getAntialiasing()

Returns the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool . This parameter is this is a deprecated parameter that is ignored. The antialiasing property in your tiling scheme determines if antialiasing is applied to the cache. This is an optional parameter.

Returns:

the Antialiasing (Smoothes edges of labels and lines for improved display quality)

setAntialiasing

public void setAntialiasing(java.lang.String antialiasing)

Sets the Antialiasing (Smoothes edges of labels and lines for improved display quality) parameter of this tool . This parameter is this is a deprecated parameter that is ignored. The antialiasing property in your tiling scheme determines if antialiasing is applied to the cache. This is an optional parameter.

Parameters:

antialiasing - this is a deprecated parameter that is ignored. The antialiasing property in your tiling scheme determines if antialiasing is applied to the cache.

getUpdateFeatureClass

public java.lang.Object getUpdateFeatureClass()

Returns the Update Extents Feature Class parameter of this tool . This parameter is you can use a polygon feature class to manage tiles (create, update or delete) based on the extents of features of a feature class. For example, if you are caching a country, you might supply a feature class of major urban areas. By doing so, you are requesting that the server only pre-create tiles that cover those urban areas. The rest of the areas can be cached on demand when requested by clients. This can save you time and disk space that would be consumed by creating unneeded tiles in rural areas. This is an optional parameter.

Returns:

the Update Extents Feature Class

setUpdateFeatureClass

public void setUpdateFeatureClass(java.lang.Object updateFeatureClass)

Sets the Update Extents Feature Class parameter of this tool . This parameter is you can use a polygon feature class to manage tiles (create, update or delete) based on the extents of features of a feature class. For example, if you are caching a country, you might supply a feature class of major urban areas. By doing so, you are requesting that the server only pre-create tiles that cover those urban areas. The rest of the areas can be cached on demand when requested by clients. This can save you time and disk space that would be consumed by creating unneeded tiles in rural areas. This is an optional parameter.

Parameters:

updateFeatureClass - you can use a polygon feature class to manage tiles (create, update or delete) based on the extents of features of a feature class. For example, if you are caching a country, you might supply a feature class of major urban areas. By doing so, you are requesting that the server only pre-create tiles that cover those urban areas. The rest of the areas can be cached on demand when requested by clients. This can save you time and disk space that would be consumed by creating unneeded tiles in rural areas.

getIgnoreStatus

public java.lang.String getIgnoreStatus()

Returns the Cache areas for all features and ignore completion status field parameter of this tool . This parameter is this parameter allows you to track the status of your caching if you are creating tiles based on feature class boundaries (see the update_feature_class parameter). This is an optional parameter.

Returns:

the Cache areas for all features and ignore completion status field

setIgnoreStatus

public void setIgnoreStatus(java.lang.String ignoreStatus)

Sets the Cache areas for all features and ignore completion status field parameter of this tool . This parameter is this parameter allows you to track the status of your caching if you are creating tiles based on feature class boundaries (see the update_feature_class parameter). This is an optional parameter.

Parameters:

ignoreStatus - this parameter allows you to track the status of your caching if you are creating tiles based on feature class boundaries (see the update_feature_class parameter).

getOutServerName

public java.lang.String getOutServerName()

Returns the Output Host parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Host

getOutObjectName

public java.lang.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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias