com.esri.arcgis.globecore
Interface IGlobeServer

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGlobeServer2, IGlobeServer3, IGlobeServer4

All Known Implementing Classes:

GlobeServer, GlobeServerIP, GlobeServerLP

public interface IGlobeServer
extends Serializable

Provides access to members that support Globe server operations.

Superseded By

IGlobeServer2

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IGlobeServerFindResults	find(int layerID, String searchString, boolean contains, String searchFields) Returns a Globe Server Find Result object that contain the given search string.
byte[]	getAnimation() Gets the animation stream.
String	getCacheName(int layerID) Gets the virtual cache directory for a given layer.
byte[]	getConfig(int layerID) Gets the configuration file from a given layer.
byte[]	getConfiguration(int layerID) Gets all the configuration and MQT files from a given layer.
int	getLayerCount(int parentID) The number of layers in the server under a certain parent.
IGlobeLayerInfos	getLayerInfos(int parentID) A collection of Globe Layer Info objects.
IGlobeLegendInfos	getLegendInfos(ILongArray layerIDs) Returns a collection of Globe Legend Info objects for the specified layers.
byte[]	getMQT(int layerID, int face) Gets the MQT for a given face from a given layer.
byte[]	getSymbols(int layerID, ILongArray pSymbolIDs) Gets the symbols with given IDs.
byte[]	getTextures(int layerID, ILongArray pTextureIDs) Gets the textures with given IDs.
byte[]	getTile(int layerID, int face, int level, int row, int column) Gets a tile for a given tile location from a given layer.
float	getVersion() The Globe Server version number.
String	getVirtualCacheDirectory(int layerID) Gets the virtual cache directory for a given layer.
IGlobeServerIdentifyResults	identify(int layerID, int oid, IGeometry searchShape) Returns a Globe Server Identify Result object at the given location.

Method Detail

getVersion

float getVersion()
                 throws IOException,
                        AutomationException

The Globe Server version number.

Description

Returns the GlobeServer Version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

int getLayerCount(int parentID)
                  throws IOException,
                         AutomationException

The number of layers in the server under a certain parent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

parentID - The parentID (in)

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerInfos

IGlobeLayerInfos getLayerInfos(int parentID)
                               throws IOException,
                                      AutomationException

A collection of Globe Layer Info objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

parentID - The parentID (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLayerInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendInfos

IGlobeLegendInfos getLegendInfos(ILongArray layerIDs)
                                 throws IOException,
                                        AutomationException

Returns a collection of Globe Legend Info objects for the specified layers. If layerIDs is Nothing/Null or empty, legend information for all layers is returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeLegendInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfig

byte[] getConfig(int layerID)
                 throws IOException,
                        AutomationException

Gets the configuration file from a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMQT

byte[] getMQT(int layerID,
              int face)
              throws IOException,
                     AutomationException

Gets the MQT for a given face from a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

face - The face (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfiguration

byte[] getConfiguration(int layerID)
                        throws IOException,
                               AutomationException

Gets all the configuration and MQT files from a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTile

byte[] getTile(int layerID,
               int face,
               int level,
               int row,
               int column)
               throws IOException,
                      AutomationException

Gets a tile for a given tile location from a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

face - The face (in)

level - The level (in)

row - The row (in)

column - The column (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbols

byte[] getSymbols(int layerID,
                  ILongArray pSymbolIDs)
                  throws IOException,
                         AutomationException

Gets the symbols with given IDs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

pSymbolIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextures

byte[] getTextures(int layerID,
                   ILongArray pTextureIDs)
                   throws IOException,
                          AutomationException

Gets the textures with given IDs.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

pTextureIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimation

byte[] getAnimation()
                    throws IOException,
                           AutomationException

Gets the animation stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

IGlobeServerIdentifyResults identify(int layerID,
                                     int oid,
                                     IGeometry searchShape)
                                     throws IOException,
                                            AutomationException

Returns a Globe Server Identify Result object at the given location.

Description

Returns GlobeServerIdentifyResults object by taking in the LayerId to be identified, an Object ID and the geometry of the identify area, delineated by the geometry object. Note, a value of -1 should be passed as the OID value to return all objects found within the identify area.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

oid - The oid (in)

searchShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeServerIdentifyResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

IGlobeServerFindResults find(int layerID,
                             String searchString,
                             boolean contains,
                             String searchFields)
                             throws IOException,
                                    AutomationException

Returns a Globe Server Find Result object that contain the given search string.

Description

Returns GlobeServerFindResults object by taking in the LayerId used to perform Find on , a search string - representing the value to be searched, a boolen defineing wheter to search for exact match or results that contain the defind string, and a string defining which fields to search on the layer. Note passing an empty string For SearchFields will search in all available Fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

searchString - The searchString (in)

contains - The contains (in)

searchFields - The searchFields (in)

Returns:

A reference to a com.esri.arcgis.globecore.IGlobeServerFindResults

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualCacheDirectory

String getVirtualCacheDirectory(int layerID)
                                throws IOException,
                                       AutomationException

Gets the virtual cache directory for a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheName

String getCacheName(int layerID)
                    throws IOException,
                           AutomationException

Gets the virtual cache directory for a given layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

layerID - The layerID (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.