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

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

public class Eliminate
extends AbstractGPTool

Merges the selected polygons with neighboring polygons with the largest shared border or the largest area The Eliminate tool is contained in the Data Management Tools tool box.

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 inFeatures, Object outFeatureClass)
          Creates the Eliminate tool with the required parameters.
 
Method Summary
 Object getInFeatures()
          Returns the Input Layer parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 String getSelection()
          Returns the Eliminating polygon by border 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 setInFeatures(Object inFeatures)
          Sets the Input Layer parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setSelection(String selection)
          Sets the Eliminating polygon by border 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 inFeatures,
                 Object outFeatureClass)
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:
inFeatures - Feature Layer, the layer whose polygons will be merged into neighboring polygons.
outFeatureClass - Feature Class, the feature class to be created. There should be a smaller number of features than in the input layer.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Layer parameter of this tool . This parameter is Feature Layer, the layer whose polygons will be merged into neighboring polygons. This is a required parameter.

Returns:
the Input Layer

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Layer parameter of this tool . This parameter is Feature Layer, the layer whose polygons will be merged into neighboring polygons. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the layer whose polygons will be merged into neighboring polygons.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class to be created. There should be a smaller number of features than in the input layer. 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 to be created. There should be a smaller number of features than in the input layer. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the feature class to be created. There should be a smaller number of features than in the input layer.

getSelection

public String getSelection()
Returns the Eliminating polygon by border parameter of this tool . This parameter is String, these options specify which method will be used for eliminating features. This is an optional parameter.

Returns:
the Eliminating polygon by border

setSelection

public void setSelection(String selection)
Sets the Eliminating polygon by border parameter of this tool . This parameter is String, these options specify which method will be used for eliminating features. This is an optional parameter.

Parameters:
selection - String, these options specify which method will be used for eliminating features.

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