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

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

public class Identity
extends AbstractGPTool

Computes a geometric intersection of the Input Features and Identity Features. The Input Features or portions thereof that overlap Identity Features will get the attributes of those Identity Features. The Identity tool is contained in the Analysis Tools tool box.
Learn more about how Identity works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Identity()
          Creates the Identity tool with defaults.
Identity(Object inFeatures, Object identityFeatures, Object outFeatureClass)
          Creates the Identity tool with the required parameters.
 
Method Summary
 Object getClusterTolerance()
          Returns the XY Tolerance parameter of this tool .
 Object getIdentityFeatures()
          Returns the Identity Features 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 getRelationship()
          Returns the Keep relationships 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 setIdentityFeatures(Object identityFeatures)
          Sets the Identity Features 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 setRelationship(String relationship)
          Sets the Keep relationships 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

Identity

public Identity()
Creates the Identity tool with defaults.

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


Identity

public Identity(Object inFeatures,
                Object identityFeatures,
                Object outFeatureClass)
Creates the Identity 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, the input feature class or layer.
identityFeatures - Feature Layer, the identity feature class or layer. Must be polygons.
outFeatureClass - Feature Class, the feature class that will be created and 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, the input feature class or layer. 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, the input feature class or layer. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the input feature class or layer.

getIdentityFeatures

public Object getIdentityFeatures()
Returns the Identity Features parameter of this tool . This parameter is Feature Layer, the identity feature class or layer. Must be polygons. This is a required parameter.

Returns:
the Identity Features

setIdentityFeatures

public void setIdentityFeatures(Object identityFeatures)
Sets the Identity Features parameter of this tool . This parameter is Feature Layer, the identity feature class or layer. Must be polygons. This is a required parameter.

Parameters:
identityFeatures - Feature Layer, the identity feature class or layer. Must be polygons.

getOutFeatureClass

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

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

getJoinAttributes

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

Parameters:
joinAttributes - String, determines what attributes 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.

getRelationship

public String getRelationship()
Returns the Keep relationships parameter of this tool . This parameter is String, choose if you want additional spatial relationships between the Input Features and Identity Features to be written to the output. This only applies when the Input Features are lines and the Identity Features are polygons This is an optional parameter.

Returns:
the Keep relationships

setRelationship

public void setRelationship(String relationship)
Sets the Keep relationships parameter of this tool . This parameter is String, choose if you want additional spatial relationships between the Input Features and Identity Features to be written to the output. This only applies when the Input Features are lines and the Identity Features are polygons This is an optional parameter.

Parameters:
relationship - String, choose if you want additional spatial relationships between the Input Features and Identity Features to be written to the output. This only applies when the Input Features are lines and the Identity Features are polygons

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