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

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

All Implemented Interfaces:

GPTool

public class IDEdit
extends AbstractGPTool

Updates User-IDs in a coverage after they have been modified in a feature attribute table. The feature attribute table is used to determine the correct User-ID for each feature in the coverage. This value is recorded in all places where the feature User-ID is stored. The Update IDs tool is contained in the Coverage Tools tool box.

Usage tips:

• Tools such as and can be used to add or modify User-IDs in a coverage's feature attribute table before Update IDs is used.
• If the tool has been used to create new label points for coverage polygons, the polygon User-IDs stored in the coverage PAT are not equal to the new label point User-IDs. Create Labels stores the new label points and their User-IDs in the LAB file. Update IDs may be used to change the label point User-IDs to be equal to the User-IDs stored in the PAT.
• To change the User-IDs stored in the PAT to be equal to the label point User-IDs, use the tool.
• There is no NODE option because the Update IDs tool is not necessary after updating User-IDs in the NAT file.

Field Summary

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

vals

Constructor Summary

IDEdit()
Creates the Update IDs tool with defaults.

IDEdit(Object inCover, String featureType)
Creates the Update IDs tool with the required parameters.

Method Summary

String	getFeatureType() Returns the Feature Type parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool (Read only).
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	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setInCover(Object inCover) Sets the Input 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

IDEdit

public IDEdit()

Creates the Update IDs tool with defaults.

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

IDEdit

public IDEdit(Object inCover,
              String featureType)

Creates the Update IDs 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 for which User-IDs have been modified.

featureType - specifies the class of features for which User-IDs are to be updated.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage for which User-IDs have been modified. 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 for which User-IDs have been modified. This is a required parameter.

Parameters:

inCover - the coverage for which User-IDs have been modified.

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is specifies the class of features for which User-IDs are to be updated. This is a required parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(String featureType)

Sets the Feature Type parameter of this tool . This parameter is specifies the class of features for which User-IDs are to be updated. This is a required parameter.

Parameters:

featureType - specifies the class of features for which User-IDs are to be updated.

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output 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