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

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

All Implemented Interfaces:

GPTool

public class SymDiff
extends AbstractGPTool

Features or portions of features in the input and update features that do not overlap will be written to the output feature class. The Symmetrical Difference tool is contained in the Analysis Tools tool box.

Usage tips:

• The input and update feature class or feature layer must be of the same geometry type.
• 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

SymDiff()
Creates the Symmetrical Difference tool with defaults.

SymDiff(Object inFeatures, Object updateFeatures, Object outFeatureClass)
Creates the Symmetrical Difference tool with the required parameters.

Method Summary

Object	getClusterTolerance() Returns the XY Tolerance 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.
Object	getUpdateFeatures() Returns the Update Features parameter of this tool .
void	setClusterTolerance(Object clusterTolerance) Sets the XY Tolerance 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	setUpdateFeatures(Object updateFeatures) Sets the Update 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

SymDiff

public SymDiff()

Creates the Symmetrical Difference tool with defaults.

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

SymDiff

public SymDiff(Object inFeatures,
               Object updateFeatures,
               Object outFeatureClass)

Creates the Symmetrical Difference 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.

updateFeatures - the update feature class or layer. Geometry type must be the same geometry type as the input feature class or layer.

outFeatureClass - the feature class 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.

getUpdateFeatures

public Object getUpdateFeatures()

Returns the Update Features parameter of this tool . This parameter is the update feature class or layer. Geometry type must be the same geometry type as the input feature class or layer. This is a required parameter.

Returns:

the Update Features

setUpdateFeatures

public void setUpdateFeatures(Object updateFeatures)

Sets the Update Features parameter of this tool . This parameter is the update feature class or layer. Geometry type must be the same geometry type as the input feature class or layer. This is a required parameter.

Parameters:

updateFeatures - the update feature class or layer. Geometry type must be the same geometry type as the input feature class or layer.

getOutFeatureClass

public Object getOutFeatureClass()

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

Parameters:

outFeatureClass - the feature class to which the results will be written.

getJoinAttributes

public String getJoinAttributes()

Returns the JoinAttributes parameter of this tool . This parameter is determines which 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 which attributes will be transferred to the output feature class. This is an optional parameter.

Parameters:

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

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