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

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

All Implemented Interfaces:

GPTool

public class Update
extends AbstractGPTool

Replaces the input coverage areas with the update coverage polygons using a cut and paste operation. The Update tool is contained in the Coverage Tools tool box.

Usage tips:

• Before using UPDATE, the following conditions must be met:
  • Item definitions past the User-ID must be the same for the input and update coverages. This includes redefined items.
  • Annotation subclasses and their attribute definitions must be identical. Blank annotation subclasses are ignored.
  • Section subclasses and their attribute definitions must be identical.
  • Region subclasses with the same name must have the same attribute definitions.
• The input coverage and the update coverage must have polygon topology.
• The item definitions for items past the User-ID in the input coverage and update coverage feature attribute tables must match exactly, including redefined items. The input coverage and update coverage items are joined to the output coverage attribute table using the old polygon internal number as the relate item.
• New label point positions are only generated for the output coverage polygons when necessary. The User-ID for each polygon is equal to its old input coverage User-ID (the update coverage User-ID for updated polygons). Thus, you should attempt to make the User-ID values in the input coverage different from User-ID values in the update coverage to avoid having duplicate User-IDs in the output coverage.
• UPDATE maintains all route system subclasses. If a Section (SEC) subclass is present on either coverage, then it must be present on both, and it must have identical item definitions. Route systems attached to update arcs are retained. Route systems attached to input arcs are retained if they survive. UPDATE manages route systems like an , followed by an , then a .
• If DROP_BORDER is used, polygon boundaries along the outer edge of the update coverage are dropped. Even though the outer boundaries of some update polygons are dropped, the item values for the update polygons that overlap input coverage polygons will be assigned to the polygons in the output coverage. The DROP_BORDER option is not recommended for region coverages because of the possibility that some output regions may not be maintained.
• Annotation features are updated by identifying and deleting the set of input coverage annotation whose lower left starting points fall within an update coverage polygon. Update coverage annotation is then appended for all annotation subclasses present in the output coverage. Both coverages must have identical sets of annotation subclasses with the exception of blank annotation classes, which can be either present or absent. Where subclasses have attributes, they must have identical attribute definitions.
• If the update coverage contains nodes on its border that are coincident with nodes in the input coverage, the update coverage nodes are maintained. The only exception is if the input coverage node contains data in the NAT and the update coverage node does not have an NAT.
• Region subclasses are updated with both the POLY and NET options. All regions are maintained with the KEEP_BORDER option only. The DROP_BORDER option does not maintain all regions and, therefore, is not recommended when updating region coverages.
• The input coverage and update coverage region subclasses may be the same or different. When the subclasses are the same, they must have the same item definitions.
• The coordinate precision of the output coverage is determined by the environment.
• Projection files will be compared for similarity using the level of comparison specified in the environment.
• The output coverage inherits the items from the point attribute table, tics, and the projection file data model contents from the input coverage.
• When the input coverage contains linear data belonging to different planar graphs, the data will be maintained in the output coverage. For example, with coincident or colinear arcs such as arcs representing utility cables at different levels or a road following a stream, the coincident and colinear line segments will be preserved. However, additional vertices may be inserted. In the case of intersecting arcs such as a road passing over a stream, nodes will not be inserted at the apparent intersection.

Field Summary

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

vals

Constructor Summary

Update()
Creates the Update tool with defaults.

Update(Object inCover, Object updateCover, Object outCover)
Creates the Update tool with the required parameters.

Method Summary

String	getFeatureType() Returns the Feature Type parameter of this tool .
double	getFuzzyTolerance() Returns the Fuzzy Tolerance parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
String	getKeepBorder() Returns the Keep outside border of update features in the output parameter of this tool .
Object	getOutCover() Returns the Output Coverage 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	getUpdateCover() Returns the Update Coverage parameter of this tool .
void	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setFuzzyTolerance(double fuzzyTolerance) Sets the Fuzzy Tolerance parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setKeepBorder(String keepBorder) Sets the Keep outside border of update features in the output parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setUpdateCover(Object updateCover) Sets the Update Coverage 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 inCover,
              Object updateCover,
              Object outCover)

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:

inCover - the coverage containing polygons to be updated.

updateCover - the coverage whose polygons will replace input coverage areas.

outCover - the coverage to be created.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage containing polygons to be updated. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage containing polygons to be updated. This is a required parameter.

Parameters:

inCover - the coverage containing polygons to be updated.

getUpdateCover

public Object getUpdateCover()

Returns the Update Coverage parameter of this tool . This parameter is the coverage whose polygons will replace input coverage areas. This is a required parameter.

Returns:

the Update Coverage

setUpdateCover

public void setUpdateCover(Object updateCover)

Sets the Update Coverage parameter of this tool . This parameter is the coverage whose polygons will replace input coverage areas. This is a required parameter.

Parameters:

updateCover - the coverage whose polygons will replace input coverage areas.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is the coverage to be created. This is a required parameter.

Returns:

the Output Coverage

setOutCover

public void setOutCover(Object outCover)

Sets the Output Coverage parameter of this tool . This parameter is the coverage to be created. This is a required parameter.

Parameters:

outCover - the coverage to be created.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the set of feature classes to be updated. This is an optional parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(String featureType)

Sets the Feature Type parameter of this tool . This parameter is the set of feature classes to be updated. This is an optional parameter.

Parameters:

featureType - the set of feature classes to be updated.

getFuzzyTolerance

public double getFuzzyTolerance()

Returns the Fuzzy Tolerance parameter of this tool . This parameter is the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used. This is an optional parameter.

Returns:

the Fuzzy Tolerance

setFuzzyTolerance

public void setFuzzyTolerance(double fuzzyTolerance)

Sets the Fuzzy Tolerance parameter of this tool . This parameter is the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used. This is an optional parameter.

Parameters:

fuzzyTolerance - the minimum distance between coordinates in the output coverage. By default, the minimum fuzzy tolerance value from the input and erase coverages is used.

getKeepBorder

public String getKeepBorder()

Returns the Keep outside border of update features in the output parameter of this tool . This parameter is specifies whether the outside border of the update coverage will be kept after it is inserted into the input coverage. This is an optional parameter.

Returns:

the Keep outside border of update features in the output

setKeepBorder

public void setKeepBorder(String keepBorder)

Sets the Keep outside border of update features in the output parameter of this tool . This parameter is specifies whether the outside border of the update coverage will be kept after it is inserted into the input coverage. This is an optional parameter.

Parameters:

keepBorder - specifies whether the outside border of the update coverage will be kept after it is inserted into the input coverage.

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