com.esri.arcgis.geoprocessing.tools.coveragetools
Class DropItem

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.DropItem

All Implemented Interfaces:

GPTool

public class DropItem
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Deletes one or more items from an INFO table. The Drop Item tool is contained in the Coverage Tools tool box.

Software restrictions: none

Usage tips:

• The Output Info Table can be the same name as the Input Info Table. However, if the Output Info Table already exists, it will be replaced.
• Do not drop items before the User-ID in feature attribute tables. Redefined items will be dropped if their item definition relates to an item that was dropped.
• Up to 100 items can be dropped with Drop Item.
• The Items to Drop parameter's Add Item button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or its derived data does not exist, the Items to Drop parameter may not be populated with item names. The Add Item button allows you to add expected fields so you can complete the Drop Index dialog box and continue to build your model.
• The following environments affect this tool: derivedPrecision; newPrecision; projectCompare; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

DropItem()
Creates the Drop Item tool with defaults.

DropItem(Object inInfoTable, Object outInfoTable, Object dropItem)
Creates the Drop Item tool with the required parameters.

Method Summary

Object	getDropItem() Returns the Items to Drop parameter of this tool .
Object	getInInfoTable() Returns the Input Info Table parameter of this tool .
Object	getOutInfoTable() Returns the Output Info Table 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	setDropItem(Object dropItem) Sets the Items to Drop parameter of this tool .
void	setInInfoTable(Object inInfoTable) Sets the Input Info Table parameter of this tool .
void	setOutInfoTable(Object outInfoTable) Sets the Output Info 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

DropItem

public DropItem()

Creates the Drop Item tool with defaults.

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

DropItem

public DropItem(Object inInfoTable,
                Object outInfoTable,
                Object dropItem)

Creates the Drop Item 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:

inInfoTable - ArcInfo Table, the INFO table containing the items to be dropped.

outInfoTable - ArcInfo Table, the INFO table to be created.

dropItem - ArcInfo Item; ArcInfo Item..., the Add Item button, which is used only in ModelBuilder, allows you to add expected items so you can complete the dialog and continue to build your model.

Method Detail

getInInfoTable

public Object getInInfoTable()

Returns the Input Info Table parameter of this tool . This parameter is ArcInfo Table, the INFO table containing the items to be dropped. This is a required parameter.

Returns:

the Input Info Table

setInInfoTable

public void setInInfoTable(Object inInfoTable)

Sets the Input Info Table parameter of this tool . This parameter is ArcInfo Table, the INFO table containing the items to be dropped. This is a required parameter.

Parameters:

inInfoTable - ArcInfo Table, the INFO table containing the items to be dropped.

getOutInfoTable

public Object getOutInfoTable()

Returns the Output Info Table parameter of this tool . This parameter is ArcInfo Table, the INFO table to be created. This is a required parameter.

Returns:

the Output Info Table

setOutInfoTable

public void setOutInfoTable(Object outInfoTable)

Sets the Output Info Table parameter of this tool . This parameter is ArcInfo Table, the INFO table to be created. This is a required parameter.

Parameters:

outInfoTable - ArcInfo Table, the INFO table to be created.

getDropItem

public Object getDropItem()

Returns the Items to Drop parameter of this tool . This parameter is ArcInfo Item; ArcInfo Item..., the Add Item button, which is used only in ModelBuilder, allows you to add expected items so you can complete the dialog and continue to build your model. This is a required parameter.

Returns:

the Items to Drop

setDropItem

public void setDropItem(Object dropItem)

Sets the Items to Drop parameter of this tool . This parameter is ArcInfo Item; ArcInfo Item..., the Add Item button, which is used only in ModelBuilder, allows you to add expected items so you can complete the dialog and continue to build your model. This is a required parameter.

Parameters:

dropItem - ArcInfo Item; ArcInfo Item..., the Add Item button, which is used only in ModelBuilder, allows you to add expected items so you can complete the dialog and continue to build your model.

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