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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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. The results are written to the Output Feature Class. The Update tool is contained in the Analysis Tools tool box.
Learn more about how Update works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


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 - Feature Layer, the input feature class or layer. Geometry type must be polygon.
updateFeatures - Feature Layer, the features that will be used to update the Input features. Geometry type must be polygon.
outFeatureClass - Feature Class, 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 Feature Layer, 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 Feature Layer, the input feature class or layer. Geometry type must be polygon. This is a required parameter.

Parameters:
inFeatures - Feature Layer, 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 Feature Layer, 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 Feature Layer, the features that will be used to update the Input features. Geometry type must be polygon. This is a required parameter.

Parameters:
updateFeatures - Feature Layer, 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 Feature Class, 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 Feature Class, 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 - Feature Class, 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 String, 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 String, specifies whether the boundary of the update polygon features will be kept. This is an optional parameter.

Parameters:
keepBorders - String, 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 Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. 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 Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy. This is an optional parameter.

Parameters:
clusterTolerance - Linear unit, 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). You can set the value to be higher for data that has less coordinate accuracy and lower for datasets with extremely high accuracy.

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