com.esri.arcgis.geoprocessing.tools.coveragetools
Class SimplifyLineOrPolygon

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.SimplifyLineOrPolygon

All Implemented Interfaces:

GPTool

public class SimplifyLineOrPolygon
extends AbstractGPTool

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

Usage tips:

• If the input coverage already contains intersecting lines, or if you want a quick result and don't care about topological errors in the output coverage, use the default option, which is not to Check for topological errors. Any topological errors introduced by the process will not be checked and corrected. If the input coverage contains intersecting lines, and you choose to Check for topological errors, it will fail at the input data validation, and the program will terminate with a message: "Intersecting lines are found in in_cover. The program is terminated".
• If the input coverage contains no intersecting lines, check the Check for topological errors option to find and avoid errors generated by the simplification process. If any topological errors are found, the involved arcs will be regeneralized using a reduced tolerance. The result will be checked for topological errors again. The process iterates until no more errors are found. With this option, the program will run much longer than with the default option.
• Unless there is no input_coverage.AAT, the output_coverage.AAT will contain a new item, TOLFLAG, which stores the tolerance in decimal numbers used for each arc. Tolerances smaller than the Simplification Tolerance indicate arcs that are undersimplified to avoid topological errors.
• If polygon topology exists for the input coverage, it is not preserved in the output coverage. The coverage PAT, however, is preserved. Build must be used to re-create polygon topology. If labels exit, they will be preserved. If a label falls outside the polygon boundary as the boundary is simplified, it will be moved just inside the nearest line segment of the polygon boundary.
• If regions exist in the Input Coverage, regions in the Output Coverage will be preliminary regions. When is used to re-create the polygon topology, region topology will also be re-created.
• The coordinate precision of the output coverage is determined by the current processing rule set by the environment setting. If the processing rule has not been established, the output coverage will be the same precision as the input coverage.

Field Summary

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

vals

Constructor Summary

SimplifyLineOrPolygon()
Creates the Simplify Line Or Polygon tool with defaults.

SimplifyLineOrPolygon(Object inCover, Object outCover, double simplificationTolerance)
Creates the Simplify Line Or Polygon tool with the required parameters.

Method Summary

String	getErrorCheck() Returns the Check for topological errors parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
String	getSimplificationOperator() Returns the Simplification Operator parameter of this tool .
double	getSimplificationTolerance() 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	setErrorCheck(String errorCheck) Sets the Check for topological errors parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setSimplificationOperator(String simplificationOperator) Sets the Simplification Operator parameter of this tool .
void	setSimplificationTolerance(double simplificationTolerance) 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

SimplifyLineOrPolygon

public SimplifyLineOrPolygon()

Creates the Simplify Line Or Polygon tool with defaults.

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

SimplifyLineOrPolygon

public SimplifyLineOrPolygon(Object inCover,
                             Object outCover,
                             double simplificationTolerance)

Creates the Simplify Line Or 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:

inCover - the coverage containing arcs or polygons to be simplified.

outCover - the coverage to be created. The output coverage name must be different from the input coverage name.

simplificationTolerance - sets the tolerance in coverage units. A tolerance must be specified and must be greater than zero.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage containing arcs or polygons to be simplified. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage containing arcs or polygons to be simplified. This is a required parameter.

Parameters:

inCover - the coverage containing arcs or polygons to be simplified.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the coverage to be created. The output coverage name must be different from the input coverage name. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the coverage to be created. The output coverage name must be different from the input coverage name. This is a required parameter.

Parameters:

outCover - the coverage to be created. The output coverage name must be different from the input coverage name.

getSimplificationTolerance

public double getSimplificationTolerance()

Returns the Simplification Tolerance parameter of this tool . This parameter is sets the tolerance in coverage units. A tolerance must be specified and must be greater than zero. This is a required parameter.

Returns:

the Simplification Tolerance

setSimplificationTolerance

public void setSimplificationTolerance(double simplificationTolerance)

Sets the Simplification Tolerance parameter of this tool . This parameter is sets the tolerance in coverage units. A tolerance must be specified and must be greater than zero. This is a required parameter.

Parameters:

simplificationTolerance - sets the tolerance in coverage units. A tolerance must be specified and must be greater than zero.

getSimplificationOperator

public String getSimplificationOperator()

Returns the Simplification Operator parameter of this tool . This parameter is specifies the simplification operator. This is an optional parameter.

Returns:

the Simplification Operator

setSimplificationOperator

public void setSimplificationOperator(String simplificationOperator)

Sets the Simplification Operator parameter of this tool . This parameter is specifies the simplification operator. This is an optional parameter.

Parameters:

simplificationOperator - specifies the simplification operator.

getErrorCheck

public String getErrorCheck()

Returns the Check for topological errors parameter of this tool . This parameter is specifies whether to check for topological errors, including line-crossing, line-overlapping, zero-length lines, collapsed polygons, and holes falling outside of polygons. This is an optional parameter.

Returns:

the Check for topological errors

setErrorCheck

public void setErrorCheck(String errorCheck)

Sets the Check for topological errors parameter of this tool . This parameter is specifies whether to check for topological errors, including line-crossing, line-overlapping, zero-length lines, collapsed polygons, and holes falling outside of polygons. This is an optional parameter.

Parameters:

errorCheck - specifies whether to check for topological errors, including line-crossing, line-overlapping, zero-length lines, collapsed polygons, and holes falling outside of polygons.

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