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

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

All Implemented Interfaces:

GPTool

public class SimplifyPolygon
extends AbstractGPTool

Simplifies a polygon by removing small fluctuations or extraneous bends from its boundary while preserving its essential shape. The Simplify Polygon tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• The tool will produce two output feature classes, a polygon feature class and a point feature class. The polygon output will store all the simplified polygons; and the point output will store points, if any, representing polygons that are collapsed to zero-area as the result of simplification and cannot be written to the polygon output. Once the polygon output is specified, the point output will be automatically derived taking the same output location and the polygon output name plus a suffix, _Pnt.
• The polygon output will carry all the input fields. The point output will not.
• Significant differences between the two algorithms:
• The two algorithms used in this tool are the same as those used in Simplify Line tool. See "related topics" above.
• The minimum area applies to simplified polygons. For a group of adjacent polygons, it applies to the total area of the group.
• Handling topological errors - three levels of processes:A small polygon near a larger polygon can end up inside the larger polygon due to a relatively large simplification_tolerance. This spatial relationship error will not be detected by the program.
• The "Keep collapsed points" checkbox or the collapsed_point parameter only applies to the NO_CHECK and FLAG_ERRORS options for handling topological errors.
• The point output will be empty in the following cases:
• Learn more about spatial reference and geoprocessing;
• The following environment settings affect this tool: XY tolerance; Extent; M domain; , , Coordinate system; Output has M values; Output has Z values; Default Z value; Output XY domain; workspace; , and scratch workspace;

Field Summary

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

vals

Constructor Summary

SimplifyPolygon()
Creates the Simplify Polygon tool with defaults.

SimplifyPolygon(Object inFeatures, Object outFeatureClass, String algorithm, Object tolerance)
Creates the Simplify Polygon tool with the required parameters.

Method Summary

String	getAlgorithm() Returns the Simplification Algorithm parameter of this tool .
String	getCollapsedPointOption() Returns the Keep collapsed points parameter of this tool .
String	getErrorOption() Returns the Handling Topological Errors parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getMinimumArea() Returns the Minimum Area parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getOutPointFeatureClass() Returns the Output Point Feature Class parameter of this tool (Read only).
Object	getTolerance() Returns the Simplification Tolerance 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	setAlgorithm(String algorithm) Sets the Simplification Algorithm parameter of this tool .
void	setCollapsedPointOption(String collapsedPointOption) Sets the Keep collapsed points parameter of this tool .
void	setErrorOption(String errorOption) Sets the Handling Topological Errors parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setMinimumArea(Object minimumArea) Sets the Minimum Area parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setTolerance(Object tolerance) Sets the Simplification Tolerance 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

SimplifyPolygon

public SimplifyPolygon()

Creates the Simplify Polygon tool with defaults.

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

SimplifyPolygon

public SimplifyPolygon(Object inFeatures,
                       Object outFeatureClass,
                       String algorithm,
                       Object tolerance)

Creates the Simplify Polygon 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 polygon features to be simplified.

outFeatureClass - Feature Class, the output polygon feature class to be created.

algorithm - String, specifies the polygon simplification algorithm.

tolerance - Linear Unit, the tolerance that determines the degree of simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the polygon features to be simplified. 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 Feature Layer, the polygon features to be simplified. This is a required parameter.

Parameters:

inFeatures - Feature Layer, the polygon features to be simplified.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output polygon 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 Feature Class, the output polygon feature class to be created. This is a required parameter.

Parameters:

outFeatureClass - Feature Class, the output polygon feature class to be created.

getAlgorithm

public String getAlgorithm()

Returns the Simplification Algorithm parameter of this tool . This parameter is String, specifies the polygon simplification algorithm. This is a required parameter.

Returns:

the Simplification Algorithm

setAlgorithm

public void setAlgorithm(String algorithm)

Sets the Simplification Algorithm parameter of this tool . This parameter is String, specifies the polygon simplification algorithm. This is a required parameter.

Parameters:

algorithm - String, specifies the polygon simplification algorithm.

getTolerance

public Object getTolerance()

Returns the Simplification Tolerance parameter of this tool . This parameter is Linear Unit, the tolerance that determines the degree of simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit. This is a required parameter.

Returns:

the Simplification Tolerance

setTolerance

public void setTolerance(Object tolerance)

Sets the Simplification Tolerance parameter of this tool . This parameter is Linear Unit, the tolerance that determines the degree of simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit. This is a required parameter.

Parameters:

tolerance - Linear Unit, the tolerance that determines the degree of simplification. A tolerance must be specified, and it must be greater than zero. You can specify a preferred unit; the default is the feature unit.

getMinimumArea

public Object getMinimumArea()

Returns the Minimum Area parameter of this tool . This parameter is Areal Unit, sets the minimum area for a simplified polygon to be retained. The default value is zero, that is, to keep all polygons. You can choose a preferred unit for the specified value; the default is the feature unit. This is an optional parameter.

Returns:

the Minimum Area

setMinimumArea

public void setMinimumArea(Object minimumArea)

Sets the Minimum Area parameter of this tool . This parameter is Areal Unit, sets the minimum area for a simplified polygon to be retained. The default value is zero, that is, to keep all polygons. You can choose a preferred unit for the specified value; the default is the feature unit. This is an optional parameter.

Parameters:

minimumArea - Areal Unit, sets the minimum area for a simplified polygon to be retained. The default value is zero, that is, to keep all polygons. You can choose a preferred unit for the specified value; the default is the feature unit.

getErrorOption

public String getErrorOption()

Returns the Handling Topological Errors parameter of this tool . This parameter is String, specifies how the topological errors (possibly introduced in the process, including line crossing, line overlapping, and collapsed zero-length lines) will be handled. This is an optional parameter.

Returns:

the Handling Topological Errors

setErrorOption

public void setErrorOption(String errorOption)

Sets the Handling Topological Errors parameter of this tool . This parameter is String, specifies how the topological errors (possibly introduced in the process, including line crossing, line overlapping, and collapsed zero-length lines) will be handled. This is an optional parameter.

Parameters:

errorOption - String, specifies how the topological errors (possibly introduced in the process, including line crossing, line overlapping, and collapsed zero-length lines) will be handled.

getCollapsedPointOption

public String getCollapsedPointOption()

Returns the Keep collapsed points parameter of this tool . This parameter is String, specifies whether to keep collapsed zero-area polygons as points if any are found in the process. This option applies only when NO_CHECK or FLAG_ERRORS is specified. This is an optional parameter.

Returns:

the Keep collapsed points

setCollapsedPointOption

public void setCollapsedPointOption(String collapsedPointOption)

Sets the Keep collapsed points parameter of this tool . This parameter is String, specifies whether to keep collapsed zero-area polygons as points if any are found in the process. This option applies only when NO_CHECK or FLAG_ERRORS is specified. This is an optional parameter.

Parameters:

collapsedPointOption - String, specifies whether to keep collapsed zero-area polygons as points if any are found in the process. This option applies only when NO_CHECK or FLAG_ERRORS is specified.

getOutPointFeatureClass

public Object getOutPointFeatureClass()

Returns the Output Point Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Point Feature Class

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