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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


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(java.lang.Object inCover, java.lang.Object outCover, double simplificationTolerance)
          Creates the Simplify Line Or Polygon tool with the required parameters.
 
Method Summary
 java.lang.String getErrorCheck()
          Returns the Check for topological errors parameter of this tool .
 java.lang.Object getInCover()
          Returns the Input Coverage parameter of this tool .
 java.lang.Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 java.lang.String getSimplificationOperator()
          Returns the Simplification Operator parameter of this tool .
 double getSimplificationTolerance()
          Returns the Simplification Tolerance parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setErrorCheck(java.lang.String errorCheck)
          Sets the Check for topological errors parameter of this tool .
 void setInCover(java.lang.Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOutCover(java.lang.Object outCover)
          Sets the Output Coverage parameter of this tool .
 void setSimplificationOperator(java.lang.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(java.lang.Object inCover,
                             java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias