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

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

All Implemented Interfaces:

GPTool

public class Eliminate
extends AbstractGPTool

Eliminates polygons by merging them with neighboring polygons that have the largest area or the longest shared border. Eliminate is often used to remove small sliver polygons that are the result of overlay operations, such as Intersect or Union. The Eliminate tool is contained in the Data Management Tools tool box.

Usage tips:

• Features to be eliminated are determined by a selected feature set applied to a polygon layer. The selected set must be determined in a previous step by using , using , or querying a map layer in ArcMap.
• The Input Layer must include a selection; otherwise, Eliminate will fail.
• The Exclusion Expression and Exclusion Layer are not mutually exclusive and can be used together to give full control over what is eliminated.

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	getExFeatures() Returns the Exclusion Layer parameter of this tool .
Object	getExWhereClause() Returns the Exclusion Expression parameter of this tool .
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	setExFeatures(Object exFeatures) Sets the Exclusion Layer parameter of this tool .
void	setExWhereClause(Object exWhereClause) Sets the Exclusion Expression parameter 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 - the layer whose polygons will be merged into neighboring polygons.

outFeatureClass - the feature class to be created.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Layer parameter of this tool . This parameter is 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 the layer whose polygons will be merged into neighboring polygons. This is a required parameter.

Parameters:

inFeatures - 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 the feature class to be created. 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 the feature class to be created. This is a required parameter.

Parameters:

outFeatureClass - the feature class to be created.

getSelection

public String getSelection()

Returns the Eliminating polygon by border parameter of this tool . This parameter is 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 these options specify which method will be used for eliminating features. This is an optional parameter.

Parameters:

selection - these options specify which method will be used for eliminating features.

getExWhereClause

public Object getExWhereClause()

Returns the Exclusion Expression parameter of this tool . This parameter is an expression used to identify input features that should not be eliminated. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference. This is an optional parameter.

Returns:

the Exclusion Expression

setExWhereClause

public void setExWhereClause(Object exWhereClause)

Sets the Exclusion Expression parameter of this tool . This parameter is an expression used to identify input features that should not be eliminated. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference. This is an optional parameter.

Parameters:

exWhereClause - an expression used to identify input features that should not be eliminated. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference.

getExFeatures

public Object getExFeatures()

Returns the Exclusion Layer parameter of this tool . This parameter is an input polyline or polygon feature class or layer that defines polygon boundaries, or portions thereof, that should not be eliminated. This is an optional parameter.

Returns:

the Exclusion Layer

setExFeatures

public void setExFeatures(Object exFeatures)

Sets the Exclusion Layer parameter of this tool . This parameter is an input polyline or polygon feature class or layer that defines polygon boundaries, or portions thereof, that should not be eliminated. This is an optional parameter.

Parameters:

exFeatures - an input polyline or polygon feature class or layer that defines polygon boundaries, or portions thereof, that should not be eliminated.

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