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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.Identity

All Implemented Interfaces:

GPTool

public class Identity
extends AbstractGPTool

Computes the geometric intersection of two coverages. All features of the input coverage, as well as those features of the identity coverage that overlap the input coverage, are preserved in the output coverage. The Identity tool is contained in the Coverage Tools tool box.

Usage tips:

• The identity coverage must have polygon topology.
• The input coverage, identity coverage, and output coverage must have different names, even when in different workspaces.
• Route systems in the input coverage are maintained in the output coverage. However, IDENTITY on routes and sections themselves are not permitted.
• Region subclasses from both input coverage and identity coverage are maintained with the POLY option. Subclasses with identical names and attribute schemas are appended. Output regions are clipped by the extent of the output coverage.
• Label points are generated in each output coverage polygon when the POLY option is used. The new polygon User-IDs are set equal to the polygon internal number minus one. When the LINE option is used, User-IDs of the input coverage are maintained.
• Annotation is copied from input coverage and saved in output coverage.
• The coordinate precision of the output coverage is determined by the environment.
• Projection files will be compared for similarity using the level of comparison specified in the environment.
• The output coverage inherits the items from the point attribute table, tics, and the projection file data model contents from the input coverage.
• When the input coverage contains linear data belonging to different planar graphs, the data will be maintained in the output coverage. For example, with coincident or colinear arcs such as arcs representing utility cables at different levels or a road following a stream, the coincident and colinear line segments will be preserved. However, additional vertices may be inserted. In the case of intersecting arcs such as a road passing over a stream, nodes will not be inserted at the apparent intersection.

Field Summary

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

vals

Constructor Summary

Identity()
Creates the Identity tool with defaults.

Identity(Object inCover, Object identityCover, Object outCover)
Creates the Identity tool with the required parameters.

Method Summary

String	getFeatureType() Returns the Feature Type parameter of this tool .
double	getFuzzyTolerance() Returns the Fuzzy Tolerance parameter of this tool .
Object	getIdentityCover() Returns the Identity Coverage parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
String	getJoinAttributes() Returns the Join attributes parameter of this tool .
Object	getOutCover() Returns the Output Coverage 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	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setFuzzyTolerance(double fuzzyTolerance) Sets the Fuzzy Tolerance parameter of this tool .
void	setIdentityCover(Object identityCover) Sets the Identity Coverage parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setJoinAttributes(String joinAttributes) Sets the Join attributes parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage 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 inCover,
                Object identityCover,
                Object outCover)

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:

inCover - the coverage that will be overlaid with the identity coverage.

identityCover - the coverage that will be identitied with the input coverage. Must have polygon features.

outCover - the coverage to be created.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage that will be overlaid with the identity coverage. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage that will be overlaid with the identity coverage. This is a required parameter.

Parameters:

inCover - the coverage that will be overlaid with the identity coverage.

getIdentityCover

public Object getIdentityCover()

Returns the Identity Coverage parameter of this tool . This parameter is the coverage that will be identitied with the input coverage. Must have polygon features. This is a required parameter.

Returns:

the Identity Coverage

setIdentityCover

public void setIdentityCover(Object identityCover)

Sets the Identity Coverage parameter of this tool . This parameter is the coverage that will be identitied with the input coverage. Must have polygon features. This is a required parameter.

Parameters:

identityCover - the coverage that will be identitied with the input coverage. Must have polygon features.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the coverage to be created. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the coverage to be created. This is a required parameter.

Parameters:

outCover - the coverage to be created.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the feature class from the input coverage that will be used. This is an optional parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(String featureType)

Sets the Feature Type parameter of this tool . This parameter is the feature class from the input coverage that will be used. This is an optional parameter.

Parameters:

featureType - the feature class from the input coverage that will be used.

getFuzzyTolerance

public double getFuzzyTolerance()

Returns the Fuzzy Tolerance parameter of this tool . This parameter is the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used. This is an optional parameter.

Returns:

the Fuzzy Tolerance

setFuzzyTolerance

public void setFuzzyTolerance(double fuzzyTolerance)

Sets the Fuzzy Tolerance parameter of this tool . This parameter is the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used. This is an optional parameter.

Parameters:

fuzzyTolerance - the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used.

getJoinAttributes

public String getJoinAttributes()

Returns the Join attributes parameter of this tool . This parameter is specifies whether all items in both the input coverage feature attribute and identity coverage will be joined to the output coverage feature attribute table. This is an optional parameter.

Returns:

the Join attributes

setJoinAttributes

public void setJoinAttributes(String joinAttributes)

Sets the Join attributes parameter of this tool . This parameter is specifies whether all items in both the input coverage feature attribute and identity coverage will be joined to the output coverage feature attribute table. This is an optional parameter.

Parameters:

joinAttributes - specifies whether all items in both the input coverage feature attribute and identity coverage will be joined to the output coverage feature attribute table.

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