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

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

public class Erase
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Creates a new output coverage by overlaying the polygons of the erase coverage with the features of the input coverage. Only those portions of the input coverage features falling outside the erase polygon outside boundaries are copied to the output coverage. The Erase tool is contained in the Coverage Tools tool box.
Learn more about how Erase works

Software restrictions: ArcInfo only

Illustration:

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 inCover, Object eraseCover, Object outCover)
          Creates the Erase tool with the required parameters.
 
Method Summary
 Object getEraseCover()
          Returns the Erase Coverage parameter of this tool .
 String getFeatureType()
          Returns the Feature Type parameter of this tool .
 double getFuzzyTolerance()
          Returns the Fuzzy Tolerance parameter of this tool .
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage 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 setEraseCover(Object eraseCover)
          Sets the Erase Coverage parameter of this tool .
 void setFeatureType(String featureType)
          Sets the Feature Type parameter of this tool .
 void setFuzzyTolerance(double fuzzyTolerance)
          Sets the Fuzzy Tolerance parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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 inCover,
             Object eraseCover,
             Object outCover)
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:
inCover - Coverage, containing features to be erased.
eraseCover - Coverage, the coverage whose outer polygon defines the erasing region.
outCover - Coverage, the coverage to be created.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, containing features to be erased. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is Coverage, containing features to be erased. This is a required parameter.

Parameters:
inCover - Coverage, containing features to be erased.

getEraseCover

public Object getEraseCover()
Returns the Erase Coverage parameter of this tool . This parameter is Coverage, the coverage whose outer polygon defines the erasing region. This is a required parameter.

Returns:
the Erase Coverage

setEraseCover

public void setEraseCover(Object eraseCover)
Sets the Erase Coverage parameter of this tool . This parameter is Coverage, the coverage whose outer polygon defines the erasing region. This is a required parameter.

Parameters:
eraseCover - Coverage, the coverage whose outer polygon defines the erasing region.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the coverage to be created. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the coverage to be created. This is a required parameter.

Parameters:
outCover - Coverage, the coverage to be created.

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is String, the set of features to be erased: This is an optional parameter.

Returns:
the Feature Type

setFeatureType

public void setFeatureType(String featureType)
Sets the Feature Type parameter of this tool . This parameter is String, the set of features to be erased: This is an optional parameter.

Parameters:
featureType - String, the set of features to be erased:

getFuzzyTolerance

public double getFuzzyTolerance()
Returns the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used. This is an optional parameter.

Returns:
the Fuzzy Tolerance

setFuzzyTolerance

public void setFuzzyTolerance(double fuzzyTolerance)
Sets the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used. This is an optional parameter.

Parameters:
fuzzyTolerance - Double, the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used.

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