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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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. The Remove Attribute Index tool is contained in the Data Management Tools tool box.

Usage tips:


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 - the table containing the index or indexes to be deleted. Table can refer to an actual table, a feature class attribute table, or an attributed relationship class.
indexName - the name of the index or indexes to be deleted.
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is the table containing the index or indexes to be deleted. Table can refer to an actual table, a feature class attribute table, or an 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 the table containing the index or indexes to be deleted. Table can refer to an actual table, a feature class attribute table, or an attributed relationship class. This is a required parameter.

Parameters:
inTable - the table containing the index or indexes to be deleted. Table can refer to an actual table, a feature class attribute table, or an attributed relationship class.

getIndexName

public Object getIndexName()
Returns the Index Name or Indexed Item parameter of this tool . This parameter is the name of the index or indexes to be deleted. 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 the name of the index or indexes to be deleted. This is a required parameter.

Parameters:
indexName - the name of the index or indexes to be deleted.

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