com.esri.arcgis.geoprocessing.tools.conversiontools
Class SetCADAlias

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.SetCADAlias

All Implemented Interfaces:

GPTool

public class SetCADAlias
extends AbstractGPTool

Renames one or more existing field name aliases by matching columns from the input table with a list of CAD-specific fields with the appropriate name recognized by the Export To CAD tool. The Set CAD Alias tool is contained in the Conversion Tools tool box.

Usage tips:

• The CAD-specific fields in the matching list have the appropriate name and type recognized by the Export To CAD tool. Typically, values already exist in these fields to derive the various CAD entity properties of CAD objects created by the Export To CAD tool.
• If a feature class intended for export already contains values useful for driving CAD properties, such as layer name, but the fields have different names, assigning a CAD field alias on that table using the Assign CAD Alias tool is an efficient way to have the Export To CAD tool recognize those values as CAD properties.
• To permanently set CAD-specific aliases on an input feature class, use the Set CAD Alias tool, since it has a predefined alias list. To create a temporary alias for a feature layer, use the Make Feature Layer tool in ModelBuilder, which gives you the flexibility to change the alias of the field name for the feature layer.
• Using the Add CAD fields tool to build a lookup table is perhaps a better way to create a repeatable system of exporting feature data to CAD files according to some established drawing standard.
• These CAD-specific fields are used to specify the various CAD graphic properties and other forms of CAD attribution. A similar tool, Add CAD Fields, is used to add fields to a table for the same export purpose. Assigning a Field Alias differs from Add CAD Fields in that existing fields that may already contain valid values to describe CAD properties in Export To CAD are renamed with an alias rather than adding a field and calculating values.
• Shapefiles are not a valid input to this function, since they cannot maintain aliases for fields. If you need to use a shapefile as input, convert the shapefile to a layer file. Layer files or feature classes from a personal geodatabase or SDE geodatabase are valid inputs to this tool.
• This tool overwrites the input, so be sure to make a backup of the original data.

Field Summary

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

vals

Constructor Summary

SetCADAlias()
Creates the Set CAD Alias tool with defaults.

SetCADAlias(Object inputTable, Object fieldInfo)
Creates the Set CAD Alias tool with the required parameters.

Method Summary

Object	getFieldInfo() Returns the Field Info parameter of this tool .
Object	getInputTable() Returns the Input Table parameter of this tool .
Object	getOutTable() Returns the Output Table 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	setFieldInfo(Object fieldInfo) Sets the Field Info parameter of this tool .
void	setInputTable(Object inputTable) Sets the Input Table 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

SetCADAlias

public SetCADAlias()

Creates the Set CAD Alias tool with defaults.

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

SetCADAlias

public SetCADAlias(Object inputTable,
                   Object fieldInfo)

Creates the Set CAD Alias 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:

inputTable - the feature class, feature layer, table, or table view to which you would like to assign CAD-specific field name aliases.

fieldInfo - field info relating a list of aliases matched to the list of existing fields in the input table.

Method Detail

getInputTable

public Object getInputTable()

Returns the Input Table parameter of this tool . This parameter is the feature class, feature layer, table, or table view to which you would like to assign CAD-specific field name aliases. This is a required parameter.

Returns:

the Input Table

setInputTable

public void setInputTable(Object inputTable)

Sets the Input Table parameter of this tool . This parameter is the feature class, feature layer, table, or table view to which you would like to assign CAD-specific field name aliases. This is a required parameter.

Parameters:

inputTable - the feature class, feature layer, table, or table view to which you would like to assign CAD-specific field name aliases.

getFieldInfo

public Object getFieldInfo()

Returns the Field Info parameter of this tool . This parameter is field info relating a list of aliases matched to the list of existing fields in the input table. This is a required parameter.

Returns:

the Field Info

setFieldInfo

public void setFieldInfo(Object fieldInfo)

Sets the Field Info parameter of this tool . This parameter is field info relating a list of aliases matched to the list of existing fields in the input table. This is a required parameter.

Parameters:

fieldInfo - field info relating a list of aliases matched to the list of existing fields in the input table.

getOutTable

public Object getOutTable()

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

Returns:

the Output Table

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