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

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

All Implemented Interfaces:

GPTool

public class EliminatePolygonPart
extends AbstractGPTool

Creates a new output feature class containing the features from the input polygons with some parts or holes of a specified size deleted. The Eliminate Polygon Part tool is contained in the Data Management Tools tool box.

Usage tips:

• Since polygon holes are considered parts of the polygon, they can be deleted or filled using this tool. If the hole area is smaller than the specified size, the hole will be eliminated and the space will be filled in the output. Any parts that are inside the deleted hole will also be eliminated in the output.
• Part size can be specified as an area, a percent, or a combination of both. Use the Condition parameter to determine how the part size will be specified. The Condition parameter AREA_AND_PERCENT and AREA_OR_PERCENT options are used to eliminate parts using both the area and percent criteria.
• Polygon part percent is calculated as a percentage of the feature's total outer area, including the area of any holes. For example, if a polygon with a hole has an area of 75 square meters, with the hole covering 25 square meters, the polygons total outer area is 100 square meters. To eliminate this hole, an area greater than 25 square meters or a percentage greater than 25% would need to be specified. If the input is a multipart polygon, a feature's outer area is the sum of the area covered by all polygon parts.
• For multipart polygons, the area of each part will be compared with the specified area. If an individual polygon part is smaller than the specified size, the part will be eliminated in the output.
• If all of a polygon feature's parts are smaller than the specified size, the largest part will be kept in the output while all other parts will be eliminated.

Field Summary

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

vals

Constructor Summary

EliminatePolygonPart()
Creates the Eliminate Polygon Part tool with defaults.

EliminatePolygonPart(Object inFeatures, Object outFeatureClass)
Creates the Eliminate Polygon Part tool with the required parameters.

Method Summary

String	getCondition() Returns the Condition parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getPartArea() Returns the Area parameter of this tool .
double	getPartAreaPercent() Returns the Percentage parameter of this tool .
String	getPartOption() Returns the Eliminate contained parts only 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	setCondition(String condition) Sets the Condition parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPartArea(Object partArea) Sets the Area parameter of this tool .
void	setPartAreaPercent(double partAreaPercent) Sets the Percentage parameter of this tool .
void	setPartOption(String partOption) Sets the Eliminate contained parts only 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

EliminatePolygonPart

public EliminatePolygonPart()

Creates the Eliminate Polygon Part tool with defaults.

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

EliminatePolygonPart

public EliminatePolygonPart(Object inFeatures,
                            Object outFeatureClass)

Creates the Eliminate Polygon Part 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 input feature class or layer whose features will be copied to the output feature class, with some parts or holes eliminated.

outFeatureClass - the output polygon feature class containing the remaining parts.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature class or layer whose features will be copied to the output feature class, with some parts or holes eliminated. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input feature class or layer whose features will be copied to the output feature class, with some parts or holes eliminated. This is a required parameter.

Parameters:

inFeatures - the input feature class or layer whose features will be copied to the output feature class, with some parts or holes eliminated.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output polygon feature class containing the remaining parts. 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 output polygon feature class containing the remaining parts. This is a required parameter.

Parameters:

outFeatureClass - the output polygon feature class containing the remaining parts.

getCondition

public String getCondition()

Returns the Condition parameter of this tool . This parameter is specify how the parts to be eliminated will be determined. This is an optional parameter.

Returns:

the Condition

setCondition

public void setCondition(String condition)

Sets the Condition parameter of this tool . This parameter is specify how the parts to be eliminated will be determined. This is an optional parameter.

Parameters:

condition - specify how the parts to be eliminated will be determined.

getPartArea

public Object getPartArea()

Returns the Area parameter of this tool . This parameter is eliminate parts smaller than this area. This is an optional parameter.

Returns:

the Area

setPartArea

public void setPartArea(Object partArea)

Sets the Area parameter of this tool . This parameter is eliminate parts smaller than this area. This is an optional parameter.

Parameters:

partArea - eliminate parts smaller than this area.

getPartAreaPercent

public double getPartAreaPercent()

Returns the Percentage parameter of this tool . This parameter is eliminate parts smaller than this percentage of a feature's total outer area. This is an optional parameter.

Returns:

the Percentage

setPartAreaPercent

public void setPartAreaPercent(double partAreaPercent)

Sets the Percentage parameter of this tool . This parameter is eliminate parts smaller than this percentage of a feature's total outer area. This is an optional parameter.

Parameters:

partAreaPercent - eliminate parts smaller than this percentage of a feature's total outer area.

getPartOption

public String getPartOption()

Returns the Eliminate contained parts only parameter of this tool . This parameter is determines what parts can be eliminated. This is an optional parameter.

Returns:

the Eliminate contained parts only

setPartOption

public void setPartOption(String partOption)

Sets the Eliminate contained parts only parameter of this tool . This parameter is determines what parts can be eliminated. This is an optional parameter.

Parameters:

partOption - determines what parts can 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