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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.coveragetools.Clean
All Implemented Interfaces:
GPTool

public class Clean
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Generates a The Clean tool is contained in the Coverage Tools tool box.
Learn more about how Clean works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Clean()
          Creates the Clean tool with defaults.
Clean(Object inCover)
          Creates the Clean tool with the required parameters.
 
Method Summary
 double getDangleLength()
          Returns the Dangle Length parameter of this tool .
 String getFeatureType()
          Returns the Feature Type parameter of this tool .
 double getFuzzyTolerance()
          Returns the Fuzzy Tolerance 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 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 setDangleLength(double dangleLength)
          Sets the Dangle Length parameter of this tool .
 void setFeatureType(String featureType)
          Sets the Feature Type parameter of this tool .
 void setFuzzyTolerance(double fuzzyTolerance)
          Sets the Fuzzy Tolerance 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 .
 
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

Clean

public Clean()
Creates the Clean tool with defaults.

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


Clean

public Clean(Object inCover)
Creates the Clean 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 - Coverage, the coverage to be cleaned.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, the coverage to be cleaned. 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 Coverage, the coverage to be cleaned. This is a required parameter.

Parameters:
inCover - Coverage, the coverage to be cleaned.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the coverage created by Clean. If the Input Coverage and the Output Coverage have the same name, the Input Coverage will be replaced. By default, the Input Coverage is replaced. This is an optional parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the coverage created by Clean. If the Input Coverage and the Output Coverage have the same name, the Input Coverage will be replaced. By default, the Input Coverage is replaced. This is an optional parameter.

Parameters:
outCover - Coverage, the coverage created by Clean. If the Input Coverage and the Output Coverage have the same name, the Input Coverage will be replaced. By default, the Input Coverage is replaced.

getDangleLength

public double getDangleLength()
Returns the Dangle Length parameter of this tool . This parameter is Double, the minimum length allowed for dangling arcs in the Output Coverage. A dangling arc is an arc that has the same polygon internal number on its left and right sides and ends at a dangling node. Dangling arcs are removed for both the POLY and LINE options. If the Dangle Length is not provided, the dangle length is read from the coverage TOL file if the TOL file exists. Otherwise, dangle length is set to zero (the default). This is an optional parameter.

Returns:
the Dangle Length

setDangleLength

public void setDangleLength(double dangleLength)
Sets the Dangle Length parameter of this tool . This parameter is Double, the minimum length allowed for dangling arcs in the Output Coverage. A dangling arc is an arc that has the same polygon internal number on its left and right sides and ends at a dangling node. Dangling arcs are removed for both the POLY and LINE options. If the Dangle Length is not provided, the dangle length is read from the coverage TOL file if the TOL file exists. Otherwise, dangle length is set to zero (the default). This is an optional parameter.

Parameters:
dangleLength - Double, the minimum length allowed for dangling arcs in the Output Coverage. A dangling arc is an arc that has the same polygon internal number on its left and right sides and ends at a dangling node. Dangling arcs are removed for both the POLY and LINE options. If the Dangle Length is not provided, the dangle length is read from the coverage TOL file if the TOL file exists. Otherwise, dangle length is set to zero (the default).

getFuzzyTolerance

public double getFuzzyTolerance()
Returns the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in each Output Coverage. This is an optional parameter.

Returns:
the Fuzzy Tolerance

setFuzzyTolerance

public void setFuzzyTolerance(double fuzzyTolerance)
Sets the Fuzzy Tolerance parameter of this tool . This parameter is Double, the minimum distance between coordinates in each Output Coverage. This is an optional parameter.

Parameters:
fuzzyTolerance - Double, the minimum distance between coordinates in each Output Coverage.

getFeatureType

public String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is String, specifies whether to create polygon topology and a PAT or arc-node topology and an AAT. POLY is the default option. If POLY is used on a coverage that has an existing AAT, Clean will also automatically rebuild the AAT. This is an optional parameter.

Returns:
the Feature Type

setFeatureType

public void setFeatureType(String featureType)
Sets the Feature Type parameter of this tool . This parameter is String, specifies whether to create polygon topology and a PAT or arc-node topology and an AAT. POLY is the default option. If POLY is used on a coverage that has an existing AAT, Clean will also automatically rebuild the AAT. This is an optional parameter.

Parameters:
featureType - String, specifies whether to create polygon topology and a PAT or arc-node topology and an AAT. POLY is the default option. If POLY is used on a coverage that has an existing AAT, Clean will also automatically rebuild the AAT.

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