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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.ValidateTopology
All Implemented Interfaces:
GPTool

public class ValidateTopology
extends AbstractGPTool

Validates a geodatabase topology. The Validate Topology tool is contained in the Data Management Tools tool box.

Usage tips:


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 - the geodatabase topology to be validated.
Method Detail

getInTopology

public Object getInTopology()
Returns the Input Topology parameter of this tool . This parameter is the geodatabase topology to be validated. 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 the geodatabase topology to be validated. This is a required parameter.

Parameters:
inTopology - the geodatabase topology to be validated.

getVisibleExtent

public String getVisibleExtent()
Returns the Visible Extent parameter of this tool . This parameter is in ArcMap, determines whether to use the current visible extent of the map or the full extent of the topology. If run in ArcCatalog or in a Python script, the entire extent of the topology will be validated regardless of this parameter setting. 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 in ArcMap, determines whether to use the current visible extent of the map or the full extent of the topology. If run in ArcCatalog or in a Python script, the entire extent of the topology will be validated regardless of this parameter setting. This is an optional parameter.

Parameters:
visibleExtent - in ArcMap, determines whether to use the current visible extent of the map or the full extent of the topology. If run in ArcCatalog or in a Python script, the entire extent of the topology will be validated regardless of this parameter setting.

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