com.esri.arcgis.geodatabase
Class FGDCSynchronizationHelper

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

public class FGDCSynchronizationHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISynchronizationHelper

FGDC Synchronization Helper.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
FGDCSynchronizationHelper()
          Constructs a FGDCSynchronizationHelper using ArcGIS Engine.
FGDCSynchronizationHelper(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FGDCSynchronizationHelper theFGDCSynchronizationHelper = (FGDCSynchronizationHelper) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void extractBriefEntityAttrProperties(IClass geoDataset, int index, IPropertySet propertySet)
          Extracts brief entity attribute properties from a Feature Class.
 void extractBriefRelationshipProperties(IRelationshipClass relationshipClass, int index, IPropertySet propertySet)
          Extracts brief entity attribute properties from a Relationship Class.
 void extractEntityAttrProperties(IClass geoDataset, int index, IPropertySet propertySet)
          Extracts entity attribute properties from a Feature Class.
 void extractFeatureClassProperties(IFeatureClass geoDataset, int index, IPropertySet propertySet)
          Extracts properties from a Feature Class.
 void extractRelationshipProperties(IRelationshipClass relationshipClass, int index, IPropertySet propertySet)
          Extracts entity attribute properties from a Relationship Class.
 void extractSpatialProperties(IGeoDataset geoDataset, IPropertySet propertySet)
          Extracts spatial properties from a GeoDataset.
 void finishSynchronization(IPropertySet propertySet)
          Call this after synchronizing.
static String getClsid()
          getClsid.
 int hashCode()
          the hashcode for this object
 void populateDistributionProperties(String fileName, String fileType, IPropertySet propertySet)
          Populates distribution properties given a filename.
 void populateDistributionPropertiesForDatabase(IDataset dataset, IPropertySet propertySet)
          Populates distribution properties given a filename.
 void populateStaticProperties(IPropertySet propertySet)
          Fills in required properties.
 void startSynchronization(IPropertySet propertySet, int action, int interval, boolean[] ok)
          Call this before synchronizing.
 
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

FGDCSynchronizationHelper

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

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

FGDCSynchronizationHelper

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

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

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

startSynchronization

public void startSynchronization(IPropertySet propertySet,
                                 int action,
                                 int interval,
                                 boolean[] ok)
                          throws IOException,
                                 AutomationException
Call this before synchronizing.

Remarks

As with the IMetadata::Synchronize method, StartSynchronization uses the options defined in esriMetadataSyncAction to specify whether metadata will be created and elements will be modified based on whether or not the metadata already exists.

The interval parameter allows a minimum time (in seconds) to be provided between modifications. For example, if the interval parameter is set to 1000 when this method is called, the modification time of the property set will be checked, and if the difference between it and the current time is less than 1000 seconds, the synchronization "helping" will not begin (and the bOK value will be set to false).

bOK indicates whether or not the synchronization helper was able to begin successfully.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
startSynchronization in interface ISynchronizationHelper
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
ok - The ok (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finishSynchronization

public void finishSynchronization(IPropertySet propertySet)
                           throws IOException,
                                  AutomationException
Call this after synchronizing.

Remarks

FinishSynchronization indicates that the synchronization process is complete. Changes to the XML property set that occurred during synchronization are saved in the metadata document.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
finishSynchronization in interface ISynchronizationHelper
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populateStaticProperties

public void populateStaticProperties(IPropertySet propertySet)
                              throws IOException,
                                     AutomationException
Fills in required properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
populateStaticProperties in interface ISynchronizationHelper
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractSpatialProperties

public void extractSpatialProperties(IGeoDataset geoDataset,
                                     IPropertySet propertySet)
                              throws IOException,
                                     AutomationException
Extracts spatial properties from a GeoDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractSpatialProperties in interface ISynchronizationHelper
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractFeatureClassProperties

public void extractFeatureClassProperties(IFeatureClass geoDataset,
                                          int index,
                                          IPropertySet propertySet)
                                   throws IOException,
                                          AutomationException
Extracts properties from a Feature Class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractFeatureClassProperties in interface ISynchronizationHelper
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
index - The index (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractEntityAttrProperties

public void extractEntityAttrProperties(IClass geoDataset,
                                        int index,
                                        IPropertySet propertySet)
                                 throws IOException,
                                        AutomationException
Extracts entity attribute properties from a Feature Class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractEntityAttrProperties in interface ISynchronizationHelper
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IClass (in)
index - The index (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractRelationshipProperties

public void extractRelationshipProperties(IRelationshipClass relationshipClass,
                                          int index,
                                          IPropertySet propertySet)
                                   throws IOException,
                                          AutomationException
Extracts entity attribute properties from a Relationship Class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractRelationshipProperties in interface ISynchronizationHelper
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
index - The index (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populateDistributionProperties

public void populateDistributionProperties(String fileName,
                                           String fileType,
                                           IPropertySet propertySet)
                                    throws IOException,
                                           AutomationException
Populates distribution properties given a filename.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
populateDistributionProperties in interface ISynchronizationHelper
Parameters:
fileName - The fileName (in)
fileType - The fileType (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populateDistributionPropertiesForDatabase

public void populateDistributionPropertiesForDatabase(IDataset dataset,
                                                      IPropertySet propertySet)
                                               throws IOException,
                                                      AutomationException
Populates distribution properties given a filename.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
populateDistributionPropertiesForDatabase in interface ISynchronizationHelper
Parameters:
dataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractBriefEntityAttrProperties

public void extractBriefEntityAttrProperties(IClass geoDataset,
                                             int index,
                                             IPropertySet propertySet)
                                      throws IOException,
                                             AutomationException
Extracts brief entity attribute properties from a Feature Class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractBriefEntityAttrProperties in interface ISynchronizationHelper
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IClass (in)
index - The index (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractBriefRelationshipProperties

public void extractBriefRelationshipProperties(IRelationshipClass relationshipClass,
                                               int index,
                                               IPropertySet propertySet)
                                        throws IOException,
                                               AutomationException
Extracts brief entity attribute properties from a Relationship Class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractBriefRelationshipProperties in interface ISynchronizationHelper
Parameters:
relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)
index - The index (in)
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.