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

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

public class AddFeatureClassToTopology
extends AbstractGPTool

Adds a feature class to a topology. The Add Feature Class To 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
AddFeatureClassToTopology()
          Creates the Add Feature Class To Topology tool with defaults.
AddFeatureClassToTopology(Object inTopology, Object inFeatureclass, int xyRank, int zRank)
          Creates the Add Feature Class To Topology tool with the required parameters.
 
Method Summary
 Object getInFeatureclass()
          Returns the Input Feature class parameter of this tool .
 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.
 int getXyRank()
          Returns the XY Rank parameter of this tool .
 int getZRank()
          Returns the Z Rank parameter of this tool .
 void setInFeatureclass(Object inFeatureclass)
          Sets the Input Feature class parameter of this tool .
 void setInTopology(Object inTopology)
          Sets the Input Topology parameter of this tool .
 void setXyRank(int xyRank)
          Sets the XY Rank parameter of this tool .
 void setZRank(int zRank)
          Sets the Z Rank 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

AddFeatureClassToTopology

public AddFeatureClassToTopology()
Creates the Add Feature Class To Topology tool with defaults.

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


AddFeatureClassToTopology

public AddFeatureClassToTopology(Object inTopology,
                                 Object inFeatureclass,
                                 int xyRank,
                                 int zRank)
Creates the Add Feature Class To 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 topology to which the feature class will participate.
inFeatureclass - the feature class that you want to add to the topology. The feature class must be in the same feature dataset as the topology.
xyRank - the relative degree of positional accuracy associated with vertices of features in the feature class versus those in other feature classes participating in the topology. The feature class with the highest accurracy should get a higher rank (lower number, for example 1) than a feature class which is known to be less accurate.
zRank - feature classes that are z-aware have elevation values embedded in their geometry for each vertex. By setting a z rank, you can influence how vertices with accurate z-values are snapped or clustered with vertices that contain less accurate z measurements.
Method Detail

getInTopology

public Object getInTopology()
Returns the Input Topology parameter of this tool . This parameter is the topology to which the feature class will participate. 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 topology to which the feature class will participate. This is a required parameter.

Parameters:
inTopology - the topology to which the feature class will participate.

getInFeatureclass

public Object getInFeatureclass()
Returns the Input Feature class parameter of this tool . This parameter is the feature class that you want to add to the topology. The feature class must be in the same feature dataset as the topology. This is a required parameter.

Returns:
the Input Feature class

setInFeatureclass

public void setInFeatureclass(Object inFeatureclass)
Sets the Input Feature class parameter of this tool . This parameter is the feature class that you want to add to the topology. The feature class must be in the same feature dataset as the topology. This is a required parameter.

Parameters:
inFeatureclass - the feature class that you want to add to the topology. The feature class must be in the same feature dataset as the topology.

getXyRank

public int getXyRank()
Returns the XY Rank parameter of this tool . This parameter is the relative degree of positional accuracy associated with vertices of features in the feature class versus those in other feature classes participating in the topology. The feature class with the highest accurracy should get a higher rank (lower number, for example 1) than a feature class which is known to be less accurate. This is a required parameter.

Returns:
the XY Rank

setXyRank

public void setXyRank(int xyRank)
Sets the XY Rank parameter of this tool . This parameter is the relative degree of positional accuracy associated with vertices of features in the feature class versus those in other feature classes participating in the topology. The feature class with the highest accurracy should get a higher rank (lower number, for example 1) than a feature class which is known to be less accurate. This is a required parameter.

Parameters:
xyRank - the relative degree of positional accuracy associated with vertices of features in the feature class versus those in other feature classes participating in the topology. The feature class with the highest accurracy should get a higher rank (lower number, for example 1) than a feature class which is known to be less accurate.

getZRank

public int getZRank()
Returns the Z Rank parameter of this tool . This parameter is feature classes that are z-aware have elevation values embedded in their geometry for each vertex. By setting a z rank, you can influence how vertices with accurate z-values are snapped or clustered with vertices that contain less accurate z measurements. This is a required parameter.

Returns:
the Z Rank

setZRank

public void setZRank(int zRank)
Sets the Z Rank parameter of this tool . This parameter is feature classes that are z-aware have elevation values embedded in their geometry for each vertex. By setting a z rank, you can influence how vertices with accurate z-values are snapped or clustered with vertices that contain less accurate z measurements. This is a required parameter.

Parameters:
zRank - feature classes that are z-aware have elevation values embedded in their geometry for each vertex. By setting a z rank, you can influence how vertices with accurate z-values are snapped or clustered with vertices that contain less accurate z measurements.

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