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

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

public class Eliminate
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Merges the selected polygons with neighboring polygons if they have the largest shared border or the largest area. With the LINE option, Eliminate merges selected arcs separated by pseudo nodes into single arcs. Eliminate is often used to remove sliver polygons created during polygon overlay or buffering. The Eliminate tool is contained in the Coverage Tools tool box.
Learn more about how Eliminate works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


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 - Coverage, the coverage whose selected polygons or arcs will be merged into neighboring features.
outCover - Coverage, 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 - ArcInfo Expression; ArcInfo Expression..., build a query using Query Builder to create 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 Coverage, 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 Coverage, the coverage whose selected polygons or arcs will be merged into neighboring features. This is a required parameter.

Parameters:
inCover - Coverage, 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 Coverage, 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 Coverage, 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 - Coverage, 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 ArcInfo Expression; ArcInfo Expression..., build a query using Query Builder to create 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 ArcInfo Expression; ArcInfo Expression..., build a query using Query Builder to create one or more logical expressions to select features from the input coverage. This is a required parameter.

Parameters:
infoExpress - ArcInfo Expression; ArcInfo Expression..., build a query using Query Builder to create 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 String, 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 String, ensures that polygons along the coverage boundary are not altered. This is an optional parameter.

Parameters:
polygonBoundary - String, 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 String, 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 String, 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 - String, 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 File, is a pre-existing 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 File, is a pre-existing file that identifies which features will be used. This is an optional parameter.

Parameters:
selectionFile - File, is a pre-existing 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 String, 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 String, specifies which method will be used for eliminating polygons. This parameter is only used for polygon coverages. This is an optional parameter.

Parameters:
polygonOption - String, 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