com.esri.arcgis.geodatabase
Class FGDCSynchronizer

java.lang.Object
  com.esri.arcgis.geodatabase.FGDCSynchronizer

All Implemented Interfaces:

IMetadataSynchronizer, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FGDCSynchronizer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMetadataSynchronizer

ESRI FGDC Synchronizer object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FGDCSynchronizer()
Constructs a FGDCSynchronizer using ArcGIS Engine.

FGDCSynchronizer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FGDCSynchronizer theFGDCSynchronizer = (FGDCSynchronizer) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
IUID	getClassID() The class ID of the metadata synchronizer.
static String	getClsid() getClsid.
String	getName() The name of the metadata synchronizer.
int	hashCode() the hashcode for this object
void	update(IXmlPropertySet propertySet, String itemDesc, Object value) Updates the metadata item using the value passed in.

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

FGDCSynchronizer

public FGDCSynchronizer()
                 throws IOException,
                        UnknownHostException

Constructs a FGDCSynchronizer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FGDCSynchronizer

public FGDCSynchronizer(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FGDCSynchronizer theFGDCSynchronizer = (FGDCSynchronizer) obj;

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the metadata synchronizer.

Description

A string that identifies the synchronizer. The Name is used when managing metadata synchronizers through the IMetadataSynchronizationManager interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IMetadataSynchronizer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of the metadata synchronizer.

Description

A UID object that must be unique to the synchronizer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IMetadataSynchronizer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(IXmlPropertySet propertySet,
                   String itemDesc,
                   Object value)
            throws IOException,
                   AutomationException

Updates the metadata item using the value passed in.

Description

This method is used to define the structure of the metadata that is written during synchronization. It is called once for each property of the dataset during synchronization. The method requires three parameters; pPropertySet, itemDesc, and Value.

Remarks

The pPropertySet parameter is an XML property set representing the metadata of the dataset being synchronized.

The itemDesc string parameter describes what object is being passed in the Value parameter.

The Value parameter is an object of the data sets whose metadata is being synchronized.

The different objects passed to the Update method, the Value parameter, vary from type of data set that is being synchronized. Not all itemDesc are supported for all data types. For instance CoverageEntity objects only apply to ArcInfo coverages and ArcInfo tables.

A complete list of the expected Values for the supported itemDesc items is available in the Technical Paper "Creating a Custom Metadata Synchronizer", May 2001.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

update in interface IMetadataSynchronizer

Parameters:

propertySet - A reference to a com.esri.arcgis.geodatabase.IXmlPropertySet (in)

itemDesc - The itemDesc (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.