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

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

All Implemented Interfaces:

GPTool

public class CreateCADXData
extends AbstractGPTool

Creates a field called 'XDList' in the attribute table. The Create CAD XData 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.
• XData is only read by AutoCAD
• The XDList field that is created by this function is read by the Export to CAD tool; when exported to AutoCAD .
• Extended Entity Data though, allows you to attach up to 16K of information to each and every entity in the drawing.
• You can also keep the XData separate from other information because it uses a uniquely registered name
• 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 Create CAD XData tool.
• If your function fails with "Output exceeds field length", then include less fields in your XData string. The XData field that is added has a maximum field length of 2049 characters.
• The following environments affect this tool: extent; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

CreateCADXData()
Creates the Create CAD XData tool with defaults.

CreateCADXData(Object inTable, Object fields, String regApp, String outputType)
Creates the Create CAD XData tool with the required parameters.

Method Summary

Object	getFields() Returns the Fields to Index parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
String	getOutputType() Returns the Output Type parameter of this tool .
Object	getOutTable() Returns the Output Feature Class parameter of this tool (Read only).
String	getRegApp() Returns the Registered Application Name 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.
void	setFields(Object fields) Sets the Fields to Index parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutputType(String outputType) Sets the Output Type parameter of this tool .
void	setRegApp(String regApp) Sets the Registered Application Name 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

CreateCADXData

public CreateCADXData()

Creates the Create CAD XData tool with defaults.

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

CreateCADXData

public CreateCADXData(Object inTable,
                      Object fields,
                      String regApp,
                      String outputType)

Creates the Create CAD XData 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:

inTable - Table View, this table contains the fields used to generate an XML string of values recognized by the Export to CAD tool. This enables XData to be created on output objects, based on values of fields from the Input Table.

fields - Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so that you can complete the dialog and continue to build your model.

regApp - String, the AutoCAD extended entity data registered application name. Required by only AutoCAD to identify the XData. This application name is an identifier of the newly created XData.

outputType - String, format of the AutoCAD XData.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is Table View, this table contains the fields used to generate an XML string of values recognized by the Export to CAD tool. This enables XData to be created on output objects, based on values of fields from the Input Table. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is Table View, this table contains the fields used to generate an XML string of values recognized by the Export to CAD tool. This enables XData to be created on output objects, based on values of fields from the Input Table. This is a required parameter.

Parameters:

inTable - Table View, this table contains the fields used to generate an XML string of values recognized by the Export to CAD tool. This enables XData to be created on output objects, based on values of fields from the Input Table.

getFields

public Object getFields()

Returns the Fields to Index parameter of this tool . This parameter is Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so that you can complete the dialog and continue to build your model. This is a required parameter.

Returns:

the Fields to Index

setFields

public void setFields(Object fields)

Sets the Fields to Index parameter of this tool . This parameter is Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so that you can complete the dialog and continue to build your model. This is a required parameter.

Parameters:

fields - Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so that you can complete the dialog and continue to build your model.

getRegApp

public String getRegApp()

Returns the Registered Application Name parameter of this tool . This parameter is String, the AutoCAD extended entity data registered application name. Required by only AutoCAD to identify the XData. This application name is an identifier of the newly created XData. This is a required parameter.

Returns:

the Registered Application Name

setRegApp

public void setRegApp(String regApp)

Sets the Registered Application Name parameter of this tool . This parameter is String, the AutoCAD extended entity data registered application name. Required by only AutoCAD to identify the XData. This application name is an identifier of the newly created XData. This is a required parameter.

Parameters:

regApp - String, the AutoCAD extended entity data registered application name. Required by only AutoCAD to identify the XData. This application name is an identifier of the newly created XData.

getOutputType

public String getOutputType()

Returns the Output Type parameter of this tool . This parameter is String, format of the AutoCAD XData. This is a required parameter.

Returns:

the Output Type

setOutputType

public void setOutputType(String outputType)

Sets the Output Type parameter of this tool . This parameter is String, format of the AutoCAD XData. This is a required parameter.

Parameters:

outputType - String, format of the AutoCAD XData.

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