com.esri.arcgis.geoprocessing.tools.cartographytools
Class RemoveOverride

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.RemoveOverride

All Implemented Interfaces:

GPTool

public class RemoveOverride
extends AbstractGPTool

Removes geometry and/or property representation overrides from features participating in a feature class representation. The Remove Override tool is contained in the Cartography Tools tool box.

Usage tips:

• Features will not be deleted, just representation overrides.
• The Remove Option parameter specifies which type of representation override will be removed.
  • Removing geometry overrides reassociates a feature with the geometry stored in its Shape field. The alternate representation geometry will be deleted. Geometry overrides are sometimes called shape overrides.
  • Removing property overrides removes all feature-specific property overrides and reverts the feature back to following the native representation rule.

Field Summary

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

vals

Constructor Summary

RemoveOverride()
Creates the Remove Override tool with defaults.

RemoveOverride(Object inFeatures, String representation)
Creates the Remove Override tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
String	getRemoveOption() Returns the Remove Option parameter of this tool .
String	getRepresentation() Returns the Representation 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	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setRemoveOption(String removeOption) Sets the Remove Option parameter of this tool .
void	setRepresentation(String representation) Sets the Representation 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

RemoveOverride

public RemoveOverride()

Creates the Remove Override tool with defaults.

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

RemoveOverride

public RemoveOverride(Object inFeatures,
                      String representation)

Creates the Remove Override 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:

inFeatures - the input feature layer containing at least one representation.

representation - the representation from which representation overrides will be removed.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature layer containing at least one representation. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input feature layer containing at least one representation. This is a required parameter.

Parameters:

inFeatures - the input feature layer containing at least one representation.

getRepresentation

public String getRepresentation()

Returns the Representation parameter of this tool . This parameter is the representation from which representation overrides will be removed. This is a required parameter.

Returns:

the Representation

setRepresentation

public void setRepresentation(String representation)

Sets the Representation parameter of this tool . This parameter is the representation from which representation overrides will be removed. This is a required parameter.

Parameters:

representation - the representation from which representation overrides will be removed.

getRemoveOption

public String getRemoveOption()

Returns the Remove Option parameter of this tool . This parameter is specifies which types of overrides will be removed. This is an optional parameter.

Returns:

the Remove Option

setRemoveOption

public void setRemoveOption(String removeOption)

Sets the Remove Option parameter of this tool . This parameter is specifies which types of overrides will be removed. This is an optional parameter.

Parameters:

removeOption - specifies which types of overrides will be removed.

getOutFeatures

public Object getOutFeatures()

Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Features

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