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

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

All Implemented Interfaces:

GPTool

public class AddRuleToTopology
extends AbstractGPTool

Adds a new rule to a topology. The Add Rule To Topology tool is contained in the Data Management Tools tool box.

Usage tips:

• To add a rule to a topology, the input topology cannot be registered as versioned.
• You can enter the name of the subtype value to which you want a topology rule to be applied.

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 - the topology to which the new rule will be added.

ruleType - the topology rule to be added. For a complete list of the rules and what they do, see the tool's help page.

inFeatureclass - the input or origin feature class.

Method Detail

getInTopology

public Object getInTopology()

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

Parameters:

inTopology - 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 the topology rule to be added. For a complete list of the rules and what they do, see the tool's help page. 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 the topology rule to be added. For a complete list of the rules and what they do, see the tool's help page. This is a required parameter.

Parameters:

ruleType - the topology rule to be added. For a complete list of the rules and what they do, see the tool's help page.

getInFeatureclass

public Object getInFeatureclass()

Returns the Input Feature class parameter of this tool . This parameter is the input or origin feature class. 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 input or origin feature class. This is a required parameter.

Parameters:

inFeatureclass - the input or origin feature class.

getSubtype

public String getSubtype()

Returns the Input Subtype parameter of this tool . This parameter is the subtype for the input or origin feature class. Enter the subtype's description (not the code). If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes in the feature class leave this blank. 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 the subtype for the input or origin feature class. Enter the subtype's description (not the code). If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes in the feature class leave this blank. This is an optional parameter.

Parameters:

subtype - the subtype for the input or origin feature class. Enter the subtype's description (not the code). If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes in the feature class leave this blank.

getInFeatureclass2

public Object getInFeatureclass2()

Returns the Input Feature class parameter of this tool . This parameter is the 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 the destination feature class for the topology rule. This is an optional parameter.

Parameters:

inFeatureclass2 - the destination feature class for the topology rule.

getSubtype2

public String getSubtype2()

Returns the Input Subtype parameter of this tool . This parameter is the subtype for the destination feature class. Enter the subtype's description (not the code). If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes in the feature class leave this blank. 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 the subtype for the destination feature class. Enter the subtype's description (not the code). If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes in the feature class leave this blank. This is an optional parameter.

Parameters:

subtype2 - the subtype for the destination feature class. Enter the subtype's description (not the code). If subtypes do not exist on the origin feature class, or you want the rule to be applied to all subtypes in the feature class leave this blank.

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