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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.cartographytools.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 Cartography Tools tool box.

Illustration:

Usage tips:


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.
  • POINT_REMOVE—Keeps the so-called critical points that depict the essential shape of a polygon and removes all other points. This is the default.
  • BEND_SIMPLIFY—Keeps the main shape of a polygon and removes extraneous bends in the boundary.
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.
  • For POINT_REMOVE algorithm, the tolerance you specify is the maximum allowable offset.
  • For BEND_SIMPLIFY algorithm, the tolerance you specify is the length of the reference bend baseline.
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.
  • POINT_REMOVE—Keeps the so-called critical points that depict the essential shape of a polygon and removes all other points. This is the default.
  • BEND_SIMPLIFY—Keeps the main shape of a polygon and removes extraneous bends in the boundary.

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.
  • For POINT_REMOVE algorithm, the tolerance you specify is the maximum allowable offset.
  • For BEND_SIMPLIFY algorithm, the tolerance you specify is the length of the reference bend baseline.

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.
  • NO_CHECK—Specifies not to check topological errors. This is the default.
  • FLAG_ERRORS—Specifies to flag topological errors if any are found.
  • RESOLVE_ERRORS—Specifies to resolve topological errors if any are found.

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.
  • KEEP_COLLAPSED_POINTS—Specifies to keep the collapsed zero-area polygons as points. The endpoints of the collapsed polygon boundaries will be stored in a point feature class at the output feature class location, taking the name of the output feature class plus a suffix _Pnt. This is the default.
  • NO_KEEP—Specifies not to keep the collapsed zero-area polygons as points even if they are found in the process; therefore, the point feature class will be empty.

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