com.esri.arcgis.arcglobe
Class GlobeDeployment

java.lang.Object
  com.esri.arcgis.arcglobe.GlobeDeployment

All Implemented Interfaces:

IGlobeDeployment, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GlobeDeployment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGlobeDeployment

The ArcGlobe deployment object.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

See Also:

Serialized Form

Constructor Summary

GlobeDeployment()
Constructs a GlobeDeployment using ArcGIS Engine.

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

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to be deployed.
void	deploy() Perform the deployment operations.
boolean	equals(Object o) Compare this object with another
void	getCacheOp(ILayer pLayer, int[] pOp) The operation to be performed with the cache of a layer.
void	getCacheOpByIndex(int iLayer, int[] pOp) The operation to be performed with the cache of a layer by index.
void	getCachePath(ILayer pLayer, String[] pPath, String[] foldername) The deployment cache for a layer.
void	getCachePathByIndex(int iLayer, String[] pPath, String[] foldername) The deployment cache path of a layer by index.
static String	getClsid() getClsid.
String	getDefaultCacheLocation() The default location for setting/copying the caches.
IGMxDocument	getDocument() The deployed document.
void	getLayer(int iLayer, ILayer[] ppLayer) Gets a layer by index.
int	getLayerCount() The number of layers to be deployed.
void	getLocalPath(String absPath, String[] locPath) The local path corresponding to the given absolute path.
int	getPathTableCount() The number of different cache paths accumulated.
String	getSaveDocumentName() The full name of the new document to be saved.
String	getSummary(boolean bEstimateSizes) The text summary describing the deployment configuration.
void	getTablePath(int index, String[] pAbsPath, String[] pLocPath) Get each of the absolute and local cache paths accumulated.
int	hashCode() the hashcode for this object
boolean	isSaveNewDocument() Indicates whether a new document will be saved as opposed to modifying the current one.
boolean	isUseLocalPaths() Indicates whether to use internal local paths for data caches, given by the path table.
void	putCacheOp(ILayer pLayer, int op) The operation to be performed with the cache.
void	putCachePath(ILayer pLayer, String path, String foldername) The deployment cache for a layer.
void	putTablePath(String absPath, String locPath) Set an entry in the path table.
void	removeAllLayers() Removes all layers from the deployment list.
void	removeLayer(ILayer pLayer) Removes a layer from the deployment list.
void	setDefaultCacheLocation(String pName) The default location for setting/copying the caches.
void	setDocument(IGMxDocument ppDoc) The deployed document.
void	setSaveDocumentName(String pName) The full name of the new document to be saved.
void	setSaveNewDocument(boolean pbSaveNew) Indicates whether a new document will be saved as opposed to modifying the current one.
void	setUseLocalPaths(boolean pbUse) Indicates whether to use internal local paths for data caches, given by the path table.

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

GlobeDeployment

public GlobeDeployment()
                throws IOException,
                       UnknownHostException

Constructs a GlobeDeployment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GlobeDeployment

public GlobeDeployment(Object obj)
                throws IOException

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

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

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

setDocument

public void setDocument(IGMxDocument ppDoc)
                 throws IOException,
                        AutomationException

The deployed document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

setDocument in interface IGlobeDeployment

Parameters:

ppDoc - A reference to a com.esri.arcgis.arcglobe.IGMxDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocument

public IGMxDocument getDocument()
                         throws IOException,
                                AutomationException

The deployed document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getDocument in interface IGlobeDeployment

Returns:

A reference to a com.esri.arcgis.arcglobe.IGMxDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveNewDocument

public void setSaveNewDocument(boolean pbSaveNew)
                        throws IOException,
                               AutomationException

Indicates whether a new document will be saved as opposed to modifying the current one.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

setSaveNewDocument in interface IGlobeDeployment

Parameters:

