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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.Union

All Implemented Interfaces:

GPTool

public class Union
extends AbstractGPTool

Computes a geometric intersection of the Input Features. All features will be written to the Output Feature Class with the attributes from the Input Features, which it overlaps. The Union tool is contained in the Analysis Tools tool box.

Usage tips:

• All input feature classes and feature layers must have polygon geometry.
• The Allow Gaps parameter can be used with the ALL or ONLY_FID settings on the Join Attribute parameter. This allows for identification of resulting areas that are completely enclosed by the resulting polygons. The FID attributes for these GAP features will all be -1.
• 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.
• With Basic and Standard licenses, the number of input feature classes or layers is limited to two.

Field Summary

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

vals

Constructor Summary

Union()
Creates the Union tool with defaults.

Union(Object inFeatures, Object outFeatureClass)
Creates the Union tool with the required parameters.

Method Summary

Object	getClusterTolerance() Returns the XY Tolerance parameter of this tool .
String	getGaps() Returns the Gaps Allowed 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	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	setGaps(String gaps) Sets the Gaps Allowed 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 .

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

Union

public Union()

Creates the Union tool with defaults.

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

Union

public Union(Object inFeatures,
             Object outFeatureClass)

Creates the Union 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 - a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. All of the Input Features must be polygons.

outFeatureClass - the feature class that will contain the results.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. All of the Input Features must be polygons. 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 a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. All of the Input Features must be polygons. This is a required parameter.

Parameters:

inFeatures - a list of the input feature classes or layers. When the distance between features is less than the cluster tolerance, the features with the lower rank will snap to the feature with the higher rank. The highest rank is one. All of the Input Features must be polygons.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class that will contain the results. 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 contain the results. This is a required parameter.

Parameters:

outFeatureClass - the feature class that will contain the results.

getJoinAttributes

public String getJoinAttributes()

Returns the JoinAttributes parameter of this tool . This parameter is determines which attributes from the Input Features 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 which attributes from the Input Features will be transferred to the Output Feature Class. This is an optional parameter.

Parameters:

joinAttributes - determines which attributes from the Input Features 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).

getGaps

public String getGaps()

Returns the Gaps Allowed parameter of this tool . This parameter is gaps are areas in the output feature class that are completely enclosed by other polygons. This is not invalid, but it may be desirable to identify these for analysis. To find the gaps in the output, set this option to NO_GAPS, and a feature will be created in these areas. To select these features, query the output feature class based on all the input feature's FID values being equal to -1. This is an optional parameter.

Returns:

the Gaps Allowed

setGaps

public void setGaps(String gaps)

Sets the Gaps Allowed parameter of this tool . This parameter is gaps are areas in the output feature class that are completely enclosed by other polygons. This is not invalid, but it may be desirable to identify these for analysis. To find the gaps in the output, set this option to NO_GAPS, and a feature will be created in these areas. To select these features, query the output feature class based on all the input feature's FID values being equal to -1. This is an optional parameter.

Parameters:

gaps - gaps are areas in the output feature class that are completely enclosed by other polygons. This is not invalid, but it may be desirable to identify these for analysis. To find the gaps in the output, set this option to NO_GAPS, and a feature will be created in these areas. To select these features, query the output feature class based on all the input feature's FID values being equal to -1.

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