com.esri.arcgis.geodatabase
Interface ITopologyContainer2

All Superinterfaces:

ITopologyContainer, Serializable

All Known Implementing Classes:

FeatureDataset, ITopologyContainer2Proxy

public interface ITopologyContainer2
extends ITopologyContainer, Serializable

Provides access to members that create, add, and hand out topologies.

Remarks

The ITopologyContainer2 interface can be used to manage and create topologies within a feature dataset. If your intention is to simply browse for the set of topologies in a feature dataset, it is not necessary to open the feature dataset and call the methods on ITopologyContainer. The IFeatureDatasetName2::TopologyNames method can be used to efficiently obtain this information. Careful consideration should be given to specifying the parameters when creating a topology. Once the topology is built, none of the parameters can be modified. In order to change properties such as the Z cluster tolerance, the topology must be deleted and rebuilt with the new parameters.

When To Use

The ITopologyContainer2 interface should be used to create topologies that will contain at least one feature class that is Z aware. The ITopologyContainer2::CreateTopologyEx method allows the specification of a Z cluster tolerance, which indicates which Z clustering model will be used; Building or Terrain.

Product Availability

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

Method Summary

ITopology	createTopologyEx(String name, double clusterTolerance, double zClusterTolerance, int maxGeneratedErrorCount, String configurationKeyword) Creates a new topology.
double	getDefaultZClusterTolerance() The default z cluster tolerance as per the topology engine.
double	getMaximumZClusterTolerance() The maximal z cluster tolerance as per the topology engine.
double	getMinimumZClusterTolerance() The minimal z cluster tolerance as per the topology engine.

Methods inherited from interface com.esri.arcgis.geodatabase.ITopologyContainer

createTopology, getDefaultClusterTolerance, getMaximumClusterTolerance, getMinimumClusterTolerance, getTopology, getTopologyByID, getTopologyByName, getTopologyCount

Method Detail

createTopologyEx

ITopology createTopologyEx(String name,
                           double clusterTolerance,
                           double zClusterTolerance,
                           int maxGeneratedErrorCount,
                           String configurationKeyword)
                           throws IOException,
                                  AutomationException

Creates a new topology.

Remarks

The CreateTopologyEx method creates a topology with the specified name, cluster tolerance, maximum allowable number of errors to be generated, Z cluster tolerance and for ArcSDE, with the supplied configuration keyword. When a topology is initially created, it is empty with no participating feature classes or rules.

The ITopologyContainer::DefaultClusterTolerance property should be used to return the default or recommended cluster tolerance for a topology. The ITopologyContainer::MaximumClusterTolerance property can be used to return the maximum cluster tolerance for a topology. You cannot specify a cluster tolerance larger than the maximum or smaller than the minimum or default cluster tolerance. As such, if the specified cluster tolerance is less than the DefaultClusterTolerance for the feature dataset, then the Topology will be created with the default cluster tolerance value. If the specified cluster tolerance is larger than the MaximumClusterTolerance, the topology will be created with the maximum cluster tolerance.

The maxGeneratedErrorCount parameter specifies the maximum number of errors validate will generate before stopping. Setting a value of -1 indicates there is no limit to the number of errors that will be generated.

The configurationKeyword parameter allows the application to control the physical layout for this table in the underlying RDBMS—for example, in the case of an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configurationKeywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface. The configurationKeyword parameter is not mandatory when building a topology in an ArcSDE Geodatabase, an empty string can be specified, in which case the topology will be built using the default configuration. For more information on configuration keywords, refer to the ArcSDE documentation.

The ITopologyContainer2::DefaultZClusterTolerance property can be used to return the default Z cluster tolerance. The default Z cluster tolerance for all topologies is 0, indicating that the topology will support the Building model. The ITopologyContainer2::MaximumZClusterTolerance property can be used to return the maximum Z cluster tolerance for a topology. The maximum Z cluster tolerance will be equal to the maximum Z - minimum Z of the spatial domain from the feature dataset. Supplying a Z cluster tolerance value greater than 0 will create a topology that supports the Terrain model.

You cannot specify a Z cluster tolerance larger than the maximum or smaller than the minimum or default Z cluster tolerance. As such, if the specified Z cluster tolerance is less than the DefaultZClusterTolerance for the feature dataset, then the topology will be created with the default Z cluster tolerance value. If the specified Z cluster tolerance is larger than the MaximumZClusterTolerance , the topology will be created with the maximum Z cluster tolerance.

When using the CreateTopologyEx method to create a topology within a geodatabase that does not support Z cluster tolerances (geodatabases created pre-9.0), the ZClusterTolerance should be set to -1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

clusterTolerance - The clusterTolerance (in)

zClusterTolerance - The zClusterTolerance (in)

maxGeneratedErrorCount - The maxGeneratedErrorCount (in)

configurationKeyword - The configurationKeyword (in)

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.

getDefaultZClusterTolerance

double getDefaultZClusterTolerance()
                                   throws IOException,
                                          AutomationException

The default z cluster tolerance as per the topology engine.

Remarks

Returns the default Z cluster tolerance as generated by the topology engine, which will be 0 signifying that the topology will support the Building cluster tolerance model. Currently this is the same as the MinimumClusterTolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The zClusterTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumZClusterTolerance

double getMinimumZClusterTolerance()
                                   throws IOException,
                                          AutomationException

The minimal z cluster tolerance as per the topology engine.

Remarks

Returns the minimum Z cluster tolerance for the topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The zClusterTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumZClusterTolerance

double getMaximumZClusterTolerance()
                                   throws IOException,
                                          AutomationException

The maximal z cluster tolerance as per the topology engine.

Remarks

Returns the maximum Z cluster tolerance for the topology. This value will the maximum Z - minimum Z from the spatial domain of the feature dataset containing the topology.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The zClusterTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.