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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.DeleteField
All Implemented Interfaces:
GPTool

public class DeleteField
extends AbstractGPTool

Deletes one or more fields from a table of a The Delete Field tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


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 - Table View | Raster Layer, the table containing the field that is to be deleted. The existing Input Table will be modified.
dropField - Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model.
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is Table View | Raster Layer, the table containing the field that is 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 Table View | Raster Layer, the table containing the field that is to be deleted. The existing Input Table will be modified. This is a required parameter.

Parameters:
inTable - Table View | Raster Layer, the table containing the field that is 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 Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model. 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 Field, the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog and continue to build your model. This is a required parameter.

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

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