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

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

public class CreateTopology
extends AbstractGPTool

Creates a new empty topology. The topology will not contain any feature classes or rules. Use the Add Feature Class To Topology and the Add Rule To Topology tools to populate the topology with feature classes and rules. If you do not specify a cluster tolerance or enter a value of zero, the default or minimum cluster tolerance will be applied to the new topology. The default cluster tolerance is derived from the precision of the spatial reference of the feature dataset in which you are creating the topology. The Create Topology tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateTopology()
          Creates the Create Topology tool with defaults.
CreateTopology(Object inDataset, String outName)
          Creates the Create Topology tool with the required parameters.
 
Method Summary
 double getInClusterTolerance()
          Returns the Cluster Tolerance parameter of this tool .
 Object getInDataset()
          Returns the Input Feature Dataset parameter of this tool .
 String getOutName()
          Returns the Output 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.
 void setInClusterTolerance(double inClusterTolerance)
          Sets the Cluster Tolerance parameter of this tool .
 void setInDataset(Object inDataset)
          Sets the Input Feature Dataset parameter of this tool .
 void setOutName(String outName)
          Sets the Output Topology 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

CreateTopology

public CreateTopology()
Creates the Create Topology tool with defaults.

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


CreateTopology

public CreateTopology(Object inDataset,
                      String outName)
Creates the Create 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:
inDataset - Feature Dataset, the feature dataset in which you want to create a topology.
outName - String, the topology you want to create. The topology name must be unique in the geodatabase.
Method Detail

getInDataset

public Object getInDataset()
Returns the Input Feature Dataset parameter of this tool . This parameter is Feature Dataset, the feature dataset in which you want to create a topology. This is a required parameter.

Returns:
the Input Feature Dataset

setInDataset

public void setInDataset(Object inDataset)
Sets the Input Feature Dataset parameter of this tool . This parameter is Feature Dataset, the feature dataset in which you want to create a topology. This is a required parameter.

Parameters:
inDataset - Feature Dataset, the feature dataset in which you want to create a topology.

getOutName

public String getOutName()
Returns the Output Topology parameter of this tool . This parameter is String, the topology you want to create. The topology name must be unique in the geodatabase. This is a required parameter.

Returns:
the Output Topology

setOutName

public void setOutName(String outName)
Sets the Output Topology parameter of this tool . This parameter is String, the topology you want to create. The topology name must be unique in the geodatabase. This is a required parameter.

Parameters:
outName - String, the topology you want to create. The topology name must be unique in the geodatabase.

getInClusterTolerance

public double getInClusterTolerance()
Returns the Cluster Tolerance parameter of this tool . This parameter is Double, the minimum distance between vertices in the topology. Vertices that fall within the cluster tolerance will be snapped together during the validation. This is an optional parameter.

Returns:
the Cluster Tolerance

setInClusterTolerance

public void setInClusterTolerance(double inClusterTolerance)
Sets the Cluster Tolerance parameter of this tool . This parameter is Double, the minimum distance between vertices in the topology. Vertices that fall within the cluster tolerance will be snapped together during the validation. This is an optional parameter.

Parameters:
inClusterTolerance - Double, the minimum distance between vertices in the topology. Vertices that fall within the cluster tolerance will be snapped together during the validation.

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