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

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

All Implemented Interfaces:

GPTool

public class Eliminate
extends AbstractGPTool

Merges the selected polygons with neighboring polygons if they have the largest shared border or the largest area. The Eliminate tool is contained in the Coverage Tools tool box.

Usage tips:

• Only the selected set of polygons or lines will be eliminated. Polygons that border the background polygon will not be eliminated when KEEP_EDGE is specified.
• For the POLY option, an arc with a negative User-ID will never be eliminated, even if it's the longest arc in a selected polygon. When this happens, the next longest arc is eliminated unless it's along the coverage boundary when the Keep polygon boundary option is selected (KEEP_EDGE).
• It's possible to eliminate a sliver polygon existing as a neighbor to the background polygon, by not selecting the Keep polygon boundary option (NO_KEEP_EDGE) and still maintain the outer polygon boundary. the coverage with the LINE option, then on the cover.AAT using the following logical expression:LPOLY# = 1 OR RPOLY# = 1 Calculate the cover-id equal to -1. Eliminate will not eliminate an arc with a negative User-ID.
• For the feature type POLY option, route systems attached to eliminated arcs will be removed, and ARCLINK# will be renumbered. For the feature type LINE option, route systems belonging to eliminated arcs (whether actually removed or not) will be deleted. Those belonging to arcs that increased in length by absorbing eliminated arcs will have their F-POS and T-POS adjusted so they will occupy the same set of locations as previously.
• For the LINE option, all arcs must be split where they intersect other arcs. Eliminate will abort execution if it encounters overlapping arcs. with LINE can be used to split arcs.
• If the Input Coverage has an NAT (node attribute table), it will be maintained in the Output Coverage.
• Use of indexed items can speed up logical feature selection in Eliminate. See Index Item for details.
• Input Coverage annotation is copied to the Output Coverage.
• The projection file (PRJ) will be copied to the Output Coverage.
• If the Input Coverage has regions, they are maintained in the Output Coverage with the appropriate polygons eliminated from the region subclasses.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Eliminate()
Creates the Eliminate tool with defaults.

Eliminate(Object inCover, Object outCover, Object infoExpress)
Creates the Eliminate tool with the required parameters.

Method Summary

String	getFeatureType() Returns the Feature Type parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getInfoExpress() Returns the INFO Expression parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
String	getPolygonBoundary() Returns the Keep polygon boundary parameter of this tool .
String	getPolygonOption() Returns the Eliminating polygon by border parameter of this tool .
Object	getSelectionFile() Returns the Selection File 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	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setInfoExpress(Object infoExpress) Sets the INFO Expression parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setPolygonBoundary(String polygonBoundary) Sets the Keep polygon boundary parameter of this tool .
void	setPolygonOption(String polygonOption) Sets the Eliminating polygon by border parameter of this tool .
void	setSelectionFile(Object selectionFile) Sets the Selection File 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

Eliminate

public Eliminate()

Creates the Eliminate tool with defaults.

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

Eliminate

public Eliminate(Object inCover,
                 Object outCover,
                 Object infoExpress)

Creates the Eliminate 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 whose selected polygons or arcs will be merged into neighboring features.

outCover - the new coverage with all the selected sliver polygons merged into larger features. There should be a smaller number of polygons than the Input Coverage contains.

infoExpress - an INFO query containing one or more logical expressions to select features from the input coverage.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage whose selected polygons or arcs will be merged into neighboring features. 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 whose selected polygons or arcs will be merged into neighboring features. This is a required parameter.

Parameters:

inCover - the coverage whose selected polygons or arcs will be merged into neighboring features.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the new coverage with all the selected sliver polygons merged into larger features. There should be a smaller number of polygons than the Input Coverage contains. 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 new coverage with all the selected sliver polygons merged into larger features. There should be a smaller number of polygons than the Input Coverage contains. This is a required parameter.

Parameters:

outCover - the new coverage with all the selected sliver polygons merged into larger features. There should be a smaller number of polygons than the Input Coverage contains.

getInfoExpress

public Object getInfoExpress()

Returns the INFO Expression parameter of this tool . This parameter is an INFO query containing one or more logical expressions to select features from the input coverage. This is a required parameter.

Returns:

the INFO Expression

setInfoExpress

public void setInfoExpress(Object infoExpress)

Sets the INFO Expression parameter of this tool . This parameter is an INFO query containing one or more logical expressions to select features from the input coverage. This is a required parameter.

Parameters:

infoExpress - an INFO query containing one or more logical expressions to select features from the input coverage.

getPolygonBoundary

public String getPolygonBoundary()

Returns the Keep polygon boundary parameter of this tool . This parameter is ensures that polygons along the coverage boundary are not altered. This is an optional parameter.

Returns:

the Keep polygon boundary

setPolygonBoundary

public void setPolygonBoundary(String polygonBoundary)

Sets the Keep polygon boundary parameter of this tool . This parameter is ensures that polygons along the coverage boundary are not altered. This is an optional parameter.

Parameters:

polygonBoundary - ensures that polygons along the coverage boundary are not altered.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the feature class(es) to be eliminated in the Output Coverage. This parameter is only used for polygon coverages. 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 feature class(es) to be eliminated in the Output Coverage. This parameter is only used for polygon coverages. This is an optional parameter.

Parameters:

featureType - the feature class(es) to be eliminated in the Output Coverage. This parameter is only used for polygon coverages.

getSelectionFile

public Object getSelectionFile()

Returns the Selection File parameter of this tool . This parameter is a Selection File is a preexisting file that identifies which features will be used. This is an optional parameter.

Returns:

the Selection File

setSelectionFile

public void setSelectionFile(Object selectionFile)

Sets the Selection File parameter of this tool . This parameter is a Selection File is a preexisting file that identifies which features will be used. This is an optional parameter.

Parameters:

selectionFile - a Selection File is a preexisting file that identifies which features will be used.

getPolygonOption

public String getPolygonOption()

Returns the Eliminating polygon by border parameter of this tool . This parameter is specifies which method will be used for eliminating polygons. This parameter is only used for polygon coverages. This is an optional parameter.

Returns:

the Eliminating polygon by border

setPolygonOption

public void setPolygonOption(String polygonOption)

Sets the Eliminating polygon by border parameter of this tool . This parameter is specifies which method will be used for eliminating polygons. This parameter is only used for polygon coverages. This is an optional parameter.

Parameters:

polygonOption - specifies which method will be used for eliminating polygons. This parameter is only used for polygon coverages.

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