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

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

All Implemented Interfaces:

GPTool

public class Clip
extends AbstractGPTool

Extracts input features that overlay the clip features. The Clip tool is contained in the Analysis Tools tool box.

Usage tips:

• The Clip Features dataset must be polygons.
• The Output Feature Class will contain all the attributes of the Input Features.
• This tool will use a tiling process to handle very large datasets for better performance and scalability. For more details, see .
• Line features clipped by polygon features
• Point features clipped by polygon features
• Attribute values from the input feature class(es) will be copied to the output feature class. However, if the input is a layer(s) created by the tool and a field's "Use Ratio Policy" is checked, then a ratio of the input attribute value is calculated for the output attribute value. When "Use Ratio Policy" is enabled, whenever a feature in an overlay operation is split, the attributes of the resulting features are a ratio of the attribute value of the input feature. The output value is based on the ratio in which the input feature geometry was divided. For example, If the input geometry was divided equally, each new feature's attribute value is assigned one-half of the value of the input feature's attribute value. "Use Ratio Policy" only applies to numeric field types.Geoprocessing tools do not honor geodatabase feature class or table field split policies.

Field Summary

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

vals

Constructor Summary

Clip()
Creates the Clip tool with defaults.

Clip(Object inFeatures, Object clipFeatures, Object outFeatureClass)
Creates the Clip tool with the required parameters.

Method Summary

Object	getClipFeatures() Returns the Clip Features parameter of this tool .
Object	getClusterTolerance() Returns the XY Tolerance 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 .
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	setClipFeatures(Object clipFeatures) Sets the Clip Features parameter of this tool .
void	setClusterTolerance(Object clusterTolerance) Sets the XY Tolerance 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 .

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 inFeatures,
            Object clipFeatures,
            Object outFeatureClass)

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:

inFeatures - the features to be clipped.

clipFeatures - the features used to clip the input features.

outFeatureClass - the feature class to be created.

Method Detail

getInFeatures

public Object getInFeatures()

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

Parameters:

inFeatures - the features to be clipped.

getClipFeatures

public Object getClipFeatures()

Returns the Clip Features parameter of this tool . This parameter is the features used to clip the input features. This is a required parameter.

Returns:

the Clip Features

setClipFeatures

public void setClipFeatures(Object clipFeatures)

Sets the Clip Features parameter of this tool . This parameter is the features used to clip the input features. This is a required parameter.

Parameters:

clipFeatures - the features used to clip the input features.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - the feature class to be created.

getClusterTolerance

public Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). Set the value to be higher for data with less coordinate accuracy and lower for data with extremely high accuracy. This is an optional parameter.

Returns:

the XY Tolerance

setClusterTolerance

public void setClusterTolerance(Object clusterTolerance)

Sets the XY Tolerance parameter of this tool . This parameter is the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). Set the value to be higher for data with less coordinate accuracy and lower for data with extremely high accuracy. This is an optional parameter.

Parameters:

clusterTolerance - the minimum distance separating all feature coordinates (nodes and vertices) as well as the distance a coordinate can move in X or Y (or both). Set the value to be higher for data with less coordinate accuracy and lower for data with extremely high accuracy.

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