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

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

All Implemented Interfaces:

GPTool

public class RemoveRuleFromTopology
extends AbstractGPTool

Removes a rule from a topology. The Remove Rule From Topology tool is contained in the Data Management Tools tool box.

Usage tips:

• When running this tool using scripting, the feature class ObjectClassID involved in the topology rule to be removed must be specified in parentheses after the rule name. For example
  • Must Not Overlap (2) where "2" is theObjectClassID of the feature class that participates in the Must Not Overlap rule that is to be removed from the topology.
  • Must Be Properly Inside (78-79) where "78" and "79" are the ObjectClassID of the feature classes that participate in the Must Be Properly Inside rule that is to be removed from the topology
  See the tool code samples for an example. If you are using the tool from the tool dialog box the list of rules is presented in a drop-down list.
• Removing a rule will require the entire extent of the topology to be validated.
• This tool alters the schema of the topology, therefore it requires an exclusive lock and also requires that the topology not be registerd as versioned.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

RemoveRuleFromTopology()
Creates the Remove Rule From Topology tool with defaults.

RemoveRuleFromTopology(Object inTopology, String inRule)
Creates the Remove Rule From Topology tool with the required parameters.

Method Summary

String	getInRule() Returns the Rule 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.
void	setInRule(String inRule) Sets the Rule parameter of this tool .
void	setInTopology(Object inTopology) Sets the Input 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

RemoveRuleFromTopology

public RemoveRuleFromTopology()

Creates the Remove Rule From Topology tool with defaults.

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

RemoveRuleFromTopology

public RemoveRuleFromTopology(Object inTopology,
                              String inRule)

Creates the Remove Rule From 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 from which to remove a rule. This is the full path to the topology layer on disk, NOT the topology layer name in map.

inRule - the topology rule to remove from the topology.

Method Detail

getInTopology

public Object getInTopology()

Returns the Input Topology parameter of this tool . This parameter is the topology from which to remove a rule. This is the full path to the topology layer on disk, NOT the topology layer name in map. 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 from which to remove a rule. This is the full path to the topology layer on disk, NOT the topology layer name in map. This is a required parameter.

Parameters:

inTopology - the topology from which to remove a rule. This is the full path to the topology layer on disk, NOT the topology layer name in map.

getInRule

public String getInRule()

Returns the Rule parameter of this tool . This parameter is the topology rule to remove from the topology. This is a required parameter.

Returns:

the Rule

setInRule

public void setInRule(String inRule)

Sets the Rule parameter of this tool . This parameter is the topology rule to remove from the topology. This is a required parameter.

Parameters:

inRule - the topology rule to remove from the topology.

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