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

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

All Implemented Interfaces:

GPTool

public class SimplifyLine
extends AbstractGPTool

Simplifies a line by removing small fluctuations or extraneous bends from it while preserving its essential shape. The Simplify Line tool is contained in the Data Management Tools tool box.
Learn more about how Simplify Line works

Software restrictions: ArcInfo and ArcEditor only

Illustration:

Usage tips:

• The tool will produce two output feature classes, a line feature class and a point feature class. The line output will store all the simplified lines; and the point output will store points, if any, representing closed lines that are collapsed to zero-length as the result of simplification and cannot be written to the line output. Once the line output is specified, the point output will be automatically derived taking the same output location and the line output name plus a suffix, _Pnt.
• The line output will carry all the input fields. The point output will not.
• Significant differences between the two algorithms:
• Handling topological errors - three levels of processes by the combinations of the two parameters or the two checkbox options as described below:Both FLAG_ERRORS and RESOLVE_ERRORS options preserve shared geometry, including shared lines and connections.A small feature on one side of a line can end up to the other side 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

SimplifyLine()
Creates the Simplify Line tool with defaults.

SimplifyLine(Object inFeatures, Object outFeatureClass, String algorithm, Object tolerance)
Creates the Simplify Line 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	getErrorCheckingOption() Returns the Check for topological errors parameter of this tool .
String	getErrorResolvingOption() Returns the Resolve topological errors 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	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	setErrorCheckingOption(String errorCheckingOption) Sets the Check for topological errors parameter of this tool .
void	setErrorResolvingOption(String errorResolvingOption) Sets the Resolve topological errors 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	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

SimplifyLine

public SimplifyLine()

Creates the Simplify Line tool with defaults.

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

SimplifyLine

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

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

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

algorithm - String, specifies the line 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 line 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 line features to be simplified. This is a required parameter.

Parameters:

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

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

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

getAlgorithm

public String getAlgorithm()

Returns the Simplification Algorithm parameter of this tool . This parameter is String, specifies the line 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 line simplification algorithm. This is a required parameter.

Parameters:

algorithm - String, specifies the line 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.

getErrorResolvingOption

public String getErrorResolvingOption()

Returns the Resolve 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 parameter will be in effect when the error_checking_option is CHECK (the default). This is an optional parameter.

Returns:

the Resolve topological errors

setErrorResolvingOption

public void setErrorResolvingOption(String errorResolvingOption)

Sets the Resolve 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 parameter will be in effect when the error_checking_option is CHECK (the default). This is an optional parameter.

Parameters:

errorResolvingOption - 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 parameter will be in effect when the error_checking_option is CHECK (the default).

getCollapsedPointOption

public String getCollapsedPointOption()

Returns the Keep collapsed points parameter of this tool . This parameter is String, specifies whether to keep collapsed zero-length lines as points if any are found in the process. This option applies only when NO_CHECK is specified or when both FLAG_ERRORS and CHECK options are 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-length lines as points if any are found in the process. This option applies only when NO_CHECK is specified or when both FLAG_ERRORS and CHECK options are specified. This is an optional parameter.

Parameters:

collapsedPointOption - String, specifies whether to keep collapsed zero-length lines as points if any are found in the process. This option applies only when NO_CHECK is specified or when both FLAG_ERRORS and CHECK options are specified.

getErrorCheckingOption

public String getErrorCheckingOption()

Returns the Check for 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 Check for topological errors

setErrorCheckingOption

public void setErrorCheckingOption(String errorCheckingOption)

Sets the Check for 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:

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

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