com.esri.arcgis.geoprocessing.tools.analysistools
Class Erase

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

public class Erase
extends AbstractGPTool

Creates a feature class by overlaying the Input Features with the polygons of the Erase Features. Only those portions of the input features falling outside the erase features outside boundaries are copied to the output feature class. The Erase tool is contained in the Analysis Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Erase()
          Creates the Erase tool with defaults.
Erase(Object inFeatures, Object eraseFeatures, Object outFeatureClass)
          Creates the Erase tool with the required parameters.
 
Method Summary
 Object getClusterTolerance()
          Returns the XY Tolerance parameter of this tool .
 Object getEraseFeatures()
          Returns the Erase Features parameter of this tool .
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class 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 setClusterTolerance(Object clusterTolerance)
          Sets the XY Tolerance parameter of this tool .
 void setEraseFeatures(Object eraseFeatures)
          Sets the Erase Features parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class 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

Erase

public Erase()
Creates the Erase tool with defaults.

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


Erase

public Erase(Object inFeatures,
             Object eraseFeatures,
             Object outFeatureClass)
Creates the Erase 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 class or layer.
eraseFeatures - the features to be used to erase coincident features in the input.
outFeatureClass - the feature class that will contain only those Input Features that are not coincident with the Erase Features.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is the input feature class or layer. 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 class or layer. This is a required parameter.

Parameters:
inFeatures - the input feature class or layer.

getEraseFeatures

public Object getEraseFeatures()
Returns the Erase Features parameter of this tool . This parameter is the features to be used to erase coincident features in the input. This is a required parameter.

Returns:
the Erase Features

setEraseFeatures

public void setEraseFeatures(Object eraseFeatures)
Sets the Erase Features parameter of this tool . This parameter is the features to be used to erase coincident features in the input. This is a required parameter.

Parameters:
eraseFeatures - the features to be used to erase coincident features in the input.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is the feature class that will contain only those Input Features that are not coincident with the Erase Features. This is a required parameter.

Returns:
the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is the feature class that will contain only those Input Features that are not coincident with the Erase Features. This is a required parameter.

Parameters:
outFeatureClass - the feature class that will contain only those Input Features that are not coincident with the Erase Features.

getClusterTolerance

public Object getClusterTolerance()
Returns the XY Tolerance parameter of this tool . This parameter is the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). This is an optional parameter.

Returns:
the XY Tolerance

setClusterTolerance

public void setClusterTolerance(Object clusterTolerance)
Sets the XY Tolerance parameter of this tool . This parameter is the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). This is an optional parameter.

Parameters:
clusterTolerance - the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both).

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