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

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

public class AddRuleToTopology
extends AbstractGPTool

Adds a new rule to a topology. There are many topology rules that you can add to your topology. The rules you choose depend on the spatial relationships that are most important to maintain for the feature classes that participate in the topology. Some topology rules govern the relationships of features within a given feature class, while others govern the relationships between features in two different feature classes. Topology rules can also be defined between subtypes of features in one or another feature class. Topology rules are organized based on the geometry type of the origin feature class (polygon, line, or point). The origin feature class is the first feature class specified when adding the rule. The Add Rule To Topology tool is contained in the Data Management Tools tool box.
Learn more about Topology Rules by Origin Feature Class

Software restrictions: ArcInfo and ArcEditor only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AddRuleToTopology()
          Creates the Add Rule To Topology tool with defaults.
AddRuleToTopology(Object inTopology, String ruleType, Object inFeatureclass)
          Creates the Add Rule To Topology tool with the required parameters.
 
Method Summary
 Object getInFeatureclass()
          Returns the Input Feature class parameter of this tool .
 Object getInFeatureclass2()
          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 getRuleType()
          Returns the Rule Type parameter of this tool .
 String getSubtype()
          Returns the Input Subtype parameter of this tool .
 String getSubtype2()
          Returns the Input Subtype parameter of this tool .
 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 setInFeatureclass(Object inFeatureclass)
          Sets the Input Feature class parameter of this tool .
 void setInFeatureclass2(Object inFeatureclass2)
          Sets the Input Feature class parameter of this tool .
 void setInTopology(Object inTopology)
          Sets the Input Topology parameter of this tool .
 void setRuleType(String ruleType)
          Sets the Rule Type parameter of this tool .
 void setSubtype(String subtype)
          Sets the Input Subtype parameter of this tool .
 void setSubtype2(String subtype2)
          Sets the Input Subtype 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

AddRuleToTopology

public AddRuleToTopology()
Creates the Add Rule To Topology tool with defaults.

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


AddRuleToTopology

public AddRuleToTopology(Object inTopology,
                         String ruleType,
                         Object inFeatureclass)
Creates the Add Rule 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 - Topology, the topology to which the new rule will be added.
ruleType - String, the topology rule that will be applied to the input feature class(es).
inFeatureclass - Feature Class, the input or origin feature class for the topology rule.
Method Detail

getInTopology

public Object getInTopology()
Returns the Input Topology parameter of this tool . This parameter is Topology, the topology to which the new rule will be added. 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 topology to which the new rule will be added. This is a required parameter.

Parameters:
inTopology - Topology, the topology to which the new rule will be added.

getRuleType

public String getRuleType()
Returns the Rule Type parameter of this tool . This parameter is String, the topology rule that will be applied to the input feature class(es). This is a required parameter.

Returns:
the Rule Type

setRuleType

public void setRuleType(String ruleType)
Sets the Rule Type parameter of this tool . This parameter is String, the topology rule that will be applied to the input feature class(es). This is a required parameter.

Parameters:
ruleType - String, the topology rule that will be applied to the input feature class(es).

getInFeatureclass

public Object getInFeatureclass()
Returns the Input Feature class parameter of this tool . This parameter is Feature Class, the input or origin feature class for the topology rule. 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 Feature Class, the input or origin feature class for the topology rule. This is a required parameter.

Parameters:
inFeatureclass - Feature Class, the input or origin feature class for the topology rule.

getSubtype

public String getSubtype()
Returns the Input Subtype parameter of this tool . This parameter is String, the subtype value for the input feature class. If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes, either do not set this parameter, or use a value of -1. This is an optional parameter.

Returns:
the Input Subtype

setSubtype

public void setSubtype(String subtype)
Sets the Input Subtype parameter of this tool . This parameter is String, the subtype value for the input feature class. If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes, either do not set this parameter, or use a value of -1. This is an optional parameter.

Parameters:
subtype - String, the subtype value for the input feature class. If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes, either do not set this parameter, or use a value of -1.

getInFeatureclass2

public Object getInFeatureclass2()
Returns the Input Feature class parameter of this tool . This parameter is Feature Class, the second input or destination feature class for the topology rule. This is an optional parameter.

Returns:
the Input Feature class

setInFeatureclass2

public void setInFeatureclass2(Object inFeatureclass2)
Sets the Input Feature class parameter of this tool . This parameter is Feature Class, the second input or destination feature class for the topology rule. This is an optional parameter.

Parameters:
inFeatureclass2 - Feature Class, the second input or destination feature class for the topology rule.

getSubtype2

public String getSubtype2()
Returns the Input Subtype parameter of this tool . This parameter is String, the subtype value for the second input or destination feature class. If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes, either do not set this parameter, or use a value of -1. This is an optional parameter.

Returns:
the Input Subtype

setSubtype2

public void setSubtype2(String subtype2)
Sets the Input Subtype parameter of this tool . This parameter is String, the subtype value for the second input or destination feature class. If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes, either do not set this parameter, or use a value of -1. This is an optional parameter.

Parameters:
subtype2 - String, the subtype value for the second input or destination feature class. If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes, either do not set this parameter, or use a value of -1.

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