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

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

All Implemented Interfaces:

GPTool

public class GenerateGlobeServerCache
extends AbstractGPTool

Generates Globe data Caches based on ArcGlobe’s Data tiling scheme. Use this tool to generate a globe data cache using the specified globe server object. The Generate Globe Server Cache tool is contained in the Server Tools tool box.

Usage tips:

• This tool is used to create a globe cache from an existing a Globe Server Object. To build a cache using the server object, specify the Globe server host. The tool will automatically list all server objects available on that server.
• You are able to generate data cache for all the layers contained in the server object or for a single layer.
• The data caching scheme is already pre defined. Hence, as a user, all you need to specify is the ‘from’ and ‘To’ Levels of detail. The From Level of Detail defines the lowest level of detail you would want your data cache to begin with. The To Level of detail defines the highest resolution you would want your data caching to have.
• Each data cache generation thread on the client must have access to the data, otherwise that thread will not be able to be used in the generation of the cache.
• This tool does not accept any Environment Settings that have been specified.

Field Summary

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

vals

Constructor Summary

GenerateGlobeServerCache()
Creates the Generate Globe Server Cache tool with defaults.

GenerateGlobeServerCache(String serverName, String objectName, String outFolder, String lodFrom, String lodTo, Object layer)
Creates the Generate 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	getOutFolder() Returns the Server Cache Directory 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.
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	setOutFolder(String outFolder) Sets the Server Cache Directory 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 .

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

GenerateGlobeServerCache

public GenerateGlobeServerCache()

Creates the Generate Globe Server Cache tool with defaults.

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

GenerateGlobeServerCache

public GenerateGlobeServerCache(String serverName,
                                String objectName,
                                String outFolder,
                                String lodFrom,
                                String lodTo,
                                Object layer)

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

objectName - the name of the Globe Server configuration that will be used to generate the cache.

outFolder - the parent directory for this Globe Service where the data cache will reside for. The server cache directory must be registered with the server before running this tool. This directory must be read/write accessible to the ArcGIS Server Object Container account user on each SOC machine in the ArcGIS Server.

lodFrom - select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer.

lodTo - select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer.

layer - select the layers to include in the layer cache.

Method Detail

getServerName

public String getServerName()

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

Parameters:

serverName - the host name of the ArcGIS 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 the name of the Globe Server 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 the name of the Globe Server configuration that will be used to generate the cache. This is a required parameter.

Parameters:

objectName - the name of the Globe Server configuration that will be used to generate the cache.

getOutFolder

public String getOutFolder()

Returns the Server Cache Directory parameter of this tool . This parameter is the parent directory for this Globe Service where the data cache will reside for. The server cache directory must be registered with the server before running this tool. This directory must be read/write accessible to the ArcGIS Server Object Container account user on each SOC machine in the ArcGIS Server. This is a required parameter.

Returns:

the Server Cache Directory

setOutFolder

public void setOutFolder(String outFolder)

Sets the Server Cache Directory parameter of this tool . This parameter is the parent directory for this Globe Service where the data cache will reside for. The server cache directory must be registered with the server before running this tool. This directory must be read/write accessible to the ArcGIS Server Object Container account user on each SOC machine in the ArcGIS Server. This is a required parameter.

Parameters:

outFolder - the parent directory for this Globe Service where the data cache will reside for. The server cache directory must be registered with the server before running this tool. This directory must be read/write accessible to the ArcGIS Server Object Container account user on each SOC machine in the ArcGIS Server.

getLodFrom

public String getLodFrom()

Returns the From Level of Detail parameter of this tool . This parameter is select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer. 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 parameter is select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer. This is a required parameter.

Parameters:

lodFrom - select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer.

getLodTo

public String getLodTo()

Returns the To Level of Detail parameter of this tool . This parameter is select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer. 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 parameter is select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer. This is a required parameter.

Parameters:

lodTo - select the level-of-detail scale you would like to begin caching the layer. If the smallest and largest level-of-detail scales are used for the minimum and maximum, a full cache will be built for the layer.

getThreadCount

public int getThreadCount()

Returns the Number of GlobeServer instances parameter of this tool . This parameter is 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 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 - 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.

getLayer

public Object getLayer()

Returns the Input Layers parameter of this tool . This parameter is select the layers to include in the layer cache. This is a required parameter.

Returns:

the Input Layers

setLayer

public void setLayer(Object layer)

Sets the Input Layers parameter of this tool . This parameter is select the layers to include in the layer cache. This is a required parameter.

Parameters:

layer - select the layers to include in the layer cache.

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