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

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

All Implemented Interfaces:

GPTool

public class UpdateGlobeServerCache
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 tool works on a single layer or on all layers of the Service. The Update Globe Server Cache tool is contained in the Server Tools tool box.

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

UpdateGlobeServerCache()
Creates the Update Globe Server Cache tool with defaults.

UpdateGlobeServerCache(String serverName, String objectName, Object layer, String lodFrom, String lodTo, String updateMode)
Creates the Update Globe Server Cache tool with the required parameters.

Method Summary

Object	getLayer() Returns the Input Layers parameter of this tool .
String	getLodFrom() Returns the From Level of Detail parameter of this tool .
String	getLodTo() Returns the To Level of Detail 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 .
String	getUpdateMode() Returns the Update Mode parameter of this tool .
void	setLayer(Object layer) Sets the Input Layers parameter of this tool .
void	setLodFrom(String lodFrom) Sets the From Level of Detail parameter of this tool .
void	setLodTo(String lodTo) Sets the To Level of Detail 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	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

UpdateGlobeServerCache

public UpdateGlobeServerCache()

Creates the Update Globe Server Cache tool with defaults.

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

UpdateGlobeServerCache

public UpdateGlobeServerCache(String serverName,
                              String objectName,
                              Object layer,
                              String lodFrom,
                              String lodTo,
                              String updateMode)

Creates the Update Globe 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 host name of the ArcGIS Server to use to update the cache.

objectName - the name of the Globe Service to use to update the cache.

layer - null

lodFrom - null

lodTo - null

updateMode - 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 the host name of the ArcGIS Server to use to update 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 the host name of the ArcGIS Server to use to update the cache. This is a required parameter.

Parameters:

serverName - the host name of the ArcGIS Server to use to update the cache.

getObjectName

public String getObjectName()

Returns the GlobeServer Object parameter of this tool . This parameter is the name of the Globe Service to use to update 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 the name of the Globe Service to use to update the cache. This is a required parameter.

Parameters:

objectName - the name of the Globe Service to use to update the cache.

getUpdateExtent

public Object getUpdateExtent()

Returns the Update Extent parameter of this tool . This parameter is choose an area of the layer for which the cache should be updated. You can do so by specifying the extent values or choosing an extent from an existing data source. choosing a new cache extent will update tiles in every level of detail that intersects that extent. This is an optional parameter.

Returns:

the Update Extent

setUpdateExtent

public void setUpdateExtent(Object updateExtent)

Sets the Update Extent parameter of this tool . This parameter is choose an area of the layer for which the cache should be updated. You can do so by specifying the extent values or choosing an extent from an existing data source. choosing a new cache extent will update tiles in every level of detail that intersects that extent. This is an optional parameter.

Parameters:

updateExtent - choose an area of the layer for which the cache should be updated. You can do so by specifying the extent values or choosing an extent from an existing data source. choosing a new cache extent will update tiles in every level of detail that intersects that extent.

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

getLodFrom

public String getLodFrom()

Returns the From Level of Detail parameter of this tool . This is a required parameter.

Returns:

the From Level of Detail

setLodFrom

public void setLodFrom(String lodFrom)

Sets the From Level of Detail parameter of this tool . This is a required parameter.

Parameters:

lodFrom - null

getLodTo

public String getLodTo()

Returns the To Level of Detail parameter of this tool . This is a required parameter.

Returns:

the To Level of Detail

setLodTo

public void setLodTo(String lodTo)

Sets the To Level of Detail parameter of this tool . This is a required parameter.

Parameters:

lodTo - null

getThreadCount

public int getThreadCount()

Returns the Number of GlobeServer instances parameter of this tool . This parameter is specifies the number of ArcGIS Server Globe Server Instances to use to create the cache. This number defaults to the maximum number of Globe Server instances specified in the Globe Service properties, but can be changed to a lesser number. 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 specifies the number of ArcGIS Server Globe Server Instances to use to create the cache. This number defaults to the maximum number of Globe Server instances specified in the Globe Service properties, but can be changed to a lesser number. This is an optional parameter.

Parameters:

threadCount - specifies the number of ArcGIS Server Globe Server Instances to use to create the cache. This number defaults to the maximum number of Globe Server instances specified in the Globe Service properties, but can be changed to a lesser number.

getUpdateMode

public String getUpdateMode()

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

Parameters:

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

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