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

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

All Implemented Interfaces:

GPTool

public class ImportMapServerCache
extends AbstractGPTool

Imports tiles from a folder on disk into a map cache. The source folder can be a child of a registered server cache directory or it can be some other folder into which tiles have been previously exported. The target map service must have the same tiling scheme and the storage format as the source map cache. The Import Map Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• Use the Import Map Server Cache tool to import all or portions of a cache from one folder to another.

Field Summary

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

vals

Constructor Summary

ImportMapServerCache()
Creates the Import Map Server Cache tool with defaults.

ImportMapServerCache(String serverName, String objectName, String dataFrame, Object sourceCacheDataset, int threadCount)
Creates the Import Map Server Cache tool with the required parameters.

Method Summary

String	getDataFrame() Returns the Data Frame parameter of this tool .
Object	getImportExtent() Returns the Import Extent parameter of this tool .
Object	getImportFeatureClass() Returns the Import Extents 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 .
Object	getSourceCacheDataset() Returns the Source Map Server Cache 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	setImportExtent(Object importExtent) Sets the Import Extent parameter of this tool .
void	setImportFeatureClass(Object importFeatureClass) Sets the Import Extents 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	setSourceCacheDataset(Object sourceCacheDataset) Sets the Source Map Server Cache 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

ImportMapServerCache

public ImportMapServerCache()

Creates the Import Map Server Cache tool with defaults.

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

ImportMapServerCache

public ImportMapServerCache(String serverName,
                            String objectName,
                            String dataFrame,
                            Object sourceCacheDataset,
                            int threadCount)

Creates the Import 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 into which tiles will be imported.

objectName - the name of the map service into which tiles will be imported. This map service must have a tiling scheme defined that matches the tiling scheme of the tiles being imported.

dataFrame - the source data frame for the map service.

sourceCacheDataset - the path to the tiles that will be imported. This is represented by a raster dataset icon in the tool user interface. If you are scripting, it is the path to the cache folder matching the data frame name. You do not have to point this parameter at a registered server cache directory; in fact, most of the time you'll be pointing at a location on disk where tiles have been previously exported.

threadCount - number of map service instances to use while importing 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.

Method Detail

getServerName

public String getServerName()

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

Parameters:

serverName - the ArcGIS Server machine hosting the service into which tiles will be imported.

getObjectName

public String getObjectName()

Returns the Map Server parameter of this tool . This parameter is the name of the map service into which tiles will be imported. This map service must have a tiling scheme defined that matches the tiling scheme of the tiles being imported. 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 into which tiles will be imported. This map service must have a tiling scheme defined that matches the tiling scheme of the tiles being imported. This is a required parameter.

Parameters:

objectName - the name of the map service into which tiles will be imported. This map service must have a tiling scheme defined that matches the tiling scheme of the tiles being imported.

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.

getSourceCacheDataset

public Object getSourceCacheDataset()

Returns the Source Map Server Cache parameter of this tool . This parameter is the path to the tiles that will be imported. This is represented by a raster dataset icon in the tool user interface. If you are scripting, it is the path to the cache folder matching the data frame name. You do not have to point this parameter at a registered server cache directory; in fact, most of the time you'll be pointing at a location on disk where tiles have been previously exported. This is a required parameter.

Returns:

the Source Map Server Cache

setSourceCacheDataset

public void setSourceCacheDataset(Object sourceCacheDataset)

Sets the Source Map Server Cache parameter of this tool . This parameter is the path to the tiles that will be imported. This is represented by a raster dataset icon in the tool user interface. If you are scripting, it is the path to the cache folder matching the data frame name. You do not have to point this parameter at a registered server cache directory; in fact, most of the time you'll be pointing at a location on disk where tiles have been previously exported. This is a required parameter.

Parameters:

sourceCacheDataset - the path to the tiles that will be imported. This is represented by a raster dataset icon in the tool user interface. If you are scripting, it is the path to the cache folder matching the data frame name. You do not have to point this parameter at a registered server cache directory; in fact, most of the time you'll be pointing at a location on disk where tiles have been previously exported.

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 importing 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 importing 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 importing 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.

getImportExtent

public Object getImportExtent()

Returns the Import Extent parameter of this tool . This parameter is a rectangular extent defining the tiles to be imported. By default the extent is set to the full extent of the map service into which you are importing. Note the optional parameter on this tool that allows you to alternatively constrain tile import to a feature class boundary. This is an optional parameter.

Returns:

the Import Extent

setImportExtent

public void setImportExtent(Object importExtent)

Sets the Import Extent parameter of this tool . This parameter is a rectangular extent defining the tiles to be imported. By default the extent is set to the full extent of the map service into which you are importing. Note the optional parameter on this tool that allows you to alternatively constrain tile import to a feature class boundary. This is an optional parameter.

Parameters:

importExtent - a rectangular extent defining the tiles to be imported. By default the extent is set to the full extent of the map service into which you are importing. Note the optional parameter on this tool that allows you to alternatively constrain tile import 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 imported. 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 imported. This is an optional parameter.

Parameters:

levels - a list of scale levels at which tiles will be imported.

getImportFeatureClass

public Object getImportFeatureClass()

Returns the Import Extents Feature Class parameter of this tool . This parameter is a polygon feature class that defines where tiles are imported into the cache. This is useful if you want to import tiles for irregularly-shaped areas. This is an optional parameter.

Returns:

the Import Extents Feature Class

setImportFeatureClass

public void setImportFeatureClass(Object importFeatureClass)

Sets the Import Extents Feature Class parameter of this tool . This parameter is a polygon feature class that defines where tiles are imported into the cache. This is useful if you want to import tiles for irregularly-shaped areas. This is an optional parameter.

Parameters:

importFeatureClass - a polygon feature class that defines where tiles are imported into the cache. This is useful if you want to import tiles for 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