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.

Usage tips:

• Input Features can be point, multipoint, line, or polygon. The inputs cannot be annotation features, dimension features, or network features.
• Identity Features must be polygons or have the same geometry type as the Input Features.
• When using this tool with point input and polygon Identity Features, points that fall directly on a polygon boundary will be added to the output twice; once for each polygon that is part of the boundary. Running the on the output of this scenario will identify the duplicate points so you can decide which one to keep.
• Checking or setting the Keep relationships 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.
• 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 .
• This tool may generate multipart features in the output even if all inputs were single part. If multipart features are not desired, use the on the output feature class.

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 - the input feature class or layer.

identityFeatures - the identity feature class or layer. Must be polygons or the same geometry type as the Input Features.

outFeatureClass - 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 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 the input feature class or layer. This is a required parameter.

Parameters:

inFeatures - the input feature class or layer.

getIdentityFeatures

public Object getIdentityFeatures()

Returns the Identity Features parameter of this tool . This parameter is the identity feature class or layer. Must be polygons or the same geometry type as the Input Features. 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 the identity feature class or layer. Must be polygons or the same geometry type as the Input Features. This is a required parameter.

Parameters:

identityFeatures - the identity feature class or layer. Must be polygons or the same geometry type as the Input Features.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - 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 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 determines what attributes will be transferred to the Output Feature Class. This is an optional parameter.

Parameters:

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

getRelationship

public String getRelationship()

Returns the Keep relationships parameter of this tool . This parameter is 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 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 - 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