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

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

All Implemented Interfaces:

GPTool

public class Clip
extends AbstractGPTool

Uses the outside polygon boundary of the clip coverage to cookie-cut features and attributes from the input coverage. The Clip tool is contained in the Coverage Tools tool box.

Usage tips:

• A fuzzy tolerance value of zero will not be accepted by CLIP.
• The Clip Coverage must have polygon topology.
• When the input coverage contains linear data belonging to different planar graphs, the data will be maintained in the output coverage. For example, with coincident or colinear arcs such as arcs representing utility cables at different levels or a road following a stream, the coincident and colinear line segments will be preserved. However, additional vertices may be inserted. In the case of intersecting arcs such as a road passing over a stream, nodes will not be inserted at the apparent intersection.
• Boundaries of interior polygons in the Clip Coverage are not used in CLIP. Any Clip Coverage polygon whose internal number is greater than one is considered inside the Clipping window.
• The User-ID for each feature will be the same in output coverage as it is in input coverage.
• When clipping polygons, new label points for polygons are only generated when necessary. Each old polygon keeps its original label point position if the label is within the clipping boundary.
• Annotation is saved if its lower left starting point falls within the clipping polygon.
• New nodes created on the clipping boundary have their attributes set to zero.
• Route systems are maintained for LINE, NET, LINK, and RAW options but ignored on the POLY option. Route systems are duplicated for arcs split into multiple pieces and eliminated for eliminated arcs. CLIP maintains all route system subclasses.
• Route systems are duplicated for arcs split into multiple pieces and eliminated for removed arcs. The RAT-ID item is the unique route identifier and is used to remove duplicates. If you need to maintain all the user-defined attributes, make sure all the route IDs are unique before running CLIP; otherwise, some user-defined attributes may be lost.
• When all the regions are removed, the region subclasses are maintained as empty subclasses.
• Region subclasses of the input coverage are maintained with the POLY and NET options. Regions in the input coverage are clipped in the output coverage by the extent of the Clip Coverage.
• The output coverage tics are copied from the input coverage.
• Annotation features from the input coverage are clipped and saved in the output coverage.
• If an NAT exists in the input coverage, it will be updated in the output coverage. New nodes will have their attributes set to zero.
• The output coverage inherits these data model contents from the input coverage:
  • Feature classes
  • Feature attribute table items
  • User-IDs
  • Tics
  • Annotation
  • Node attribute table
  • Projection file
• The coordinate precision of each output coverage is determined by the current processing rule as set by the environment setting. If the processing rule has not been established during the current session, the output coverages will be in the same precision as the input coverage.
• Projection files will be compared for similarity using the level of comparison specified with the environment setting.

Field Summary

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

vals

Constructor Summary

Clip()
Creates the Clip tool with defaults.

Clip(Object inCover, Object clipCover, Object outCover)
Creates the Clip tool with the required parameters.

Method Summary

Object	getClipCover() Returns the Clip Coverage 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	setClipCover(Object clipCover) Sets the Clip Coverage 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

Clip

public Clip()

Creates the Clip tool with defaults.

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

Clip

public Clip(Object inCover,
            Object clipCover,
            Object outCover)

Creates the Clip 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 features to be clipped.

clipCover - the coverage whose outer polygon defines the clipping region.

outCover - the coverage to be created. The output coverage cannot already exist.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage containing features to be clipped. 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 features to be clipped. This is a required parameter.

Parameters:

inCover - the coverage containing features to be clipped.

getClipCover

public Object getClipCover()

Returns the Clip Coverage parameter of this tool . This parameter is the coverage whose outer polygon defines the clipping region. This is a required parameter.

Returns:

the Clip Coverage

setClipCover

public void setClipCover(Object clipCover)

Sets the Clip Coverage parameter of this tool . This parameter is the coverage whose outer polygon defines the clipping region. This is a required parameter.

Parameters:

clipCover - the coverage whose outer polygon defines the clipping region.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the coverage to be created. The output coverage cannot already exist. 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 cannot already exist. This is a required parameter.

Parameters:

outCover - the coverage to be created. The output coverage cannot already exist.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the feature class to be clipped: 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 the feature class to be clipped: This is an optional parameter.

Parameters:

featureType - the feature class to be clipped:

getFuzzyTolerance

public double getFuzzyTolerance()

Returns the Fuzzy Tolerance parameter of this tool . This parameter is the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used. 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 the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used. This is an optional parameter.

Parameters:

fuzzyTolerance - the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input coverage and erase coverage is used.

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