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

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

All Implemented Interfaces:

GPTool

public class AddItem
extends AbstractGPTool

Adds a new blank or zero item to a new or existing INFO table. The Add Item tool is contained in the Coverage Tools tool box.

Usage tips:

• This tool creates a new INFO table that is a copy of the Input Info Table with a new item containing blanks or zeroes. Data in other items are copied from the Input Info Table to the Output Info Table. When the Input Info Table and the Output Info Table have the same name, the item is added to the Input Info Table;otherwise, the Output Info Table is created as a new internal INFO table, and the Input Info Table is not altered.
• Do not insert items before the cover-ID in a feature attribute table.
• Do not insert items before the COUNT item in a grid VAT.
• If Item Type defines a character, blanks are inserted for each record. If Item Type defines a numeric item, then zeroes are inserted for each record.
• Adding items to coverage tic files is not recommended. Negative results may occur depending on the operations performed on the coverage. , , and other tools will maintain only the original tic items.
• A similar tool, , adds items by merging two INFO tables. Add Item is different from Join Info Tables in that it adds only one item at a time, and the new item values are always zero or blank. Join Info Tables may be preferable when many items are to be added from an existing INFO table.

Field Summary

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

vals

Constructor Summary

AddItem()
Creates the Add Item tool with defaults.

AddItem(Object inInfoTable, Object outInfoTable, String itemName, int itemWidth, int outputWidth, String itemType)
Creates the Add Item tool with the required parameters.

Method Summary

int	getDecimalPlaces() Returns the Decimal Places parameter of this tool .
Object	getInInfoTable() Returns the Input Info Table parameter of this tool .
String	getItemName() Returns the Item Name parameter of this tool .
String	getItemType() Returns the Item Type parameter of this tool .
int	getItemWidth() Returns the Item Width parameter of this tool .
Object	getOutInfoTable() Returns the Output Info Table parameter of this tool .
int	getOutputWidth() Returns the Output Width parameter of this tool .
Object	getStartItem() Returns the Start Item 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	setDecimalPlaces(int decimalPlaces) Sets the Decimal Places parameter of this tool .
void	setInInfoTable(Object inInfoTable) Sets the Input Info Table parameter of this tool .
void	setItemName(String itemName) Sets the Item Name parameter of this tool .
void	setItemType(String itemType) Sets the Item Type parameter of this tool .
void	setItemWidth(int itemWidth) Sets the Item Width parameter of this tool .
void	setOutInfoTable(Object outInfoTable) Sets the Output Info Table parameter of this tool .
void	setOutputWidth(int outputWidth) Sets the Output Width parameter of this tool .
void	setStartItem(Object startItem) Sets the Start Item 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

AddItem

public AddItem()

Creates the Add Item tool with defaults.

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

AddItem

public AddItem(Object inInfoTable,
               Object outInfoTable,
               String itemName,
               int itemWidth,
               int outputWidth,
               String itemType)

Creates the Add 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 - the INFO table to which the item is to be added.

outInfoTable - the INFO table to be created.

itemName - the new item to be added to the INFO table.

itemWidth - the INFO width of the added item. Supported widths:

outputWidth - the output width of the added item. This is the number of characters used to display an item value. for example, in a 2-byte integer (item type BINARY), values can be as high as 32767, which requires five characters for display. Dates can be displayed using eight (mm/dd/yy) or ten (mm/dd/yyyy) characters. For international date displays, months and days can be switched (for example, dd/mm/yy).

itemType - the INFO item type of the added item.

Method Detail

getInInfoTable

public Object getInInfoTable()

Returns the Input Info Table parameter of this tool . This parameter is the INFO table to which the item is to be added. 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 the INFO table to which the item is to be added. This is a required parameter.

Parameters:

inInfoTable - the INFO table to which the item is to be added.

getOutInfoTable

public Object getOutInfoTable()

Returns the Output Info Table parameter of this tool . This parameter is 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 the INFO table to be created. This is a required parameter.

Parameters:

outInfoTable - the INFO table to be created.

getItemName

public String getItemName()

Returns the Item Name parameter of this tool . This parameter is the new item to be added to the INFO table. This is a required parameter.

Returns:

the Item Name

setItemName

public void setItemName(String itemName)

Sets the Item Name parameter of this tool . This parameter is the new item to be added to the INFO table. This is a required parameter.

Parameters:

itemName - the new item to be added to the INFO table.

getItemWidth

public int getItemWidth()

Returns the Item Width parameter of this tool . This parameter is the INFO width of the added item. Supported widths: This is a required parameter.

Returns:

the Item Width

setItemWidth

public void setItemWidth(int itemWidth)

Sets the Item Width parameter of this tool . This parameter is the INFO width of the added item. Supported widths: This is a required parameter.

Parameters:

itemWidth - the INFO width of the added item. Supported widths:

getOutputWidth

public int getOutputWidth()

Returns the Output Width parameter of this tool . This parameter is the output width of the added item. This is the number of characters used to display an item value. for example, in a 2-byte integer (item type BINARY), values can be as high as 32767, which requires five characters for display. Dates can be displayed using eight (mm/dd/yy) or ten (mm/dd/yyyy) characters. For international date displays, months and days can be switched (for example, dd/mm/yy). This is a required parameter.

Returns:

the Output Width

setOutputWidth

public void setOutputWidth(int outputWidth)

Sets the Output Width parameter of this tool . This parameter is the output width of the added item. This is the number of characters used to display an item value. for example, in a 2-byte integer (item type BINARY), values can be as high as 32767, which requires five characters for display. Dates can be displayed using eight (mm/dd/yy) or ten (mm/dd/yyyy) characters. For international date displays, months and days can be switched (for example, dd/mm/yy). This is a required parameter.

Parameters:

outputWidth - the output width of the added item. This is the number of characters used to display an item value. for example, in a 2-byte integer (item type BINARY), values can be as high as 32767, which requires five characters for display. Dates can be displayed using eight (mm/dd/yy) or ten (mm/dd/yyyy) characters. For international date displays, months and days can be switched (for example, dd/mm/yy).

getItemType

public String getItemType()

Returns the Item Type parameter of this tool . This parameter is the INFO item type of the added item. This is a required parameter.

Returns:

the Item Type

setItemType

public void setItemType(String itemType)

Sets the Item Type parameter of this tool . This parameter is the INFO item type of the added item. This is a required parameter.

Parameters:

itemType - the INFO item type of the added item.

getDecimalPlaces

public int getDecimalPlaces()

Returns the Decimal Places parameter of this tool . This parameter is the number of decimal places for the added item. This needs to be specified for INFO item types NUMERIC and FLOATING. This is an optional parameter.

Returns:

the Decimal Places

setDecimalPlaces

public void setDecimalPlaces(int decimalPlaces)

Sets the Decimal Places parameter of this tool . This parameter is the number of decimal places for the added item. This needs to be specified for INFO item types NUMERIC and FLOATING. This is an optional parameter.

Parameters:

decimalPlaces - the number of decimal places for the added item. This needs to be specified for INFO item types NUMERIC and FLOATING.

getStartItem

public Object getStartItem()

Returns the Start Item parameter of this tool . This parameter is the item in the in_info_table after which the new item is to be added. The default start_item is the last item in the in_info_table. This is an optional parameter.

Returns:

the Start Item

setStartItem

public void setStartItem(Object startItem)

Sets the Start Item parameter of this tool . This parameter is the item in the in_info_table after which the new item is to be added. The default start_item is the last item in the in_info_table. This is an optional parameter.

Parameters:

startItem - the item in the in_info_table after which the new item is to be added. The default start_item is the last item in the in_info_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