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

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

All Implemented Interfaces:

GPTool

public class AddCADFields

extends AbstractGPTool

Adds CAD-specific fields, appropriately named to be recognized by the Export CAD tool to specify the CAD properties of exported features. This tool allows you to add fields to the input table by selecting which groups of CAD-specific fields you want to add to the input table. The CAD-specific fields have the appropriate name and type recognized by the Export CAD tool. It would then be the responsibility of the user to calculate or otherwise generate appropriate values in these fields to derive the various CAD entity properties before invoking the Export CAD tool. The Add CAD Fields tool is contained in the Conversion Tools tool box.

Software restrictions: ArcInfo only

Usage tips:

• All input feature classes; and/or feature layers; are valid inputs to this tool.
• Adding CAD fields to a feature class intended for export and calculating values into those fields is a quick way to specify the various CAD properties for export.
• A similar tool, Assign CAD Alias; , is used to rename fields for the same export purpose. Assign Field Aliases 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 in values.
• Adding Fields to a table other than a feature class is useful in creating a lookup table that can be used as a way to persist various CAD properties' definitions. By joining this lookup table to a feature class based on some key field existing in both tables, a CAD standard can be defined and reused. Such a table can specify how feature class data is represented in a CAD drawing.
• If the input is a table view or a feature layer with a joined table, the fields are only added to the base table.
• It is useful to add Entity Property fields, Layer Property fields, Text Property fields, and CAD Document property fields to separate tables to keep a normalized set of lookup tables that can be joined to express an organized CAD standard of how CAD files should be generated from feature class data.
• If you would like to learn more about how CAD data can be used as direct input; to Geoprocessing tools, or a sample workflow; involving the Add CAD Fields tool.
• The Assign CAD Alias tool will allow you to rename existing columns for the same purpose as the Add CAD Fields tool. The major difference is that the Assign CAD Alias tool will alias existing fields that may already contain useful CAD property data but may have a field name not recognized by the Export CAD tool.
• The following environments affect this tool: extent; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

AddCADFields()
Creates the Add CAD Fields tool with defaults.

AddCADFields(java.lang.Object inputTable, java.lang.String entities)
Creates the Add CAD Fields tool with the required parameters.

Method Summary

java.lang.String	getDocProps() Returns the Document Properties parameter of this tool .
java.lang.String	getEntities() Returns the Entity Properties parameter of this tool .
java.lang.Object	getInputTable() Returns the Input Table parameter of this tool .
java.lang.String	getLayerProps() Returns the Layer Properties parameter of this tool .
java.lang.Object	getOutTable() Returns the Output Feature Class parameter of this tool (Read only).
java.lang.String	getTextProps() Returns the Text Properties parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
java.lang.String	getXDataProps() Returns the Add CAD XData Property Fields parameter of this tool .
void	setDocProps(java.lang.String docProps) Sets the Document Properties parameter of this tool .
void	setEntities(java.lang.String entities) Sets the Entity Properties parameter of this tool .
void	setInputTable(java.lang.Object inputTable) Sets the Input Table parameter of this tool .
void	setLayerProps(java.lang.String layerProps) Sets the Layer Properties parameter of this tool .
void	setTextProps(java.lang.String textProps) Sets the Text Properties parameter of this tool .
void	setXDataProps(java.lang.String xDataProps) Sets the Add CAD XData Property 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

AddCADFields

public AddCADFields()

Creates the Add CAD Fields tool with defaults.

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

AddCADFields

public AddCADFields(java.lang.Object inputTable,
                    java.lang.String entities)

Creates the Add CAD Fields 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 - Table View, input table, feature class, or shapefile that will have the CAD-specific fields added to it.

entities - String, adds the list of CAD-specific Entity property fields to the input table.

• Add_entity_properties—Adds the list of CAD-specific Entity property fields to the input table.
• No_entity_properties—Does not add the list of CAD-specific Entity property fields to the input table.

Method Detail

getInputTable

public java.lang.Object getInputTable()

Returns the Input Table parameter of this tool . This parameter is Table View, input table, feature class, or shapefile that will have the CAD-specific fields added to it. This is a required parameter.

Returns:

the Input Table

setInputTable

public void setInputTable(java.lang.Object inputTable)

Sets the Input Table parameter of this tool . This parameter is Table View, input table, feature class, or shapefile that will have the CAD-specific fields added to it. This is a required parameter.

Parameters:

inputTable - Table View, input table, feature class, or shapefile that will have the CAD-specific fields added to it.

getEntities

public java.lang.String getEntities()

Returns the Entity Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Entity property fields to the input table. This is a required parameter.

Returns:

the Entity Properties

setEntities

public void setEntities(java.lang.String entities)

Sets the Entity Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Entity property fields to the input table. This is a required parameter.

Parameters:

entities - String, adds the list of CAD-specific Entity property fields to the input table.

• Add_entity_properties—Adds the list of CAD-specific Entity property fields to the input table.
• No_entity_properties—Does not add the list of CAD-specific Entity property fields to the input table.

getLayerProps

public java.lang.String getLayerProps()

Returns the Layer Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Layer property fields to the input table. This is an optional parameter.

Returns:

the Layer Properties

setLayerProps

public void setLayerProps(java.lang.String layerProps)

Sets the Layer Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Layer property fields to the input table. This is an optional parameter.

Parameters:

layerProps - String, adds the list of CAD-specific Layer property fields to the input table.

• Add_layer_properties—Adds the list of CAD-specific Layer property fields to the input table.
• No_layer_properties—Does not add the list of CAD-specific Layer property fields to the input table.

getTextProps

public java.lang.String getTextProps()

Returns the Text Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Text property fields to the input table. This is an optional parameter.

Returns:

the Text Properties

setTextProps

public void setTextProps(java.lang.String textProps)

Sets the Text Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Text property fields to the input table. This is an optional parameter.

Parameters:

textProps - String, adds the list of CAD-specific Text property fields to the input table.

• Add_text_properties—Adds the list of CAD-specific Text property fields to the input table.
• No_text_properties—Does not add the list of CAD-specific Text property fields to the input table.

getDocProps

public java.lang.String getDocProps()

Returns the Document Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Document property fields to the input table. This is an optional parameter.

Returns:

the Document Properties

setDocProps

public void setDocProps(java.lang.String docProps)

Sets the Document Properties parameter of this tool . This parameter is String, adds the list of CAD-specific Document property fields to the input table. This is an optional parameter.

Parameters:

docProps - String, adds the list of CAD-specific Document property fields to the input table.

• Add_document_properties—Adds the list of CAD-specific Document property fields to the input table.
• No_document_properties—Does not add the list of CAD-specific Document property fields to the input table.

getXDataProps

public java.lang.String getXDataProps()

Returns the Add CAD XData Property Fields parameter of this tool . This parameter is String, adds the list of CAD-specific XData property fields to the input table. This is an optional parameter.

Returns:

the Add CAD XData Property Fields

setXDataProps

public void setXDataProps(java.lang.String xDataProps)

Sets the Add CAD XData Property Fields parameter of this tool . This parameter is String, adds the list of CAD-specific XData property fields to the input table. This is an optional parameter.

Parameters:

xDataProps - String, adds the list of CAD-specific XData property fields to the input table.

• Add_XData_properties—Adds the list of CAD-specific XData property fields to the input table.
• No_XData_properties—Does not add the list of CAD-specific XData property fields to the input table.

getOutTable

public java.lang.Object getOutTable()

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

Returns:

the Output Feature Class

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias