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

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

public class RemoveOverride
extends AbstractGPTool

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

Software restrictions: ArcInfo only

Usage tips:


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 - Feature Layer, the input feature layer containing representation(s).
representation - String, the representation from which the specified overrides will be removed.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the input feature layer containing representation(s). 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 Feature Layer, the input feature layer containing representation(s). This is a required parameter.

Parameters:
inFeatures - Feature Layer, the input feature layer containing representation(s).

getRepresentation

public String getRepresentation()
Returns the Representation parameter of this tool . This parameter is String, the representation from which the specified 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 String, the representation from which the specified overrides will be removed. This is a required parameter.

Parameters:
representation - String, the representation from which the specified overrides will be removed.

getRemoveOption

public String getRemoveOption()
Returns the Remove Option parameter of this tool . This parameter is String, specifies the override to 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 String, specifies the override to be removed. This is an optional parameter.

Parameters:
removeOption - String, specifies the override to 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