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

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

All Implemented Interfaces:

GPTool

public class Update
extends AbstractGPTool

Computes a geometric intersection of the Input Features and Update Features. The attributes and geometry of the input features are updated by the update features in the output feature class. The Update tool is contained in the Analysis Tools tool box.

Usage tips:

• The Input Features must be of type polygon.
• The input feature class will not be modified by this tool. The results of the tool will be written to a new feature class.
• The Update Features must be polygon.
• The input feature class and update feature class field names must match.
• If the update feature class is missing one (or many) of the fields that are present in the input feature class, the input feature class field value for the missing field(s) will be removed from the output feature class.
• If the Borders parameter is unchecked in the dialog box (or set to NO_BORDERS in scripting or at the command line), the polygon boundaries along the outer edge of the update features will be dropped. Even though the outer boundaries of some update polygons are dropped, the attributes of the update features that overlap input features will be assigned to the polygons in the output feature class.
• 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

Update()
Creates the Update tool with defaults.

Update(Object inFeatures, Object updateFeatures, Object outFeatureClass)
Creates the Update 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	getKeepBorders() Returns the Borders 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	setKeepBorders(String keepBorders) Sets the Borders 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

Update

public Update()

Creates the Update tool with defaults.

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

Update

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

Creates the Update 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. Geometry type must be polygon.

updateFeatures - the features that will be used to update the Input Features. Geometry type must be polygon.

outFeatureClass - the feature class to contain the results. Do not set this to be the same as the Input Features.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input feature class or layer. Geometry type must be polygon. 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. Geometry type must be polygon. This is a required parameter.

Parameters:

inFeatures - the input feature class or layer. Geometry type must be polygon.

getUpdateFeatures

public Object getUpdateFeatures()

Returns the Update Features parameter of this tool . This parameter is the features that will be used to update the Input Features. Geometry type must be polygon. 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 features that will be used to update the Input Features. Geometry type must be polygon. This is a required parameter.

Parameters:

updateFeatures - the features that will be used to update the Input Features. Geometry type must be polygon.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class to contain the results. Do not set this to be the same as the Input Features. 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 contain the results. Do not set this to be the same as the Input Features. This is a required parameter.

Parameters:

outFeatureClass - the feature class to contain the results. Do not set this to be the same as the Input Features.

getKeepBorders

public String getKeepBorders()

Returns the Borders parameter of this tool . This parameter is specifies whether the boundary of the update polygon features will be kept. This is an optional parameter.

Returns:

the Borders

setKeepBorders

public void setKeepBorders(String keepBorders)

Sets the Borders parameter of this tool . This parameter is specifies whether the boundary of the update polygon features will be kept. This is an optional parameter.

Parameters:

keepBorders - specifies whether the boundary of the update polygon features will be kept.

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