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

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

All Implemented Interfaces:

GPTool

public class DropIndex
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Drops an attribute index from the specified item and INFO table. The Drop Index tool is contained in the Coverage Tools tool box.

Software restrictions: ArcInfo only

Usage tips:

• Many operations in ArcGIS will not maintain item indexes. Anytime the coverage or feature attribute table is updated, item indexes are deleted.
• If there are no indexes on a coverage, the dialog box will not show any fields on which to drop an index.
• Item indexes are preserved when INFO tables are duplicated with the Copy tool; or Copy Features tool;
• Item indexes are stored in the workspace INFO directory. They are named with an ARC prefix (for example, ARC0001R.003). This file is an index for the third item in the INFO table whose internal name is ARC0001.DAT.
• Indexed items speed up ArcGIS selection and relate operations. The IndexItem command is used to create an item index.
• The Indexed Item parameter's 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 Indexed Item parameter may not be populated with field names. The Add Field button allows you to add expected fields so you can complete the Drop Index dialog 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

DropIndex()
Creates the Drop Index tool with defaults.

DropIndex(Object inInfoTable)
Creates the Drop Index tool with the required parameters.

Method Summary

Object	getIndexItem() Returns the Indexed Item 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 (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	setIndexItem(Object indexItem) Sets the Indexed Item parameter of this tool .
void	setInInfoTable(Object inInfoTable) Sets the Input 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

DropIndex

public DropIndex()

Creates the Drop Index tool with defaults.

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

DropIndex

public DropIndex(Object inInfoTable)

Creates the Drop Index 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 name of the INFO table containing the item whose index is to be deleted.

Method Detail

getInInfoTable

public Object getInInfoTable()

Returns the Input Info Table parameter of this tool . This parameter is Arcinfo Table, the name of the INFO table containing the item whose index is to be deleted. 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 name of the INFO table containing the item whose index is to be deleted. This is a required parameter.

Parameters:

inInfoTable - Arcinfo Table, the name of the INFO table containing the item whose index is to be deleted.

getIndexItem

public Object getIndexItem()

Returns the Indexed Item 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 an optional parameter.

Returns:

the Indexed Item

setIndexItem

public void setIndexItem(Object indexItem)

Sets the Indexed Item 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 an optional parameter.

Parameters:

indexItem - 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.

getOutInfoTable

public Object getOutInfoTable()

Returns the Output Info Table parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output 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