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

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

All Implemented Interfaces:

GPTool

public class ExportMapServerCache
extends AbstractGPTool

Exports tiles from a map cache to a folder on disk. The tiles can either be imported into other caches or they can be accessed from ArcGIS Desktop as a raster dataset independent from their parent service. The Export Map Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• Before running this tool, create the folder on disk that will hold the exported tiles.

Field Summary

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

vals

Constructor Summary

ExportMapServerCache()
Creates the Export Map Server Cache tool with defaults.

ExportMapServerCache(String serverName, String objectName, String dataFrame, Object targetCache, int threadCount, String storageFormatType)
Creates the Export Map Server Cache tool with the required parameters.

Method Summary

String	getDataFrame() Returns the Data Frame parameter of this tool .
Object	getExportExtent() Returns the Export Extent parameter of this tool .
Object	getExportFeatureClass() Returns the Export Extent Feature Class 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 .
String	getStorageFormatType() Returns the Storage Format Type parameter of this tool .
Object	getTargetCache() Returns the Target Cache Path 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.
void	setDataFrame(String dataFrame) Sets the Data Frame parameter of this tool .
void	setExportExtent(Object exportExtent) Sets the Export Extent parameter of this tool .
void	setExportFeatureClass(Object exportFeatureClass) Sets the Export Extent Feature Class 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	setStorageFormatType(String storageFormatType) Sets the Storage Format Type parameter of this tool .
void	setTargetCache(Object targetCache) Sets the Target Cache Path parameter of this tool .
void	setThreadCount(int threadCount) Sets the Number of MapServer Instances 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

ExportMapServerCache

public ExportMapServerCache()

Creates the Export Map Server Cache tool with defaults.

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

ExportMapServerCache

public ExportMapServerCache(String serverName,
                            String objectName,
                            String dataFrame,
                            Object targetCache,
                            int threadCount,
                            String storageFormatType)

Creates the Export 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 ArcGIS Server machine hosting the service whose cache tiles will be exported.

objectName - the map service whose tiles will be exported.

dataFrame - the source data frame for the map service.

targetCache - the folder into which the cache will be exported. This folder does have to be a registered server cache directory.

threadCount - number of map service instances to use while exporting the cache. 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 Properties, then raise this parameter when you run the tool.

storageFormatType - the storage format of the exported cache

Method Detail

getServerName

public String getServerName()

Returns the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the service whose cache tiles will be exported. 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 ArcGIS Server machine hosting the service whose cache tiles will be exported. This is a required parameter.

Parameters:

serverName - the ArcGIS Server machine hosting the service whose cache tiles will be exported.

getObjectName

public String getObjectName()

Returns the Map Server parameter of this tool . This parameter is the map service whose tiles will be exported. 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 map service whose tiles will be exported. This is a required parameter.

Parameters:

objectName - the map service whose tiles will be exported.

getDataFrame

public 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(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.

getTargetCache

public Object getTargetCache()

Returns the Target Cache Path parameter of this tool . This parameter is the folder into which the cache will be exported. This folder does have to be a registered server cache directory. This is a required parameter.

Returns:

the Target Cache Path

setTargetCache

public void setTargetCache(Object targetCache)

Sets the Target Cache Path parameter of this tool . This parameter is the folder into which the cache will be exported. This folder does have to be a registered server cache directory. This is a required parameter.

Parameters:

targetCache - the folder into which the cache will be exported. This folder does have to be a registered server cache directory.

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 exporting the cache. 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 Properties, then raise this parameter when you run the tool. This is a required 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 exporting the cache. 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 Properties, then raise this parameter when you run the tool. This is a required parameter.

Parameters:

threadCount - number of map service instances to use while exporting the cache. 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 Properties, then raise this parameter when you run the tool.

getStorageFormatType

public String getStorageFormatType()

Returns the Storage Format Type parameter of this tool . This parameter is the storage format of the exported cache This is a required parameter.

Returns:

the Storage Format Type

setStorageFormatType

public void setStorageFormatType(String storageFormatType)

Sets the Storage Format Type parameter of this tool . This parameter is the storage format of the exported cache This is a required parameter.

Parameters:

storageFormatType - the storage format of the exported cache

getExportExtent

public Object getExportExtent()

Returns the Export Extent parameter of this tool . This parameter is a rectangular extent defining the tiles to be exported. By default the extent is set to the full extent of the service's source map. Note the optional parameter on this tool that allows you to alternatively constrain tile export to a feature class boundary. This is an optional parameter.

Returns:

the Export Extent

setExportExtent

public void setExportExtent(Object exportExtent)

Sets the Export Extent parameter of this tool . This parameter is a rectangular extent defining the tiles to be exported. By default the extent is set to the full extent of the service's source map. Note the optional parameter on this tool that allows you to alternatively constrain tile export to a feature class boundary. This is an optional parameter.

Parameters:

exportExtent - a rectangular extent defining the tiles to be exported. By default the extent is set to the full extent of the service's source map. Note the optional parameter on this tool that allows you to alternatively constrain tile export to a feature class boundary.

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is a list of scale levels at which tiles will be exported. Select scales on the basis of requirement This is an optional 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 at which tiles will be exported. Select scales on the basis of requirement This is an optional parameter.

Parameters:

levels - a list of scale levels at which tiles will be exported. Select scales on the basis of requirement

getExportFeatureClass

public Object getExportFeatureClass()

Returns the Export Extent Feature Class parameter of this tool . This parameter is a polygon feature class that defines where tiles are exported from the cache. This is useful if you want to export irregularly-shaped areas. This is an optional parameter.

Returns:

the Export Extent Feature Class

setExportFeatureClass

public void setExportFeatureClass(Object exportFeatureClass)

Sets the Export Extent Feature Class parameter of this tool . This parameter is a polygon feature class that defines where tiles are exported from the cache. This is useful if you want to export irregularly-shaped areas. This is an optional parameter.

Parameters:

exportFeatureClass - a polygon feature class that defines where tiles are exported from the cache. This is useful if you want to export irregularly-shaped areas.

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