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

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

All Implemented Interfaces:

GPTool

public class RemoveIndex
extends AbstractGPTool

This tool deletes an attribute index from an existing table, feature class, shapefile, coverage, or attributed relationship class. Attribute indexes are used by ArcGIS to quickly locate records that match an attribute query. For information on attribute indexes in geodatabases, see The Remove Attribute Index tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• This tool will take in a coverage feature class, shapefile, file or personal and SDE geodatabase feature classes, and/or an attribute relationship class as a valid input.
• If the index name parameter is empty, there are no indexes in the file.
• Only feature classes from a file or personal geodatabase or SDE database support more than one attribute index. Therefore, you will only see one index to delete in the list unless it is a file or personal geodatabase or SDE database.
• Once an index has been added, it can be deleted and re-added at any point in the lifetime of the feature class or table.
• The Index Name or Indexed Item parameter's Add Value button is used only in ModelBuilder. In ModelBuilder, where the preceding tool has not been run, or its derived data does not exist, the Index Name or Indexed Item parameter may not be populated with values. The Add Value button allows you to add expected value(s) so you can complete the Remove Attribute Index dialog and continue to build your model.
• The following environment affects this tool: workspace;

Field Summary

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

vals

Constructor Summary

RemoveIndex()
Creates the Remove Attribute Index tool with defaults.

RemoveIndex(Object inTable, Object indexName)
Creates the Remove Attribute Index tool with the required parameters.

Method Summary

Object	getIndexName() Returns the Index Name or Indexed Item 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	setIndexName(Object indexName) Sets the Index Name or Indexed Item 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

RemoveIndex

public RemoveIndex()

Creates the Remove Attribute Index tool with defaults.

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

RemoveIndex

public RemoveIndex(Object inTable,
                   Object indexName)

Creates the Remove Attribute 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:

inTable - Table View, the table containing the index or indexes to be deleted. Table means tables, feature class, or attributed relationship class.

indexName - String, the Add Value button, which is used only in ModelBuilder, allows you to add expected value(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, the table containing the index or indexes to be deleted. Table means tables, feature class, or attributed relationship class. 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, the table containing the index or indexes to be deleted. Table means tables, feature class, or attributed relationship class. This is a required parameter.

Parameters:

inTable - Table View, the table containing the index or indexes to be deleted. Table means tables, feature class, or attributed relationship class.

getIndexName

public Object getIndexName()

Returns the Index Name or Indexed Item parameter of this tool . This parameter is String, the Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model. This is a required parameter.

Returns:

the Index Name or Indexed Item

setIndexName

public void setIndexName(Object indexName)

Sets the Index Name or Indexed Item parameter of this tool . This parameter is String, the Add Value button, which is used only in ModelBuilder, allows you to add expected value(s) so you can complete the dialog and continue to build your model. This is a required parameter.

Parameters:

indexName - String, the Add Value button, which is used only in ModelBuilder, allows you to add expected value(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