com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class Integrate

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.Integrate

All Implemented Interfaces:

GPTool

public class Integrate
extends AbstractGPTool

Integrate is used to maintain the integrity of shared feature boundaries by making features coincident if they fall within the specified x,y tolerance. Features that fall within the specified x,y tolerance are considered identical or coincident. The Integrate tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool modifies the input data. See for more information and strategies to avoid undesired data changes.
• If there are any input features selected, this tool will execute only on those selected features.
• This tool performs the same kind of work as a topology in that it moves features within an x,y tolerance and inserts vertices where features intersect. Consider using a topology to perform this sort of operation because a topology allows you to specify rules and conditions about how features relate to each other. For more information about using topologies, see .You would use Integrate rather than a topology when:
  • You do not need to specify any rules about how features are moved—you simply want all features to coalesce within a specified tolerance.
  • You want lines to have vertices wherever they intersect.
  • You are working with non-geodatabase features such as shapefiles, or with features from different geodatabases (features in a topology must all come from the same feature dataset).
• The value for XY Tolerance is critical—a tolerance that is too large may collapse and delete polygons or lines, or move vertices that should not be moved. To minimize error, the value you choose for x,y tolerance should be as small as possible.
• Integrate accepts only simple feature classes as input (point, multipoint, line, or polygon). The input features cannot include annotation features, dimension features, network features, and so on.
• To undo changes to the input features, use Integrate in an edit session.
• When processing datasets that contain individual features 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 .
• The output data element of this tool is a derived multivalue output. To use this tool's output(s) with another tool, use its input(s) directly and set its output as a precondition of the other tool, as illustrated below. .

Field Summary

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

vals

Constructor Summary

Integrate()
Creates the Integrate tool with defaults.

Integrate(java.lang.Object inFeatures)
Creates the Integrate tool with the required parameters.

Method Summary

java.lang.Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
java.lang.Object	getInFeatures() Returns the Input Features parameter of this tool .
java.lang.Object	getOutFeatures() Returns the Output Features parameter of this tool (Read only).
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	setInFeatures(java.lang.Object inFeatures) Sets the Input Features 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

Integrate

public Integrate()

Creates the Integrate tool with defaults.

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

Integrate

public Integrate(java.lang.Object inFeatures)

Creates the Integrate 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 feature classes to be integrated. When the distance between features is small in comparison to the tolerance the vertices or points will be clustered (moved to be coincident). The feature class or layer with the lower rank will snap to the feature from the feature class or layer with the higher rank (with 1 being a higher rank than 2). Note that features in the feature class with a rank of 1 may move when a large x,y tolerance is used.

Method Detail

getInFeatures

public java.lang.Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the feature classes to be integrated. When the distance between features is small in comparison to the tolerance the vertices or points will be clustered (moved to be coincident). The feature class or layer with the lower rank will snap to the feature from the feature class or layer with the higher rank (with 1 being a higher rank than 2). Note that features in the feature class with a rank of 1 may move when a large x,y tolerance is used. 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 the feature classes to be integrated. When the distance between features is small in comparison to the tolerance the vertices or points will be clustered (moved to be coincident). The feature class or layer with the lower rank will snap to the feature from the feature class or layer with the higher rank (with 1 being a higher rank than 2). Note that features in the feature class with a rank of 1 may move when a large x,y tolerance is used. This is a required parameter.

Parameters:

inFeatures - the feature classes to be integrated. When the distance between features is small in comparison to the tolerance the vertices or points will be clustered (moved to be coincident). The feature class or layer with the lower rank will snap to the feature from the feature class or layer with the higher rank (with 1 being a higher rank than 2). Note that features in the feature class with a rank of 1 may move when a large x,y tolerance is used.

getClusterTolerance

public java.lang.Object getClusterTolerance()

Returns the XY Tolerance parameter of this tool . This parameter is the distance that determines the range in which feature vertices are made coincident. To minimize undesired movement of vertices, the x,y tolerance should be fairly small. If no value is specified, the xy tolerance from the first dataset in the list of inputs will be used. 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 the distance that determines the range in which feature vertices are made coincident. To minimize undesired movement of vertices, the x,y tolerance should be fairly small. If no value is specified, the xy tolerance from the first dataset in the list of inputs will be used. This is an optional parameter.

Parameters:

clusterTolerance - the distance that determines the range in which feature vertices are made coincident. To minimize undesired movement of vertices, the x,y tolerance should be fairly small. If no value is specified, the xy tolerance from the first dataset in the list of inputs will be used.

getOutFeatures

public java.lang.Object getOutFeatures()

Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Features

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