pbSaveNew - The pbSaveNew (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveNewDocument

public boolean isSaveNewDocument()
                          throws IOException,
                                 AutomationException

Indicates whether a new document will be saved as opposed to modifying the current one.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

isSaveNewDocument in interface IGlobeDeployment

Returns:

The pbSaveNew

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveDocumentName

public void setSaveDocumentName(String pName)
                         throws IOException,
                                AutomationException

The full name of the new document to be saved.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

setSaveDocumentName in interface IGlobeDeployment

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaveDocumentName

public String getSaveDocumentName()
                           throws IOException,
                                  AutomationException

The full name of the new document to be saved.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getSaveDocumentName in interface IGlobeDeployment

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCacheLocation

public void setDefaultCacheLocation(String pName)
                             throws IOException,
                                    AutomationException

The default location for setting/copying the caches.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

setDefaultCacheLocation in interface IGlobeDeployment

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCacheLocation

public String getDefaultCacheLocation()
                               throws IOException,
                                      AutomationException

The default location for setting/copying the caches.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getDefaultCacheLocation in interface IGlobeDeployment

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(ILayer pLayer)
              throws IOException,
                     AutomationException

Adds a layer to be deployed.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

addLayer in interface IGlobeDeployment

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeLayer

public void removeLayer(ILayer pLayer)
                 throws IOException,
                        AutomationException

Removes a layer from the deployment list.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

removeLayer in interface IGlobeDeployment

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllLayers

public void removeAllLayers()
                     throws IOException,
                            AutomationException

Removes all layers from the deployment list.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

removeAllLayers in interface IGlobeDeployment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

public int getLayerCount()
                  throws IOException,
                         AutomationException

The number of layers to be deployed.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getLayerCount in interface IGlobeDeployment

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public void getLayer(int iLayer,
                     ILayer[] ppLayer)
              throws IOException,
                     AutomationException

Gets a layer by index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getLayer in interface IGlobeDeployment

Parameters:

iLayer - The iLayer (in)

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCachePath

public void putCachePath(ILayer pLayer,
                         String path,
                         String foldername)
                  throws IOException,
                         AutomationException

The deployment cache for a layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

putCachePath in interface IGlobeDeployment

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

path - The path (in)

foldername - The foldername (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCachePath

public void getCachePath(ILayer pLayer,
                         String[] pPath,
                         String[] foldername)
                  throws IOException,
                         AutomationException

The deployment cache for a layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getCachePath in interface IGlobeDeployment

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pPath - The pPath (out: use single element array)

foldername - The foldername (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCachePathByIndex

public void getCachePathByIndex(int iLayer,
                                String[] pPath,
                                String[] foldername)
                         throws IOException,
                                AutomationException

The deployment cache path of a layer by index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getCachePathByIndex in interface IGlobeDeployment

Parameters:

iLayer - The iLayer (in)

pPath - The pPath (out: use single element array)

foldername - The foldername (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCacheOp

public void putCacheOp(ILayer pLayer,
                       int op)
                throws IOException,
                       AutomationException

The operation to be performed with the cache.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

putCacheOp in interface IGlobeDeployment

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

op - A com.esri.arcgis.arcglobe.esriGlobeDeployCacheOp constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOp

public void getCacheOp(ILayer pLayer,
                       int[] pOp)
                throws IOException,
                       AutomationException

The operation to be performed with the cache of a layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getCacheOp in interface IGlobeDeployment

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pOp - A com.esri.arcgis.arcglobe.esriGlobeDeployCacheOp constant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOpByIndex

public void getCacheOpByIndex(int iLayer,
                              int[] pOp)
                       throws IOException,
                              AutomationException

The operation to be performed with the cache of a layer by index.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getCacheOpByIndex in interface IGlobeDeployment

Parameters:

iLayer - The iLayer (in)

pOp - A com.esri.arcgis.arcglobe.esriGlobeDeployCacheOp constant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseLocalPaths

public boolean isUseLocalPaths()
                        throws IOException,
                               AutomationException

Indicates whether to use internal local paths for data caches, given by the path table.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

isUseLocalPaths in interface IGlobeDeployment

Returns:

The pbUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseLocalPaths

public void setUseLocalPaths(boolean pbUse)
                      throws IOException,
                             AutomationException

Indicates whether to use internal local paths for data caches, given by the path table.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

setUseLocalPaths in interface IGlobeDeployment

Parameters:

pbUse - The pbUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathTableCount

public int getPathTableCount()
                      throws IOException,
                             AutomationException

The number of different cache paths accumulated.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getPathTableCount in interface IGlobeDeployment

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTablePath

public void getTablePath(int index,
                         String[] pAbsPath,
                         String[] pLocPath)
                  throws IOException,
                         AutomationException

Get each of the absolute and local cache paths accumulated.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getTablePath in interface IGlobeDeployment

Parameters:

index - The index (in)

pAbsPath - The pAbsPath (out: use single element array)

pLocPath - The pLocPath (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putTablePath

public void putTablePath(String absPath,
                         String locPath)
                  throws IOException,
                         AutomationException

Set an entry in the path table.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

putTablePath in interface IGlobeDeployment

Parameters:

absPath - The absPath (in)

locPath - The locPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocalPath

public void getLocalPath(String absPath,
                         String[] locPath)
                  throws IOException,
                         AutomationException

The local path corresponding to the given absolute path.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getLocalPath in interface IGlobeDeployment

Parameters:

absPath - The absPath (in)

locPath - The locPath (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSummary

public String getSummary(boolean bEstimateSizes)
                  throws IOException,
                         AutomationException

The text summary describing the deployment configuration.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

getSummary in interface IGlobeDeployment

Parameters:

bEstimateSizes - The bEstimateSizes (in)

Returns:

The pSummary

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deploy

public void deploy()
            throws IOException,
                   AutomationException

Perform the deployment operations.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:

deploy in interface IGlobeDeployment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.