com.esri.arcgis.geodatabase
Class Topology

java.lang.Object
  extended by com.esri.arcgis.geodatabase.Topology
All Implemented Interfaces:
IConnectionPointContainer, IDataset, IDatasetEdit, IErrorFeatureContainer, IFeatureClassContainer, IGeoDataset, IMetadata, IMetadataEdit, ISchemaLock, ITopology, ITopology2, ITopologyProperties, ITopologyRuleContainer, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class Topology
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataset, IDatasetEdit, IGeoDataset, ISchemaLock, IConnectionPointContainer, IFeatureClassContainer, ITopology2, ITopologyProperties, ITopologyRuleContainer, IErrorFeatureContainer, IMetadata, IMetadataEdit

COM Class 'Topology'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'Esri Topology object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDataset
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEdit
IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISchemaLock
IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureClassContainer
IID, IID3b439634_cfc3_11d1_aead_0000f80372b4, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITopology2
IID, IIDff9b929c_9726_4f60_ac10_e798999bce71, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITopology
IIDc08348e2_5ac1_4d88_a2d0_b675317bb6cd
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITopologyProperties
IID, IID40658b10_2c65_4b38_b00f_4d40ab551e27, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITopologyRuleContainer
IID, IIDb65d9fee_6d67_47fd_ac13_06bde90a1b34, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IErrorFeatureContainer
IID, IID27c444dc_25ee_41ff_a2bd_c69b6343a6c3, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit
IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy
 
Constructor Summary
Topology(java.lang.Object obj)
          Construct a Topology using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void addClass(IClass classToAdd, double weight, int xYRank, int zRank, boolean eventNotificationOnValidate)
          Add an object, feature, or attributed relationship class to the topology.
 void addRule(ITopologyRule rule)
          Adds a topology rule.
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canRename()
          True if this dataset can be renamed.
 void changeSchemaLock(int schemaLock)
          Changes a schema lock.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 void delete()
          Deletes this dataset.
 void deleteRule(ITopologyRule rule)
          Deletes a topology rule.
 void demoteFromRuleException(ITopologyErrorFeature errorException)
          Demotes a topology error from an exception to an error.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 IFeatureClass esri_getClass(int classIndex)
          The FeatureClass associated with the specified index value.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 java.lang.String getBrowseName()
          The browse name of the dataset.
 ITopologyGraph getCache()
          The topology graph of the topology.
 java.lang.String getCategory()
          The category of the dataset.
 IFeatureClass getClassByID(int iD)
          The FeatureClass with the specified ID.
 IFeatureClass getClassByName(java.lang.String name)
          The FeatureClass with the specified name.
 int getClassCount()
          The number of FeatureClasses in this container.
 IEnumFeatureClass getClasses()
          An enumerator over the FeatureClasses.
 double getClusterTolerance()
          The cluster tolerance of the topology.
 void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
          The list of current locks.
 IPolygon getDirtyArea(IPolygon location)
          The dirty area polygon of the topology.
 ITopologyErrorFeature getErrorFeature(ISpatialReference spatialReference, int errorType, int geometryType, int originClassID, int originOID, int destinationClassID, int destinationOID)
          An error feature with that matches the passed in parameters.
 IEnumTopologyErrorFeature getErrorFeatures(ISpatialReference spatialReference, ITopologyRule rule, IEnvelope extent, boolean errors, boolean exceptions)
          An enumeration of error features that match the passed in parameters.
 IEnumTopologyErrorFeature getErrorFeaturesByGeometryType(ISpatialReference spatialReference, int geometryType, boolean exceptions)
          An enumeration of error features that match the passed in parameters.
 IEnumTopologyErrorFeature getErrorFeaturesByRuleType(ISpatialReference spatialReference, int topologyRuleType, IEnvelope extent, boolean errors, boolean exceptions)
          An enumeration of error features that match the passed in parameters.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 IFeatureDataset getFeatureDataset()
          The feature dataset that contains the topology.
 IName getFullName()
          The associated name object.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMaximumGeneratedErrorCount()
          The maximum number of errors to generate when validating a topology.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          The name of the Dataset.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 IRule getRule(int ruleID)
          The topology rule with the corresponding ID.
 IRule getRuleByGUID(java.lang.String gUID)
          The rule with the globally unique ID.
 IEnumRule getRules()
          An enumeration of all the topology rules.
 IEnumRule getRulesByClass(int classID)
          An enumeration of all the rules for a given class.
 IEnumRule getRulesByClassAndSubtype(int classID, int subType)
          An enumeration of all the rules for a given class and subtype.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 int getState()
          Indicates whether the topology is clean or not.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getTopologyID()
          The ID of the topology.
 int getType()
          The type of the Dataset.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 double getZClusterTolerance()
          The z cluster tolerance of the topology.
 int hashCode()
          the hashcode for this object
 boolean isBeingEdited()
          True if the dataset is being edited.
 boolean isCanAddRule(ITopologyRule rule)
          Indicates if the topology rule can be added to the topology.
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 void promoteToRuleException(ITopologyErrorFeature errorException)
          Promotes a topology error to an exception.
 void release()
          Release a Topology.
 void removeClass(IClass classToRemove)
          Remove an object, feature, or attributed relationship class to the topology.
 void rename(java.lang.String name)
          Renames this Dataset.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 IEnvelope validateTopology(IEnvelope areaToValidate)
          Validate the specified area in the topology.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Topology

