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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• The Input Features must be point, multipoint, line, or polygon. The inputs cannot be annotation features, dimension features, or network features.
• The Identity Features must be polygons.
• Output may be multipart. If multipart features are not desired, use the Multipart to Singlepart tool; on the output.
• Checking or setting the Relationship parameter to KEEP_RELATIONSHIPS will write additional spatial relationships between the Input Features and the Identity Features to the output feature class. If the inputs are lines and the Identity Features are polygons, there will be two additional fields, LEFT_poly and RIGHT_poly. These new fields will contain the FID of the polygon Identity Features to the right and to the left of each input line feature.
• When processing datasets that contain any individual feature with a very large number of vertices (e.g., hundreds of thousands to millions of vertices within a single feature), some geometric processing operations may run out of memory. For more details, see Geoprocessing with large datasets;
• Learn more about spatial reference and geoprocessing;
• Learn about priority ranks and geoprocessing tools;
• Learn more about xy tolerance;
• Learn more about Topology Basics;
• The following environment settings affect this tool: Coordinate system; Extent; XY Tolerance; Z Tolerance; M Tolerance; XY Resolution; Z Resolution; M Resolution; Output XY domain; Output Z domain; Output M domain; Output has M values; Output has Z values; Default Z value; Configuration keyword; Output Spatial Grid;

Field Summary

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

vals

Constructor Summary

Identity()
Creates the Identity tool with defaults.

Identity(java.lang.Object inFeatures, java.lang.Object identityFeatures, java.lang.Object outFeatureClass)
Creates the Identity tool with the required parameters.

Method Summary

java.lang.Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
java.lang.Object	getIdentityFeatures() Returns the Identity Features parameter of this tool .
java.lang.Object	getInFeatures() Returns the Input Features parameter of this tool .
java.lang.String	getJoinAttributes() Returns the JoinAttributes parameter of this tool .
java.lang.Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
java.lang.String	getRelationship() Returns the Keep relationships parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setClusterTolerance(java.lang.Object clusterTolerance) Sets the XY Tolerance parameter of this tool .
void	setIdentityFeatures(java.lang.Object identityFeatures) Sets the Identity Features parameter of this tool .
void	setInFeatures(java.lang.Object inFeatures) Sets the Input Features parameter of this tool .
void	setJoinAttributes(java.lang.String joinAttributes) Sets the JoinAttributes parameter of this tool .
void	setOutFeatureClass(java.lang.Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setRelationship(java.lang.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(java.lang.Object inFeatures,
                java.lang.Object identityFeatures,
                java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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

• ALL—All the attributes (including FIDs) from the Input Features as well as the Identity Features will be transferred to the Output Feature Class. This is the default.
• NO_FID—All the attributes except the FID from the Input Features and Identity Features will be transferred to the Output Feature Class.
• ONLY_FID—All the attributes from the Input Features but only the FID from the Identity Features will be transferred to the Output Feature Class.

getClusterTolerance

public java.lang.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(java.lang.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 java.lang.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(java.lang.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

• NO_RELATIONSHIPS—No additional spatial relationship will be determined.
• KEEP_RELATIONSHIPS—Left and right polygon information will be determined for line on polygon identity and written into the RIGHT_poly, LEFT_poly field in the output.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias