com.esri.arcgis.globecore
Class GlobeServerLP

java.lang.Object
  com.esri.arcgis.globecore.GlobeServerLP

All Implemented Interfaces:

IAGSServerObject, IAGSServerObject2, IGlobeServer, IGlobeServer2, IGlobeServer3, IGlobeServer4, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GlobeServerLP
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerObject2, IAGSServerObject, IGlobeServer, IGlobeServer2, IGlobeServer3, IGlobeServer4

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GlobeServerLP()
Constructs a GlobeServerLP using ArcGIS Engine.

GlobeServerLP(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeServerLP theGlobeServerLP = (GlobeServerLP) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
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.
ICacheControlInfo	getCacheControlInfo() Returns cache related properties of the a GlobeServer.
String	getCacheName(int layerID) Gets the virtual cache directory for a given layer.
static String	getClsid() getClsid.
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.
IPropertySet	getDocumentInfo() A set of name-value pairs for properties set for the globe document such as Title, Subject, Author, Category, Keywords and Comments.
IName	getFullName() The AGSServerConnectionName object associated with the server object.
int	getHttpTimeout() The maximum time in seconds to wait for a response from the server (Internet only).
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[]	getTexturesEx(int layerID, ILongArray pTextureIDs, boolean getDDT) 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.
int	hashCode() the hashcode for this object
IGlobeServerIdentifyResults	identify(int layerID, int oid, IGeometry searchShape) Returns a Globe Server Identify Result object at the given location.
void	setHttpTimeout(int secs) The maximum time in seconds to wait for a response from the server (Internet only).

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GlobeServerLP

public GlobeServerLP()
              throws IOException,
                     UnknownHostException

Constructs a GlobeServerLP using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeServerLP

public GlobeServerLP(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeServerLP theGlobeServerLP = (GlobeServerLP) obj;

Construct a GlobeServerLP using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GlobeServerLP.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The AGSServerConnectionName object associated with the server object.

Product Availability

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

Specified by:

getFullName in interface IAGSServerObject2

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHttpTimeout

public void setHttpTimeout(int secs)
                    throws IOException,
                           AutomationException

The maximum time in seconds to wait for a response from the server (Internet only).

Product Availability

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

Specified by:

setHttpTimeout in interface IAGSServerObject2

Parameters:

secs - The secs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHttpTimeout

public int getHttpTimeout()
                   throws IOException,
                          AutomationException

The maximum time in seconds to wait for a response from the server (Internet only).

Product Availability

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

Specified by:

getHttpTimeout in interface IAGSServerObject2

Returns:

The secs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

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

Specified by:

getVersion in interface IGlobeServer

Returns:

The pVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

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

Specified by:

getLayerCount in interface IGlobeServer

Parameters:

parentID - The parentID (in)

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerInfos

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

Specified by:

getLayerInfos in interface IGlobeServer

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

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

Specified by:

getLegendInfos in interface IGlobeServer

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

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

Specified by:

getConfig in interface IGlobeServer

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

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

Specified by:

getMQT in interface IGlobeServer

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

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

Specified by:

getConfiguration in interface IGlobeServer

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

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

Specified by:

getTile in interface IGlobeServer

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

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

Specified by:

getSymbols in interface IGlobeServer

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

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

Specified by:

getTextures in interface IGlobeServer

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

public byte[] getAnimation()
                    throws IOException,
                           AutomationException

Gets the animation stream.

Product Availability

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

Specified by:

getAnimation in interface IGlobeServer

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

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

Specified by:

identify in interface IGlobeServer

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

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

Specified by:

find in interface IGlobeServer

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

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

Specified by:

getVirtualCacheDirectory in interface IGlobeServer

Parameters:

layerID - The layerID (in)

Returns:

The pUrl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheName

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

Specified by:

getCacheName in interface IGlobeServer

Parameters:

layerID - The layerID (in)

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheControlInfo

public ICacheControlInfo getCacheControlInfo()
                                      throws IOException,
                                             AutomationException

Returns cache related properties of the a GlobeServer.

Product Availability

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

Specified by:

getCacheControlInfo in interface IGlobeServer2

Returns:

A reference to a com.esri.arcgis.carto.ICacheControlInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTexturesEx

public byte[] getTexturesEx(int layerID,
                            ILongArray pTextureIDs,
                            boolean getDDT)
                     throws IOException,
                            AutomationException

Gets the textures with given IDs.

Product Availability

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

Specified by:

getTexturesEx in interface IGlobeServer3

Parameters:

layerID - The layerID (in)

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

getDDT - The getDDT (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentInfo

public IPropertySet getDocumentInfo()
                             throws IOException,
                                    AutomationException

A set of name-value pairs for properties set for the globe document such as Title, Subject, Author, Category, Keywords and Comments.

Product Availability

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

Specified by:

getDocumentInfo in interface IGlobeServer4

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.