com.esri.arcgis.geodatabase
Interface ITopologyClass

All Superinterfaces:
Serializable
All Known Implementing Classes:
FeatureClass, ITopologyClassProxy

public interface ITopologyClass
extends Serializable

Provides access to topology class members.

Remarks

The ITopologyClass interface provides read-only access to the properties of feature classes in a Topology. Most of these properties are specified when the feature class is added to the Topology.

Product Availability

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


Method Summary
 ITopology getTopology()
          The Topology associated with the class.
 double getWeight()
          The weight of the class in the topology.
 int getXYRank()
          The XY rank of the class in the topology.
 int getZRank()
          The Z rank of the class in the topology.
 boolean isEventNotificationOnValidate()
          Indicates if event notification is fired on validate.
 boolean isInTopology()
          Indicates if the class is in a topology.
 

Method Detail

getTopology

ITopology getTopology()
                      throws IOException,
                             AutomationException
The Topology associated with the class.

Remarks

Returns the Topology this FeatureClass is associated with. A FeatureClass can be associated with only 1 Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITopology
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInTopology

boolean isInTopology()
                     throws IOException,
                            AutomationException
Indicates if the class is in a topology.

Remarks

Returns True if the FeatureClass participates in a topology and False if the FeatureClass does not participate in a Topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The inTopology
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWeight

double getWeight()
                 throws IOException,
                        AutomationException
The weight of the class in the topology.

Remarks

The Weight of the feature class is a long between 1 and 10. This property is not currently implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The weight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getXYRank

int getXYRank()
              throws IOException,
                     AutomationException
The XY rank of the class in the topology.

Remarks

The XYRank of a feature class in the topology is a long between 1 and 50. It represents the relative accuracy of the features in the feature class with respect to their surrounding features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The xYRank
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZRank

int getZRank()
             throws IOException,
                    AutomationException
The Z rank of the class in the topology.

Remarks

The ZRank of a feature class in the topology is a long between 1 and 50. It represents the relative accuracy of the features in the feature class with respect to their surrounding features. If a feature class is not Z aware it will return a ZRank of zero.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The zRank
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEventNotificationOnValidate

boolean isEventNotificationOnValidate()
                                      throws IOException,
                                             AutomationException
Indicates if event notification is fired on validate.

Remarks

EventNotificationOnValidate returns a Boolean value indicating if the ITopologyClassEvents::OnValidate event is broadcast when the Topology of the participating feature class is validated. The EventNotificationOnValidate property is only set when the feature class is added to the Topology and can only be set if the Topology is created programmatically. Feature classes participating in topologies created with the use of the Topology Wizard in ArcCatalog, return False for EventNotificationOnValidate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The eventNotification
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.