public Topology(java.lang.Object obj)
         throws java.io.IOException
Construct a Topology using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Topology.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
Topology o = (Topology)obj; // will not work

Topology o = new Topology(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems Topology theTopology = (Topology) obj;
Method Detail

equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a Topology.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the Dataset.

Specified by:
getName in interface IDataset
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
The associated name object.

Specified by:
getFullName in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
The browse name of the dataset.

Specified by:
getBrowseName in interface IDataset
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
The browse name of the dataset.

Specified by:
setBrowseName in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
The type of the Dataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the dataset.

Specified by:
getCategory in interface IDataset
Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Datasets contained within this dataset.

Specified by:
getSubsets in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
The workspace containing this dataset.

Specified by:
getWorkspace in interface IDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
The set of properties for the dataset.

Specified by:
getPropertySet in interface IDataset
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
True if this dataset can be copied.

Specified by:
canCopy in interface IDataset
Returns:
The canCopy
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

Specified by:
copy in interface IDataset
Parameters:
copyName - The copyName (in)
copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be deleted.

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Deletes this dataset.

Specified by:
delete in interface IDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be renamed.

Specified by:
canRename in interface IDataset
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Renames this Dataset.

Specified by:
rename in interface IDataset
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws java.io.IOException,
                             AutomationException
True if the dataset is being edited.

Specified by:
isBeingEdited in interface IDatasetEdit
Returns:
The isBeingEdited
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSpatialReference in interface IGeoDataset
Specified by:
getSpatialReference in interface ITopologyProperties
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException
Changes a schema lock.

Specified by:
changeSchemaLock in interface ISchemaLock
Parameters:
schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException
The list of current locks.

Specified by:
getCurrentSchemaLocks in interface ISchemaLock
Parameters:
schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
findConnectionPoint

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

public IFeatureClass esri_getClass(int classIndex)
                            throws java.io.IOException,
                                   AutomationException
The FeatureClass associated with the specified index value.

Specified by:
esri_getClass in interface IFeatureClassContainer
Parameters:
classIndex - The classIndex (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassByID

public IFeatureClass getClassByID(int iD)
                           throws java.io.IOException,
                                  AutomationException
The FeatureClass with the specified ID.

Specified by:
getClassByID in interface IFeatureClassContainer
Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassByName

public IFeatureClass getClassByName(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException
The FeatureClass with the specified name.

Specified by:
getClassByName in interface IFeatureClassContainer
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws java.io.IOException,
                         AutomationException
The number of FeatureClasses in this container.

Specified by:
getClassCount in interface IFeatureClassContainer
Returns:
The numClasses
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClasses

public IEnumFeatureClass getClasses()
                             throws java.io.IOException,
                                    AutomationException
An enumerator over the FeatureClasses.

Specified by:
getClasses in interface IFeatureClassContainer
Specified by:
getClasses in interface ITopologyProperties
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZClusterTolerance

public double getZClusterTolerance()
                            throws java.io.IOException,
                                   AutomationException
The z cluster tolerance of the topology.

Specified by:
getZClusterTolerance in interface ITopology2
Returns:
The tolerance
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws java.io.IOException,
                    AutomationException
Indicates whether the topology is clean or not.

Specified by:
getState in interface ITopology
Returns:
A com.esri.arcgis.geodatabase.esriTopologyState constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateTopology

public IEnvelope validateTopology(IEnvelope areaToValidate)
                           throws java.io.IOException,
                                  AutomationException
Validate the specified area in the topology.

Specified by:
validateTopology in interface ITopology
Parameters:
areaToValidate - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClusterTolerance

public double getClusterTolerance()
                           throws java.io.IOException,
                                  AutomationException
The cluster tolerance of the topology.

Specified by:
getClusterTolerance in interface ITopology
Specified by:
getClusterTolerance in interface ITopologyProperties
Returns:
The tolerance
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCache

public ITopologyGraph getCache()
                        throws java.io.IOException,
                               AutomationException
The topology graph of the topology.

Specified by:
getCache in interface ITopology
Returns:
A reference to a com.esri.arcgis.geodatabase.ITopologyGraph
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureDataset

public IFeatureDataset getFeatureDataset()
                                  throws java.io.IOException,
                                         AutomationException
The feature dataset that contains the topology.

Specified by:
getFeatureDataset in interface ITopology
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(IClass classToAdd,
                     double weight,
                     int xYRank,
                     int zRank,
                     boolean eventNotificationOnValidate)
              throws java.io.IOException,
                     AutomationException
Add an object, feature, or attributed relationship class to the topology.

Specified by:
addClass in interface ITopology
Parameters:
classToAdd - A reference to a com.esri.arcgis.geodatabase.IClass (in)
weight - The weight (in)
xYRank - The xYRank (in)
zRank - The zRank (in)
eventNotificationOnValidate - The eventNotificationOnValidate (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeClass

public void removeClass(IClass classToRemove)
                 throws java.io.IOException,
                        AutomationException
Remove an object, feature, or attributed relationship class to the topology.

Specified by:
removeClass in interface ITopology
Parameters:
classToRemove - A reference to a com.esri.arcgis.geodatabase.IClass (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumGeneratedErrorCount

public int getMaximumGeneratedErrorCount()
                                  throws java.io.IOException,
                                         AutomationException
The maximum number of errors to generate when validating a topology.

Specified by:
getMaximumGeneratedErrorCount in interface ITopology
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTopologyID

public int getTopologyID()
                  throws java.io.IOException,
                         AutomationException
The ID of the topology.

Specified by:
getTopologyID in interface ITopology
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirtyArea

public IPolygon getDirtyArea(IPolygon location)
                      throws java.io.IOException,
                             AutomationException
The dirty area polygon of the topology.

Specified by:
getDirtyArea in interface ITopology
Parameters:
location - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Returns:
A reference to a com.esri.arcgis.geometry.IPolygon
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRule

public IRule getRule(int ruleID)
              throws java.io.IOException,
                     AutomationException
The topology rule with the corresponding ID.

Specified by:
getRule in interface ITopologyRuleContainer
Parameters:
ruleID - The ruleID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRules

public IEnumRule getRules()
                   throws java.io.IOException,
                          AutomationException
An enumeration of all the topology rules.

Specified by:
getRules in interface ITopologyRuleContainer
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRuleByGUID

public IRule getRuleByGUID(java.lang.String gUID)
                    throws java.io.IOException,
                           AutomationException
The rule with the globally unique ID.

Specified by:
getRuleByGUID in interface ITopologyRuleContainer
Parameters:
gUID - The gUID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRulesByClass

public IEnumRule getRulesByClass(int classID)
                          throws java.io.IOException,
                                 AutomationException
An enumeration of all the rules for a given class.

Specified by:
getRulesByClass in interface ITopologyRuleContainer
Parameters:
classID - The classID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRulesByClassAndSubtype

public IEnumRule getRulesByClassAndSubtype(int classID,
                                           int subType)
                                    throws java.io.IOException,
                                           AutomationException
An enumeration of all the rules for a given class and subtype.

Specified by:
getRulesByClassAndSubtype in interface ITopologyRuleContainer
Parameters:
classID - The classID (in)
subType - The subType (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanAddRule

public boolean isCanAddRule(ITopologyRule rule)
                     throws java.io.IOException,
                            AutomationException
Indicates if the topology rule can be added to the topology.

Specified by:
isCanAddRule in interface ITopologyRuleContainer
Parameters:
rule - A reference to a com.esri.arcgis.geodatabase.ITopologyRule (in)
Returns:
The canAddRule
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRule

public void addRule(ITopologyRule rule)
             throws java.io.IOException,
                    AutomationException
Adds a topology rule.

Specified by:
addRule in interface ITopologyRuleContainer
Parameters:
rule - A reference to a com.esri.arcgis.geodatabase.ITopologyRule (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRule

public void deleteRule(ITopologyRule rule)
                throws java.io.IOException,
                       AutomationException
Deletes a topology rule.

Specified by:
deleteRule in interface ITopologyRuleContainer
Parameters:
rule - A reference to a com.esri.arcgis.geodatabase.ITopologyRule (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

promoteToRuleException

public void promoteToRuleException(ITopologyErrorFeature errorException)
                            throws java.io.IOException,
                                   AutomationException
Promotes a topology error to an exception.

Specified by:
promoteToRuleException in interface ITopologyRuleContainer
Parameters:
errorException - A reference to a com.esri.arcgis.geodatabase.ITopologyErrorFeature (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

demoteFromRuleException

public void demoteFromRuleException(ITopologyErrorFeature errorException)
                             throws java.io.IOException,
                                    AutomationException
Demotes a topology error from an exception to an error.

Specified by:
demoteFromRuleException in interface ITopologyRuleContainer
Parameters:
errorException - A reference to a com.esri.arcgis.geodatabase.ITopologyErrorFeature (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorFeature

public ITopologyErrorFeature getErrorFeature(ISpatialReference spatialReference,
                                             int errorType,
                                             int geometryType,
                                             int originClassID,
                                             int originOID,
                                             int destinationClassID,
                                             int destinationOID)
                                      throws java.io.IOException,
                                             AutomationException
An error feature with that matches the passed in parameters.

Specified by:
getErrorFeature in interface IErrorFeatureContainer
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
errorType - A com.esri.arcgis.geodatabase.esriTopologyRuleType constant (in)
geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
originClassID - The originClassID (in)
originOID - The originOID (in)
destinationClassID - The destinationClassID (in)
destinationOID - The destinationOID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITopologyErrorFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorFeatures

public IEnumTopologyErrorFeature getErrorFeatures(ISpatialReference spatialReference,
                                                  ITopologyRule rule,
                                                  IEnvelope extent,
                                                  boolean errors,
                                                  boolean exceptions)
                                           throws java.io.IOException,
                                                  AutomationException
An enumeration of error features that match the passed in parameters.

Specified by:
getErrorFeatures in interface IErrorFeatureContainer
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
rule - A reference to a com.esri.arcgis.geodatabase.ITopologyRule (in)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
errors - The errors (in)
exceptions - The exceptions (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumTopologyErrorFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorFeaturesByGeometryType

public IEnumTopologyErrorFeature getErrorFeaturesByGeometryType(ISpatialReference spatialReference,
                                                                int geometryType,
                                                                boolean exceptions)
                                                         throws java.io.IOException,
                                                                AutomationException
An enumeration of error features that match the passed in parameters.

Specified by:
getErrorFeaturesByGeometryType in interface IErrorFeatureContainer
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
exceptions - The exceptions (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumTopologyErrorFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorFeaturesByRuleType

public IEnumTopologyErrorFeature getErrorFeaturesByRuleType(ISpatialReference spatialReference,
                                                            int topologyRuleType,
                                                            IEnvelope extent,
                                                            boolean errors,
                                                            boolean exceptions)
                                                     throws java.io.IOException,
                                                            AutomationException
An enumeration of error features that match the passed in parameters.

Specified by:
getErrorFeaturesByRuleType in interface IErrorFeatureContainer
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
topologyRuleType - A com.esri.arcgis.geodatabase.esriTopologyRuleType constant (in)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
errors - The errors (in)
exceptions - The exceptions (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumTopologyErrorFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
The PropertySet containing metadata.

Specified by:
getMetadata in interface IMetadata
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException
The PropertySet containing metadata.

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

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException
Indicates if metadata can be edited.

Specified by:
isCanEditMetadata in interface IMetadataEdit
Returns:
The canEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.