com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class UpdateAnnotation

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.UpdateAnnotation

All Implemented Interfaces:

GPTool

public class UpdateAnnotation
extends AbstractGPTool

Updates the input annotation feature class with text attribute fields and optionally populates the value of each new field for every feature in the feature class. The Update Annotation Feature Class tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool can be run on a versioned feature class if the option to populate attribute fields is unchecked. The schema of the feature class will be updated in this case, but the new annotation fields will not be populated. Attribute values for a feature will remain blank until the feature is edited.
• This tool will update the schema of the feature class and, optionally, each annotation feature within the feature class. The schema update will add fields to the feature class (bold, italic, text, and so on) and also ensure that there is a symbol within the symbol collection. Without a symbol in the symbol collection, you can't use the improvements for constructing annotation features.
• Populating the attributes fields is an intensive operation that requires every feature to be updated. Turning off this option will add the fields, but not populate them. If the fields are not populated on update, they will remain blank until the feature is edited.

Field Summary

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

vals

Constructor Summary

UpdateAnnotation()
Creates the Update Annotation Feature Class tool with defaults.

UpdateAnnotation(Object inFeatures)
Creates the Update Annotation Feature Class tool with the required parameters.

Method Summary

Object	getInFeatures() Returns the Input features parameter of this tool .
Object	getOutFeatures() Returns the Output Feature Class 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.
String	getUpdateValues() Returns the Populate Attribute Fields parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input features parameter of this tool .
void	setUpdateValues(String updateValues) Sets the Populate Attribute Fields 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

UpdateAnnotation

public UpdateAnnotation()

Creates the Update Annotation Feature Class tool with defaults.

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

UpdateAnnotation

public UpdateAnnotation(Object inFeatures)

Creates the Update Annotation Feature Class 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 - input annotation feature class to which new fields will be added.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input features parameter of this tool . This parameter is input annotation feature class to which new fields will be added. 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 input annotation feature class to which new fields will be added. This is a required parameter.

Parameters:

inFeatures - input annotation feature class to which new fields will be added.

getUpdateValues

public String getUpdateValues()

Returns the Populate Attribute Fields parameter of this tool . This parameter is populates the value of each new field for every feature in the feature class. This is an optional parameter.

Returns:

the Populate Attribute Fields

setUpdateValues

public void setUpdateValues(String updateValues)

Sets the Populate Attribute Fields parameter of this tool . This parameter is populates the value of each new field for every feature in the feature class. This is an optional parameter.

Parameters:

updateValues - populates the value of each new field for every feature in the feature class.

getOutFeatures

public Object getOutFeatures()

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

Returns:

the Output Feature Class

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