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

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

All Implemented Interfaces:

GPTool

public class CreateTopology
extends AbstractGPTool

Creates a topology. The topology will not contain any feature classes or rules. The Create Topology tool is contained in the Data Management Tools tool box.

Usage tips:

• If the Cluster Tolerance parameter is blank or set to 0, the xy tolerance of the feature dataset which contains the topology will be used.
• There is a range allowed for the cluster tolerance value, this range is derived from the precision of the spatial reference of the feature dataset in which the topology is contained. If the value entered is larger than the maximum cluster tolerance, the maximum value will be used instead. If the value entered is smaller than the minimum, the minimum value will be used.

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 - the feature dataset in which the topology will be created.

outName - the name of the topology to be created. This name must be unique across the entire geodatabase.

Method Detail

getInDataset

public Object getInDataset()

Returns the Input Feature Dataset parameter of this tool . This parameter is the feature dataset in which the topology will be created. 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 the feature dataset in which the topology will be created. This is a required parameter.

Parameters:

inDataset - the feature dataset in which the topology will be created.

getOutName

public String getOutName()

Returns the Output Topology parameter of this tool . This parameter is the name of the topology to be created. This name must be unique across the entire 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 the name of the topology to be created. This name must be unique across the entire geodatabase. This is a required parameter.

Parameters:

outName - the name of the topology to be created. This name must be unique across the entire geodatabase.

getInClusterTolerance

public double getInClusterTolerance()

Returns the Cluster Tolerance parameter of this tool . This parameter is the cluster tolerance to be set on the topology. The larger the value, the more likely vertices will be to cluster together. 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 the cluster tolerance to be set on the topology. The larger the value, the more likely vertices will be to cluster together. This is an optional parameter.

Parameters:

inClusterTolerance - the cluster tolerance to be set on the topology. The larger the value, the more likely vertices will be to cluster together.

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