com.esri.arcgis.geodatabase
Class MetadataCopyHelper

java.lang.Object
  extended by com.esri.arcgis.geodatabase.MetadataCopyHelper
All Implemented Interfaces:
ICopyHelper, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class MetadataCopyHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICopyHelper

Metadata Copy Helper.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MetadataCopyHelper()
          Constructs a MetadataCopyHelper using ArcGIS Engine.
MetadataCopyHelper(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MetadataCopyHelper theMetadataCopyHelper = (MetadataCopyHelper) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int hashCode()
          the hashcode for this object
 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.
 
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

MetadataCopyHelper

public MetadataCopyHelper()
                   throws IOException,
                          UnknownHostException
Constructs a MetadataCopyHelper using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MetadataCopyHelper

public MetadataCopyHelper(Object obj)
                   throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MetadataCopyHelper theMetadataCopyHelper = (MetadataCopyHelper) obj;

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

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

updateMetadata

public 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

Specified by:
updateMetadata in interface ICopyHelper
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

public 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

Specified by:
updateDatabaseMetadata in interface ICopyHelper
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.