com.esri.arcgis.arcglobe
Interface IGlobeDeployment

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GlobeDeployment, IGlobeDeploymentProxy

public interface IGlobeDeployment
extends java.io.Serializable

COM Interface 'IGlobeDeployment'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcGlobe.olb'

Description: 'Provides access to the Globe deployment.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID66b1ce61_2520_4c7c_9929_9d5e3e764e29
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to be deployed.
void	deploy() Perform the deployment operations.
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, java.lang.String[] pPath, java.lang.String[] foldername) The deployment cache for a layer.
void	getCachePathByIndex(int iLayer, java.lang.String[] pPath, java.lang.String[] foldername) The deployment cache path of a layer by index.
java.lang.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(java.lang.String absPath, java.lang.String[] locPath) The local path corresponding to the given absolute path.
int	getPathTableCount() The number of different cache paths accumulated.
java.lang.String	getSaveDocumentName() The full name of the new document to be saved.
java.lang.String	getSummary(boolean bEstimateSizes) The text summary describing the deployment configuration.
void	getTablePath(int index, java.lang.String[] pAbsPath, java.lang.String[] pLocPath) Get each of the absolute and local cache paths accumulated.
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, java.lang.String path, java.lang.String foldername) The deployment cache for a layer.
void	putTablePath(java.lang.String absPath, java.lang.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(java.lang.String pName) The default location for setting/copying the caches.
void	setDocument(IGMxDocument ppDoc) The deployed document.
void	setSaveDocumentName(java.lang.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.

Field Detail

IID66b1ce61_2520_4c7c_9929_9d5e3e764e29

static final int IID66b1ce61_2520_4c7c_9929_9d5e3e764e29

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setDocument

void setDocument(IGMxDocument ppDoc)
                 throws java.io.IOException,
                        AutomationException

The deployed document.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocument

IGMxDocument getDocument()
                         throws java.io.IOException,
                                AutomationException

The deployed document.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveNewDocument

void setSaveNewDocument(boolean pbSaveNew)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

pbSaveNew - The pbSaveNew (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveNewDocument

boolean isSaveNewDocument()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The pbSaveNew

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveDocumentName

void setSaveDocumentName(java.lang.String pName)
                         throws java.io.IOException,
                                AutomationException

The full name of the new document to be saved.

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSaveDocumentName

java.lang.String getSaveDocumentName()
                                     throws java.io.IOException,
                                            AutomationException

The full name of the new document to be saved.

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultCacheLocation

void setDefaultCacheLocation(java.lang.String pName)
                             throws java.io.IOException,
                                    AutomationException

The default location for setting/copying the caches.

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultCacheLocation

java.lang.String getDefaultCacheLocation()
                                         throws java.io.IOException,
                                                AutomationException

The default location for setting/copying the caches.

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayer

void addLayer(ILayer pLayer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to be deployed.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeLayer

void removeLayer(ILayer pLayer)
                 throws java.io.IOException,
                        AutomationException

Removes a layer from the deployment list.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllLayers

void removeAllLayers()
                     throws java.io.IOException,
                            AutomationException

Removes all layers from the deployment list.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

int getLayerCount()
                  throws java.io.IOException,
                         AutomationException

The number of layers to be deployed.

Returns:

The pCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

void getLayer(int iLayer,
              ILayer[] ppLayer)
              throws java.io.IOException,
                     AutomationException

Gets a layer by index.

Parameters:

iLayer - The iLayer (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCachePath

void putCachePath(ILayer pLayer,
                  java.lang.String path,
                  java.lang.String foldername)
                  throws java.io.IOException,
                         AutomationException

The deployment cache for a layer.

Parameters:

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

path - The path (in)

foldername - The foldername (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCachePath

void getCachePath(ILayer pLayer,
                  java.lang.String[] pPath,
                  java.lang.String[] foldername)
                  throws java.io.IOException,
                         AutomationException

The deployment cache for a layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCachePathByIndex

void getCachePathByIndex(int iLayer,
                         java.lang.String[] pPath,
                         java.lang.String[] foldername)
                         throws java.io.IOException,
                                AutomationException

The deployment cache path of a layer by index.

Parameters:

iLayer - The iLayer (in)

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCacheOp

void putCacheOp(ILayer pLayer,
                int op)
                throws java.io.IOException,
                       AutomationException

The operation to be performed with the cache.

Parameters:

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOp

void getCacheOp(ILayer pLayer,
                int[] pOp)
                throws java.io.IOException,
                       AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheOpByIndex

void getCacheOpByIndex(int iLayer,
                       int[] pOp)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

iLayer - The iLayer (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseLocalPaths

boolean isUseLocalPaths()
                        throws java.io.IOException,
                               AutomationException

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

Returns:

The pbUse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseLocalPaths

void setUseLocalPaths(boolean pbUse)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

pbUse - The pbUse (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathTableCount

int getPathTableCount()
                      throws java.io.IOException,
                             AutomationException

The number of different cache paths accumulated.

Returns:

The pCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTablePath

void getTablePath(int index,
                  java.lang.String[] pAbsPath,
                  java.lang.String[] pLocPath)
                  throws java.io.IOException,
                         AutomationException

Get each of the absolute and local cache paths accumulated.

Parameters:

index - The index (in)

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

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putTablePath

void putTablePath(java.lang.String absPath,
                  java.lang.String locPath)
                  throws java.io.IOException,
                         AutomationException

Set an entry in the path table.

Parameters:

absPath - The absPath (in)

locPath - The locPath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocalPath

void getLocalPath(java.lang.String absPath,
                  java.lang.String[] locPath)
                  throws java.io.IOException,
                         AutomationException

The local path corresponding to the given absolute path.

Parameters:

absPath - The absPath (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSummary

java.lang.String getSummary(boolean bEstimateSizes)
                            throws java.io.IOException,
                                   AutomationException

The text summary describing the deployment configuration.

Parameters:

bEstimateSizes - The bEstimateSizes (in)

Returns:

The pSummary

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deploy

void deploy()
            throws java.io.IOException,
                   AutomationException

Perform the deployment operations.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.