com.esri.arcgis.carto
Interface IDataSourceHelperMapDocument

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataSourceHelper

public interface IDataSourceHelperMapDocument
extends Serializable

Provides access to members that help repair/replace data sources at the Map Document Level.

Product Availability

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

Method Summary

void	findAndReplaceWorkspaceNamePath(IMapDocument pMapDocument, String oldWorkspaceName, String newWorkspaceName, boolean validate) String version of ReplaceWorkspaceName.
void	repair(IMapDocument pMapDocument, IDataLayer pDataLayer, IName pName, boolean validate) Repairs the specified layer and attempt to repair all other broken layers with same workspace path name as the specified layer.
void	replaceWorkspaceName(IMapDocument pMapDocument, IWorkspaceName pOldWorkspaceName, IWorkspaceName pNewWorkspaceName, boolean validate) Replaces all layers having matching workspace path names with the new workspace name object.

Method Detail

replaceWorkspaceName

void replaceWorkspaceName(IMapDocument pMapDocument,
                          IWorkspaceName pOldWorkspaceName,
                          IWorkspaceName pNewWorkspaceName,
                          boolean validate)
                          throws IOException,
                                 AutomationException

Replaces all layers having matching workspace path names with the new workspace name object.

Product Availability

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

Parameters:

pMapDocument - A reference to a com.esri.arcgis.carto.IMapDocument (in)

pOldWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

pNewWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

validate - The validate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

repair

void repair(IMapDocument pMapDocument,
            IDataLayer pDataLayer,
            IName pName,
            boolean validate)
            throws IOException,
                   AutomationException

Repairs the specified layer and attempt to repair all other broken layers with same workspace path name as the specified layer.

Product Availability

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

Parameters:

pMapDocument - A reference to a com.esri.arcgis.carto.IMapDocument (in)

pDataLayer - A reference to a com.esri.arcgis.carto.IDataLayer (in)

pName - A reference to a com.esri.arcgis.system.IName (in)

validate - The validate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findAndReplaceWorkspaceNamePath

void findAndReplaceWorkspaceNamePath(IMapDocument pMapDocument,
                                     String oldWorkspaceName,
                                     String newWorkspaceName,
                                     boolean validate)
                                     throws IOException,
                                            AutomationException

String version of ReplaceWorkspaceName. Also does find and replace of parts of the workspace path name.

Product Availability

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

Parameters:

pMapDocument - A reference to a com.esri.arcgis.carto.IMapDocument (in)

oldWorkspaceName - The oldWorkspaceName (in)

newWorkspaceName - The newWorkspaceName (in)

validate - The validate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.