com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class ValidateTopology

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.ValidateTopology

All Implemented Interfaces:

GPTool

public class ValidateTopology
extends AbstractGPTool

Validates a geodatabase topology. Validate Topology checks features to see if they have violated any rules that have been defined for the topology. The Validate Topology tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:

• If you validate an ArcSDE geodatabase topology in ArcCatalog, the feature dataset that the topology is within must not be registered as versioned.
• Validate will only process areas of the topology that require validation. If you validate the topology in ArcMap, you can optionally use the visible extent as the area you want to validate. All areas outside the visible extent will not be validated.
• The following environment affects this tool: Workspace; scratch workspace; , and extent;

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ValidateTopology()
Creates the Validate Topology tool with defaults.

ValidateTopology(Object inTopology)
Creates the Validate Topology tool with the required parameters.

Method Summary

Object	getInTopology() Returns the Input Topology parameter of this tool .
Object	getOutTopology() Returns the Output Topology parameter of this tool (Read only).
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
String	getVisibleExtent() Returns the Visible Extent parameter of this tool .
void	setInTopology(Object inTopology) Sets the Input Topology parameter of this tool .
void	setVisibleExtent(String visibleExtent) Sets the Visible Extent parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ValidateTopology

public ValidateTopology()

Creates the Validate Topology tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

ValidateTopology

public ValidateTopology(Object inTopology)

Creates the Validate Topology tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inTopology - Topology, the geodatabase topology you want to validate.

Method Detail

getInTopology

public Object getInTopology()

Returns the Input Topology parameter of this tool . This parameter is Topology, the geodatabase topology you want to validate. This is a required parameter.

Returns:

the Input Topology

setInTopology

public void setInTopology(Object inTopology)

Sets the Input Topology parameter of this tool . This parameter is Topology, the geodatabase topology you want to validate. This is a required parameter.

Parameters:

inTopology - Topology, the geodatabase topology you want to validate.

getVisibleExtent

public String getVisibleExtent()

Returns the Visible Extent parameter of this tool . This parameter is String, in ArcMap, the current visible extent of the map. If run in ArcCatalog, the entire extent of the topology will be validated regardless of whether this parameter is set to VISIBLE_EXTENT. This is an optional parameter.

Returns:

the Visible Extent

setVisibleExtent

public void setVisibleExtent(String visibleExtent)

Sets the Visible Extent parameter of this tool . This parameter is String, in ArcMap, the current visible extent of the map. If run in ArcCatalog, the entire extent of the topology will be validated regardless of whether this parameter is set to VISIBLE_EXTENT. This is an optional parameter.

Parameters:

visibleExtent - String, in ArcMap, the current visible extent of the map. If run in ArcCatalog, the entire extent of the topology will be validated regardless of whether this parameter is set to VISIBLE_EXTENT.

getOutTopology

public Object getOutTopology()

Returns the Output Topology parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Topology

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias