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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AddCADFields()
          Creates the Add CAD Fields tool with defaults.
AddCADFields(Object inputTable, String entities)
          Creates the Add CAD Fields tool with the required parameters.
 
Method Summary
 String getDocProps()
          Returns the Document Properties parameter of this tool .
 String getEntities()
          Returns the Entity Properties parameter of this tool .
 Object getInputTable()
          Returns the Input Table parameter of this tool .
 String getLayerProps()
          Returns the Layer Properties parameter of this tool .
 Object getOutTable()
          Returns the Output Feature Class parameter of this tool (Read only).
 String getTextProps()
          Returns the Text Properties 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.
 String getXDataProps()
          Returns the Add CAD XData Property Fields parameter of this tool .
 void setDocProps(String docProps)
          Sets the Document Properties parameter of this tool .
 void setEntities(String entities)
          Sets the Entity Properties parameter of this tool .
 void setInputTable(Object inputTable)
          Sets the Input Table parameter of this tool .
 void setLayerProps(String layerProps)
          Sets the Layer Properties parameter of this tool .
 void setTextProps(String textProps)
          Sets the Text Properties parameter of this tool .
 void setXDataProps(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(Object inputTable,
                    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.
Method Detail

getInputTable

public 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(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 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(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.

getLayerProps

public 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(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.

getTextProps

public 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(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.

getDocProps

public 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(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.

getXDataProps

public 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(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.

getOutTable

public 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 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