com.esri.arcgis.geodatabase
Interface ICopyHelper

All Superinterfaces:
Serializable
All Known Implementing Classes:
MetadataCopyHelper

public interface ICopyHelper
extends Serializable

Provides access to helper functions for post-processing copied metadata.

Description

This interface can be used to update the metadata of a dataset, a geodatabase, or a standalone XML file after it's been copied. In most cases, explicitly calling this interface isn't necessary, because ArcCatalog will perform this operation for you, as will most programmatic copying methods (i.e. the methods of IGeoDBDataTransfer and IFeatureDataConverter).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void updateDatabaseMetadata(IPropertySet destPropertySet, IDatasetName src, IDatasetName dest)
          Call this while creating a copy of a dataset in a geodatabase.
 void updateMetadata(IName src, IName dest, boolean isMove)
          Call this after creating a copy of a dataset, workspace, or file.
 

Method Detail

updateMetadata

void updateMetadata(IName src,
                    IName dest,
                    boolean isMove)
                    throws IOException,
                           AutomationException
Call this after creating a copy of a dataset, workspace, or file.

Description

This method updates the metadata of the dataset represented by the pDest name object to indicate that it was copied (or moved) from the dataset represented by the pSrc name object.

Remarks

The metadata properties that are updated depend on which metadata synchronizers are enabled, but typically a new dataqual/lineage/procstep element is added (along with child elements) indicating that the dataset was copied from the pSrc location, and the idinfo/citation/citeinfo/onlink property will be changed if the FGDCSynchronizer is enabled.

As noted in the interface description, it usually isn't necessary to call this method, since most ways of copying a dataset through ArcCatalog and ArcObjects will perform this operation automatically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
src - A reference to a com.esri.arcgis.system.IName (in)
dest - A reference to a com.esri.arcgis.system.IName (in)
isMove - The isMove (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateDatabaseMetadata

void updateDatabaseMetadata(IPropertySet destPropertySet,
                            IDatasetName src,
                            IDatasetName dest)
                            throws IOException,
                                   AutomationException
Call this while creating a copy of a dataset in a geodatabase.

Description

This method will update the pDestPropertySet with properties indicating that it is a dataset represented by the pDest name object and that it was copied from the dataset represented by the pSrc name object.

Remarks

The metadata properties that are updated depend on which metadata synchronizers are enabled, but typically a new dataqual/lineage/procstep element is added (along with child elements) indicating that the dataset was copied from the pSrc location, and the idinfo/citation/citeinfo/onlink property will be changed if the FGDCSynchronizer is enabled.

As noted in the interface description, it usually isn't necessary to call this method, since most ways of copying a dataset through ArcCatalog and ArcObjects will perform this operation automatically.

Note that unlike the UpdateMetadata method, this will not update the metadata associated with either of the name objects, it will only modify the pDestPropertySet property set (which can then be persisted to the pDest name object through the IMetadata interface).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
destPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
src - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
dest - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.