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

Creates and updates tiles in an existing globe service cache. This tool is used to create new tiles or to replace missing tiles, overwrite outdated tiles, or add new tiles. All these actions can be defined by rectangular extents or by a polygon feature class. When creating new tiles, you can choose whether to create only empty tiles, or recreate all tiles. The Manage Globe Server Cache Tiles 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 ArcGIS Server hosting the globe service. The tool will automatically list all globe services available on that server.
• Running update without specifying an extent will update the entire extent of the service.
• Update is useful to run when you need to update only a portion of the globe service cache. When specifying level_from and level_to, make sure you specify all levels at which you want tiles generated. The level_from defines the lowest level of detail you want your data cache to begin with. The level_to defines the highest resolution you want your data caching to have.
• This tool requires the 3D Analyst extension.

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 - the ArcGIS Server machine hosting the globe service whose tiles you are managing.

objectName - the globe service whose tiles will be modified.

inLayers - select the layers to include in the cache. for each layer, you need to provide a level_from, which is the level of detail at which you would like to begin caching the layer, and a level_to, which is the level of detail at which you would like to end caching the layer. If the smallest and largest levels of detail are used for level_from and level_to, respectively, a full cache will be built for the layer.

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 ArcGIS Server machine hosting the globe service whose tiles you are managing. 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 globe service whose tiles you are managing. This is a required parameter.

Parameters:

serverName - the ArcGIS Server machine hosting the globe service whose tiles you are managing.

getObjectName

public String getObjectName()

Returns the GlobeServer Object parameter of this tool . This parameter is the globe service whose tiles will be modified. 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 globe service whose tiles will be modified. This is a required parameter.

Parameters:

objectName - the globe service whose tiles will be modified.

getInLayers

public Object getInLayers()

Returns the Input Layers parameter of this tool . This parameter is select the layers to include in the cache. for each layer, you need to provide a level_from, which is the level of detail at which you would like to begin caching the layer, and a level_to, which is the level of detail at which you would like to end caching the layer. If the smallest and largest levels of detail are used for level_from and level_to, respectively, a full cache will be built for the layer. This is a required parameter.

Returns:

the Input Layers

setInLayers

public void setInLayers(Object inLayers)

Sets the Input Layers parameter of this tool . This parameter is select the layers to include in the cache. for each layer, you need to provide a level_from, which is the level of detail at which you would like to begin caching the layer, and a level_to, which is the level of detail at which you would like to end caching the layer. If the smallest and largest levels of detail are used for level_from and level_to, respectively, a full cache will be built for the layer. This is a required parameter.

Parameters:

inLayers - select the layers to include in the cache. for each layer, you need to provide a level_from, which is the level of detail at which you would like to begin caching the layer, and a level_to, which is the level of detail at which you would like to end caching the layer. If the smallest and largest levels of detail are used for level_from and level_to, respectively, a full cache will be built for the layer.

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:

getUpdateExtent

public Object getUpdateExtent()

Returns the Update Extent parameter of this tool . This parameter is rectangular extent at which tiles should be created or deleted, depending on the Update Mode. You can type the extent values or choose an extent from an existing data source. 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 rectangular extent at which tiles should be created or deleted, depending on the Update Mode. You can type the extent values or choose an extent from an existing data source. This is an optional parameter.

Parameters:

updateExtent - rectangular extent at which tiles should be created or deleted, depending on the Update Mode. You can type the extent values or choose an extent from an existing data source.

getThreadCount

public int getThreadCount()

Returns the Number of GlobeServer instances parameter of this tool . This parameter is number of globe 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 Properties, then raise this parameter when you run the tool. 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 number of globe 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 Properties, then raise this parameter when you run the tool. This is an optional parameter.

Parameters:

threadCount - number of globe 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 Properties, then raise this parameter when you run the tool.

getUpdateFeatureClass

public Object getUpdateFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is you can use a polygon feature class to manage tiles (create/update) based on the extents of features in 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 Input Feature Class

setUpdateFeatureClass

public void setUpdateFeatureClass(Object updateFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is you can use a polygon feature class to manage tiles (create/update) based on the extents of features in 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) based on the extents of features in 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 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(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).

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