com.esri.arcgis.geodatabase
Interface IErrorFeatureContainer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IErrorFeatureContainerProxy, Topology

public interface IErrorFeatureContainer
extends java.io.Serializable

Provides access to members that return error features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The IErrorFeatureContainer interface contains properties that can be used to return the error features associated with a Topology. Each property on IErrorFeatureContainer requires the spatial reference of the Topology.


Method Summary
 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.
 

Method Detail

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.

Supported Platforms

Windows, Solaris, Linux

Remarks

ErrorFeature returns an ITopologyErrorFeature corresponding to the specified parameters. If no error feature exists that matches the parameters, ITopologyErrorFeature is nothing.

ErrorFeature requires the spatial reference of the Topology, this can be obtained from the IGeoDataset interface.

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.

Supported Platforms

Windows, Solaris, Linux

Remarks

ErrorFeatures will return an enumeration of error features belonging to the Topology Rule and within the Envelope that is supplied. The enumeration can contain Errors, errors marked as Exceptions or Both. To determine if a TopologyErrorFeature has been marked as an Exception, use the ITopologyErrorFeature::IsException property. If no error feature exists that matches the parameters, an empty enumeration is returned.

ErrorFeatures requires the spatial reference of the Topology, this can be obtained from the IGeoDataset interface.

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.

Supported Platforms

Windows, Solaris, Linux

Remarks

ErrorFeaturesByGeometryType returns an enumeration, IEnumTopologyErrorFeature of error features corresponding to the specified parameters. If no error features corresponding to the specified parameters exist, an empty enumeration is returned.

The GeometryType parameter accepts three supported esriGeometryType (constant, value):

Exceptions indicates whether Exceptions or Errors will be returned. If Exceptions is True, the enumeration will only contain Exceptions, otherwise the enumeration will contain Errors.

ErrorFeaturesByGeometryType requires the spatial reference of the Topology, this can be obtained from the IGeoDataset interface.

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.

Supported Platforms

Windows, Solaris, Linux

Remarks

ErrorFeaturesByRuleType will return an enumeration of error features belonging to the type of topology rule that is supplied.  This is different from ErrorFeatures which returns the error features belonging to a particular rule of the Topology. The enumeration can contain Errors, errors marked as Exceptions or Both. To determine if a TopologyErrorFeature has been marked as an Exception, use the ITopologyErrorFeature::IsException property. If no error feature exists that matches the parameters, an empty enumeration is returned.

ErrorFeaturesByRuleType requires the spatial reference of the Topology, this can be obtained from the IGeoDataset interface.

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.