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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.
Learn more about how Intersect works

Software restrictions: none

Illustration:

Usage tips:


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 - (Feature Layer Long; Feature Layer Long;...), 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. With ArcView and Editor licenses, the number of input feature classes or layers is limited to two.
outFeatureClass - Feature Class, the feature class to which the results will be written.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is (Feature Layer Long; Feature Layer Long;...), 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. With ArcView and Editor licenses, the number of input feature classes or layers is limited to two. 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 (Feature Layer Long; Feature Layer Long;...), 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. With ArcView and Editor licenses, the number of input feature classes or layers is limited to two. This is a required parameter.

Parameters:
inFeatures - (Feature Layer Long; Feature Layer Long;...), 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. With ArcView and Editor licenses, the number of input feature classes or layers is limited to two.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class to which the results will be written. 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 Feature Class, the feature class to which the results will be written. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the feature class to which the results will be written.

getJoinAttributes

public String getJoinAttributes()
Returns the JoinAttributes parameter of this tool . This parameter is String, 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 String, determines which attributes from the Input Features will be transferred to the Output Feature Class. This is an optional parameter.

Parameters:
joinAttributes - String, 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 Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets 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 Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. This is an optional parameter.

Parameters:
clusterTolerance - Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy.

getOutputType

public String getOutputType()
Returns the Output Type parameter of this tool . This parameter is String, 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 String, choose what type of intersection you want to find. This is an optional parameter.

Parameters:
outputType - String, 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