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

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

All Implemented Interfaces:

GPTool

public class Intersect
extends AbstractGPTool

Computes a geometric intersection of the input features. Features or portions of features which overlap in all layers and/or feature classes will be written to the output feature class. The Intersect tool is contained in the Analysis Tools tool box.

Usage tips:

• Input Features must be simple features: point, multipoint, line, or polygon. They cannot be complex features such as annotation features, dimension features, or network features.
• If the inputs have different geometry types (that is, line on poly, point on line, and so on), the Output Feature Class geometry type will default to be the same as the Input Features with the lowest dimension geometry. For example, if one or more of the inputs is of type point, the default output will be point; if one or more of the inputs is line, the default output will be line; and if all inputs are polygon, the default output will be polygon.
• The Output Type can be that of the Input Features with the lowest dimension geometry or lower. For example, if all the inputs are polygons, the output could be polygon, line, or point. If one of the inputs is of type line and none are points, the output can be line or point. If any of the inputs are point, the Output Type can only be point.
• 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.
• This tool will use a tiling process to handle very large datasets for better performance and scalability. For more details, see .
• With Basic and Standard licenses, the number of input feature classes or layers is limited to two.

Field Summary

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

vals

Constructor Summary

Intersect()
Creates the Intersect tool with defaults.

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

Method Summary

Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
String	getJoinAttributes() Returns the JoinAttributes parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getOutputType() Returns the Output Type 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	setClusterTolerance(Object clusterTolerance) Sets the XY Tolerance parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setJoinAttributes(String joinAttributes) Sets the JoinAttributes parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutputType(String outputType) Sets the Output Type 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

Intersect

public Intersect()

Creates the Intersect tool with defaults.

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

Intersect

public Intersect(Object inFeatures,
                 Object outFeatureClass)

Creates the Intersect 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 - a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. For more information, see Priority ranks and Geoprocessing tools.

outFeatureClass - the output feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. For more information, see Priority ranks and Geoprocessing tools. 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 a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. For more information, see Priority ranks and Geoprocessing tools. This is a required parameter.

Parameters:

inFeatures - a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. For more information, see Priority ranks and Geoprocessing tools.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - the output feature class.

getJoinAttributes

public String getJoinAttributes()

Returns the JoinAttributes parameter of this tool . This parameter is determines which attributes from the Input Features will be transferred to the Output Feature Class. This is an optional parameter.

Returns:

the JoinAttributes

setJoinAttributes

public void setJoinAttributes(String joinAttributes)

Sets the JoinAttributes parameter of this tool . This parameter is determines which attributes from the Input Features will be transferred to the Output Feature Class. This is an optional parameter.

Parameters:

joinAttributes - determines which attributes from the Input Features will be transferred to the Output Feature Class.

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). 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). 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).

getOutputType

public String getOutputType()

Returns the Output Type parameter of this tool . This parameter is choose what type of intersection you want to find. This is an optional parameter.

Returns:

the Output Type

setOutputType

public void setOutputType(String outputType)

Sets the Output Type parameter of this tool . This parameter is choose what type of intersection you want to find. This is an optional parameter.

Parameters:

outputType - choose what type of intersection you want to find.

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