com.esri.arcgis.carto
Interface IMSDHelper

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IMSDHelper2

All Known Implementing Classes:

IMSDHelper2Proxy, IMSDHelperProxy, MSDHelper

public interface IMSDHelper
extends java.io.Serializable

COM Interface 'IMSDHelper'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides methods to open, save, repair mapserver definition files.' 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	IID4c0b3fb1_b9b0_4387_b047_1b9be19098c3
static int	xxDummy Deprecated. Internal use only

Method Summary

void	close() Close the mapserver defintion file.
java.lang.String	getDataset(java.lang.String layerPath) Given the layer's catalog path, returns the dataset name.
java.lang.String	getLayerDisplayName(java.lang.String layerPath) Given the layer's catalog path, returns its TOC display name.
IStringArray	getLayers(java.lang.String mapPath) Given the map's catalog path, returns the catalog path for all layers in the map.
java.lang.String	getLayerType(java.lang.String layerPath) Given the layer's catalog path, returns the layer type.
java.lang.String	getMapDisplayName(java.lang.String mapPath) Given the map's catalog path returns the map's TOC display name.
IStringArray	getMaps() Method returns a String Array containing the catalog paths to all the maps in the msd.
IStringArray	getSubLayers(java.lang.String layerPath) Given the layer's catalog path, returns the catalog path to its sub layers, if it has any.
java.lang.String	getWorkspaceConnectionStringFromLayer(java.lang.String layerPath) Given the layer's catalog path, returns the workspace connection string.
java.lang.String	getWorkspaceFactoryType(java.lang.String layerPath) Given the layer's catalog path, returns the workspace type.
boolean	isActiveMap(java.lang.String mapPath) Given the map's catalog path, returns a boolean inidicating if it is the active map.
boolean	isLayerValid(java.lang.String layerPath) Given the layer's catalog path, returns a boolean indicating if it is valid.
void	open(java.lang.String path) Open the mapserver definition file.
void	putWorkspaceConnectionStringInLayer(java.lang.String layerPath, java.lang.String workspaceConnectionString, boolean validate) Given the layer's catalog path, updates its workspace connection string.
void	replaceAll(java.lang.String mapPath, java.lang.String oldWorkspaceConnectionString, java.lang.String newWorkspaceConnectionString, boolean validate) Replaces the workspace connection string for all layers in the given map.
void	save(boolean relativePath) Save the mapserver defintion file.
void	saveAs(java.lang.String path, boolean relativePath) Save a copy of the open mapserver definition file at the specified location with the specified name.

Field Detail

IID4c0b3fb1_b9b0_4387_b047_1b9be19098c3

static final int IID4c0b3fb1_b9b0_4387_b047_1b9be19098c3

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

open

void open(java.lang.String path)
          throws java.io.IOException,
                 AutomationException

Open the mapserver definition file.

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

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

Close the mapserver defintion file.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

void save(boolean relativePath)
          throws java.io.IOException,
                 AutomationException

Save the mapserver defintion file.

Parameters:

relativePath - The relativePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveAs

void saveAs(java.lang.String path,
            boolean relativePath)
            throws java.io.IOException,
                   AutomationException

Save a copy of the open mapserver definition file at the specified location with the specified name.

Parameters:

path - The path (in)

relativePath - The relativePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaps

IStringArray getMaps()
                     throws java.io.IOException,
                            AutomationException

Method returns a String Array containing the catalog paths to all the maps in the msd.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isActiveMap

boolean isActiveMap(java.lang.String mapPath)
                    throws java.io.IOException,
                           AutomationException

Given the map's catalog path, returns a boolean inidicating if it is the active map.

Parameters:

mapPath - The mapPath (in)

Returns:

The activeMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapDisplayName

java.lang.String getMapDisplayName(java.lang.String mapPath)
                                   throws java.io.IOException,
                                          AutomationException

Given the map's catalog path returns the map's TOC display name.

Parameters:

mapPath - The mapPath (in)

Returns:

The mapDisplayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replaceAll

void replaceAll(java.lang.String mapPath,
                java.lang.String oldWorkspaceConnectionString,
                java.lang.String newWorkspaceConnectionString,
                boolean validate)
                throws java.io.IOException,
                       AutomationException

Replaces the workspace connection string for all layers in the given map.

Parameters:

mapPath - The mapPath (in)

oldWorkspaceConnectionString - The oldWorkspaceConnectionString (in)

newWorkspaceConnectionString - The newWorkspaceConnectionString (in)

validate - The validate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayers

IStringArray getLayers(java.lang.String mapPath)
                       throws java.io.IOException,
                              AutomationException

Given the map's catalog path, returns the catalog path for all layers in the map.

Parameters:

mapPath - The mapPath (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLayerValid

boolean isLayerValid(java.lang.String layerPath)
                     throws java.io.IOException,
                            AutomationException

Given the layer's catalog path, returns a boolean indicating if it is valid.

Parameters:

layerPath - The layerPath (in)

Returns:

The layerValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerType

java.lang.String getLayerType(java.lang.String layerPath)
                              throws java.io.IOException,
                                     AutomationException

Given the layer's catalog path, returns the layer type.

Parameters:

layerPath - The layerPath (in)

Returns:

The layerType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubLayers

IStringArray getSubLayers(java.lang.String layerPath)
                          throws java.io.IOException,
                                 AutomationException

Given the layer's catalog path, returns the catalog path to its sub layers, if it has any.

Parameters:

layerPath - The layerPath (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataset

java.lang.String getDataset(java.lang.String layerPath)
                            throws java.io.IOException,
                                   AutomationException

Given the layer's catalog path, returns the dataset name.

Parameters:

layerPath - The layerPath (in)

Returns:

The datasetName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactoryType

java.lang.String getWorkspaceFactoryType(java.lang.String layerPath)
                                         throws java.io.IOException,
                                                AutomationException

Given the layer's catalog path, returns the workspace type.

Parameters:

layerPath - The layerPath (in)

Returns:

The workspaceFactoryType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceConnectionStringFromLayer

java.lang.String getWorkspaceConnectionStringFromLayer(java.lang.String layerPath)
                                                       throws java.io.IOException,
                                                              AutomationException

Given the layer's catalog path, returns the workspace connection string.

Parameters:

layerPath - The layerPath (in)

Returns:

The workspaceConnectionString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putWorkspaceConnectionStringInLayer

void putWorkspaceConnectionStringInLayer(java.lang.String layerPath,
                                         java.lang.String workspaceConnectionString,
                                         boolean validate)
                                         throws java.io.IOException,
                                                AutomationException

Given the layer's catalog path, updates its workspace connection string.

Parameters:

layerPath - The layerPath (in)

workspaceConnectionString - The workspaceConnectionString (in)

validate - The validate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerDisplayName

java.lang.String getLayerDisplayName(java.lang.String layerPath)
                                     throws java.io.IOException,
                                            AutomationException

Given the layer's catalog path, returns its TOC display name.

Parameters:

layerPath - The layerPath (in)

Returns:

The layerDisplayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.