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

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

All Implemented Interfaces:

GPTool

public class ManageGlobeServerCacheTiles
extends AbstractGPTool

Updates an existing Globe Service cache to replace missing tiles, overwrite outdated tiles, or add new tiles in new areas. Update Globe Server Cache 2 tool works on a single layer or on all layers of the Service. There are two modes of operation: The Manage Globe Server Cache Tiles tool is contained in the Server Tools tool box.

Software restrictions: none

Usage tips:

• This tool should be used to update an existing globe server cache. To update a cache, specify the Globe server host. The tool will automatically list all server objects available on that server.
• Running update without specifying an extent will update the entire extent of the service being for the specified levels of detail.
• Update is useful to run when you need to update only a portion of the globe services cache. When specifying the 'from' and 'To' Levels of detail make sure you specify all levels you want tiles generated for. The From Level of Detail defines the lowest level of detail you'd want your data cache to begin with. The To Level of detail defines the highest resolution you'd want your data caching to have.
• Before running this tool, configure the MapService to use as many instances as possible. This will dramatically decrease cache generation time.

Field Summary

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

vals

Constructor Summary

ManageGlobeServerCacheTiles()
Creates the Manage Globe Server Cache Tiles tool with defaults.

ManageGlobeServerCacheTiles(String serverName, String objectName, Object inLayers, String updateMode)
Creates the Manage Globe Server Cache Tiles tool with the required parameters.

Method Summary

String	getIgnoreStatus() Returns the Cache areas for all features and ignore completion status field parameter of this tool .
Object	getInLayers() Returns the Input Layers parameter of this tool .
String	getObjectName() Returns the GlobeServer Object parameter of this tool .
String	getServerName() Returns the Host parameter of this tool .
int	getThreadCount() Returns the Number of GlobeServer 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	getUpdateExtent() Returns the Update Extent parameter of this tool .
Object	getUpdateFeatureClass() Returns the Input Feature Class parameter of this tool .
String	getUpdateMode() Returns the Update Mode 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	setInLayers(Object inLayers) Sets the Input Layers parameter of this tool .
void	setObjectName(String objectName) Sets the GlobeServer Object parameter of this tool .
void	setServerName(String serverName) Sets the Host parameter of this tool .
void	setThreadCount(int threadCount) Sets the Number of GlobeServer instances parameter of this tool .
void	setUpdateExtent(Object updateExtent) Sets the Update Extent parameter of this tool .
void	setUpdateFeatureClass(Object updateFeatureClass) Sets the Input 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

ManageGlobeServerCacheTiles

public ManageGlobeServerCacheTiles()

Creates the Manage Globe Server Cache Tiles tool with defaults.

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

ManageGlobeServerCacheTiles

public ManageGlobeServerCacheTiles(String serverName,
                                   String objectName,
                                   Object inLayers,
                                   String updateMode)

Creates the Manage Globe 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 Server Object Manager (SOM) that will be used to generate the cache.

objectName - String, the name of the GlobeServer configuration that will be used to generate the cache.

inLayers - null

updateMode - String, 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 String, the host name of the ArcGIS Server Server Object Manager (SOM) that will be used to generate 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 Server Object Manager (SOM) that will be used to generate the cache. This is a required parameter.

Parameters:

serverName - String, the host name of the ArcGIS Server Server Object Manager (SOM) that will be used to generate the cache.

getObjectName

public String getObjectName()

Returns the GlobeServer Object parameter of this tool . This parameter is String, the name of the GlobeServer configuration that will be used to generate the cache. This is a required parameter.

Returns:

the GlobeServer Object

setObjectName

public void setObjectName(String objectName)

Sets the GlobeServer Object parameter of this tool . This parameter is String, the name of the GlobeServer configuration that will be used to generate the cache. This is a required parameter.

Parameters:

objectName - String, the name of the GlobeServer configuration that will be used to generate the cache.

getInLayers

public Object getInLayers()

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

Returns:

the Input Layers

setInLayers

public void setInLayers(Object inLayers)

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

Parameters:

inLayers - null

getUpdateMode

public String getUpdateMode()

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

Parameters:

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

getUpdateExtent

public Object getUpdateExtent()

Returns the Update Extent parameter of this tool . This is an optional parameter.

Returns:

the Update Extent

setUpdateExtent

public void setUpdateExtent(Object updateExtent)

Sets the Update Extent parameter of this tool . This is an optional parameter.

Parameters:

updateExtent - null

getThreadCount

public int getThreadCount()

Returns the Number of GlobeServer instances parameter of this tool . This parameter is Long, the specified number of threads to attempt to create on the client. Each thread, in turn, will try to create a server context on the globe server object to generate the cache. This is an optional parameter.

Returns:

the Number of GlobeServer instances

setThreadCount

public void setThreadCount(int threadCount)

Sets the Number of GlobeServer instances parameter of this tool . This parameter is Long, the specified number of threads to attempt to create on the client. Each thread, in turn, will try to create a server context on the globe server object to generate the cache. This is an optional parameter.

Parameters:

threadCount - Long, the specified number of threads to attempt to create on the client. Each thread, in turn, will try to create a server context on the globe server object to generate the cache.

getUpdateFeatureClass

public Object getUpdateFeatureClass()

Returns the Input Feature Class parameter of this tool . This is an optional parameter.

Returns:

the Input Feature Class

setUpdateFeatureClass

public void setUpdateFeatureClass(Object updateFeatureClass)

Sets the Input Feature Class parameter of this tool . This is an optional parameter.

Parameters:

updateFeatureClass - null

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.

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