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

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

All Implemented Interfaces:

GPTool

public class Erase
extends AbstractGPTool

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.

Usage tips:

• The output coverage cannot already exist.
• Annotation is erased if its lower left starting point falls within the erasing polygon.
• New nodes have their attributes set to zero.
• Input coverage polygons that are coincident with erase coverage polygons are removed.
• The erase coverage must have polygon topology.
• User-IDs for all features are the same in the output coverage as they are in the input coverage.
• For the POLY and NET options, polygon topology is rebuilt in the output coverage. Whenever possible, input polygon label points are preserved in the output. Each old polygon keeps its original label point position if it falls outside an erase coverage polygon.
• Boundaries of interior polygons in the erase coverage are not used in ERASE. Any erase coverage polygon whose internal number is greater than one is considered inside the erasing window; an internal polygon number of one is considered outside. Only those input features (or portions of them) that are outside the erasing region are stored in the output coverage.
• The outside boundaries of the erase coverage define the area of Input coverage features to be removed. Any erase coverage polygon with an internal number greater than one is considered inside the erasing window; an internal polygon number of one is considered outside.
• If the erase coverage polygon happens to fall completely within an input polygon, then no polygons are erased. An extra polygon is inserted in the output coverage, as defined by the outline polygon of the erase coverage, and given a label point with a User-ID = 0. This is for the POLY option. If the LINE option is used, then nothing extra is added. The output coverage remains identical to the input coverage.
• Route systems will be rebuilt for LINE, NET, LINK, and RAW options but ignored on the POLY option. Route systems are duplicated for arcs split into multiple pieces and eliminated for eliminated arcs. ERASE maintains all route system subclasses.
• Region subclasses in the input coverage are maintained with the POLY option. Regions in the input coverage are erased in the output coverage by the extent of the erase coverage.
• Region subclasses in the erase coverage are not inherited.
• If a node attribute table(NAT) exists before ERASE, then it remains afterward for those nodes that survive the ERASE. New nodes have their attributes set to zero.
• The output coverage tics are copied from the input coverage.
• The projection file (PRJ) is copied to the output coverage.
• The coordinate precision of the output coverage is determined by the current processing rule as set by the environment setting. If the processing rule is not established, the output coverage is the same precision as the input coverage.
• When the input coverage contains linear data belonging to different planar graphs, the data will be maintained in the output coverage. For example, with coincident or colinear arcs such as arcs representing utility cables at different levels or a road following a stream, the coincident and colinear line segments will be preserved. However, additional vertices may be inserted. In the case of intersecting arcs such as a road passing over a stream, nodes will not be inserted at the apparent intersection.
• .

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 - the coverage containing features to be erased.

eraseCover - the coverage whose outer polygon defines the erasing region.

outCover - the coverage to be created.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the 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 the coverage containing features to be erased. This is a required parameter.

Parameters:

inCover - the coverage containing features to be erased.

getEraseCover

public Object getEraseCover()

Returns the Erase Coverage parameter of this tool . This parameter is 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 the coverage whose outer polygon defines the erasing region. This is a required parameter.

Parameters:

eraseCover - the coverage whose outer polygon defines the erasing region.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is 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 the coverage to be created. This is a required parameter.

Parameters:

outCover - the coverage to be created.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is 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 the set of features to be erased: This is an optional parameter.

Parameters:

featureType - the set of features to be erased:

getFuzzyTolerance

public double getFuzzyTolerance()

Returns the Fuzzy Tolerance parameter of this tool . This parameter is 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. learn more about how the default fuzzy tolerance is calculated. 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 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. learn more about how the default fuzzy tolerance is calculated. This is an optional parameter.

Parameters:

fuzzyTolerance - 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. learn more about how the default fuzzy tolerance is calculated.

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