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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.Erase

All Implemented Interfaces:

GPTool

public class Erase
extends AbstractGPTool

Creates a The Erase tool is contained in the Analysis Tools tool box.
Learn more about how Erase works

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• Input Feature polygons that are coincident; with Erase Feature polygons will be removed.
• The Erase Features must be polygons.
• This tool may generate multipart features in the input even if all inputs were singlepart. If multipart features are not desired, use the Multipart to Singlepart tool; on the output.
• When processing datasets that contain any individual feature with a very large number of vertices (e.g., hundreds of thousands to millions of vertices within a single feature), some geometric processing operations may run out of memory. For more details, see Geoprocessing with large datasets;
• Learn about priority ranks and geoprocessing tools;
• Learn more about xy tolerance;
• Learn more about Topology Basics;
• The following environment settings affect this tool: Coordinate system; Extent; XY Tolerance; Z Tolerance; M Tolerance; XY Resolution; Z Resolution; M Resolution; Output XY domain; Output Z domain; Output M domain; Output has M values; Output has Z values; Default Z value; Configuration keyword; Output Spatial Grid;

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 - Feature Layer, the input feature class or layer.

eraseFeatures - Feature Layer, the features whose outer polygon defines the erasing area.

outFeatureClass - Feature Class, the feature class that will contain only those Input Features that lie outside the Erase Features area.

Method Detail

getInFeatures

public Object getInFeatures()

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

Parameters:

inFeatures - Feature Layer, the input feature class or layer.

getEraseFeatures

public Object getEraseFeatures()

Returns the Erase Features parameter of this tool . This parameter is Feature Layer, the features whose outer polygon defines the erasing area. 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 Feature Layer, the features whose outer polygon defines the erasing area. This is a required parameter.

Parameters:

eraseFeatures - Feature Layer, the features whose outer polygon defines the erasing area.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class that will contain only those Input Features that lie outside the Erase Features area. 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 Feature Class, the feature class that will contain only those Input Features that lie outside the Erase Features area. This is a required parameter.

Parameters:

outFeatureClass - Feature Class, the feature class that will contain only those Input Features that lie outside the Erase Features area.

getClusterTolerance

public Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. 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 Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. This is an optional parameter.

Parameters:

clusterTolerance - Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy.

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