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

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

All Implemented Interfaces:

GPTool

public class DeleteField
extends AbstractGPTool

This tool deletes one or more fields from a table, feature class, feature layer, or raster dataset. The Delete Field tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool can be used with any table; ArcSDE, file, or personal geodatabase feature class; coverage; raster dataset; or shapefile.
• Fields cannot be deleted from nonnative, read-only data formats in ArcGIS, such as VPF and CAD datasets.
• The Drop Field parameter Add Field button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run or its derived data does not exist, the Drop Field parameter may not be populated with field names. The Add Field button allows you to add expected fields so you can complete the Delete Field dialog box and continue to build your model.

Field Summary

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

vals

Constructor Summary

DeleteField()
Creates the Delete Field tool with defaults.

DeleteField(Object inTable, Object dropField)
Creates the Delete Field tool with the required parameters.

Method Summary

Object	getDropField() Returns the Drop Field parameter of this tool .
Object	getInTable() 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	setDropField(Object dropField) Sets the Drop Field parameter of this tool .
void	setInTable(Object inTable) 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

DeleteField

public DeleteField()

Creates the Delete Field tool with defaults.

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

DeleteField

public DeleteField(Object inTable,
                   Object dropField)

Creates the Delete Field 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 - the table containing the fields to be deleted. The existing input table will be modified.

dropField - the fields to be dropped from the input table. Only nonrequired fields may be deleted.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the table containing the fields to be deleted. The existing input table will be modified. 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 the table containing the fields to be deleted. The existing input table will be modified. This is a required parameter.

Parameters:

inTable - the table containing the fields to be deleted. The existing input table will be modified.

getDropField

public Object getDropField()

Returns the Drop Field parameter of this tool . This parameter is the fields to be dropped from the input table. Only nonrequired fields may be deleted. This is a required parameter.

Returns:

the Drop Field

setDropField

public void setDropField(Object dropField)

Sets the Drop Field parameter of this tool . This parameter is the fields to be dropped from the input table. Only nonrequired fields may be deleted. This is a required parameter.

Parameters:

dropField - the fields to be dropped from the input table. Only nonrequired fields may be deleted.

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