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

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

All Implemented Interfaces:

GPTool

public class AddIndex
extends AbstractGPTool

Adds an attribute index to an existing table, feature class, shapefile, coverage, or attributed relationship class. The Add Attribute Index tool is contained in the Data Management Tools tool box.

Usage tips:

• Only feature classes from a file or personal geodatabase or ArcSDE database support more than one attribute index. The Index Name parameter can only be used with these two inputs, along with Unique | Non_unique or Ascending | Non_ascending.
• Shapefiles don't support multiple indexes, so additional fields will become part of a composite index (i.e., an index created on multiple fields in a table).
• Although multicolumn indexes are not yet implemented in file geodatabases, this tool allows you to specify a multicolumn index for a file geodatabase. If you create such an index, it appears to be a multicolumn index when viewed in the Feature Class or Table Properties dialog box, but it's actually a separate index on each field.
• ArcSDE and file or personal geodatabases have a new index added for each unique index name. If an index name already exists, it must be dropped before it can be updated.
• Items must be indexed to support native mode reselects against external DBMS tables.
• The Fields To Index 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 Fields To Index parameter may not be populated with field names. The Add Field button allows you to add expected field(s) so you can complete the Add Attribute Index dialog box and continue to build your model.

Field Summary

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

vals

Constructor Summary

AddIndex()
Creates the Add Attribute Index tool with defaults.

AddIndex(Object inTable, Object fields)
Creates the Add Attribute Index tool with the required parameters.

Method Summary

String	getAscending() Returns the Ascending parameter of this tool .
Object	getFields() Returns the Fields to Index parameter of this tool .
String	getIndexName() Returns the Index Name 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.
String	getUnique() Returns the Unique parameter of this tool .
void	setAscending(String ascending) Sets the Ascending parameter of this tool .
void	setFields(Object fields) Sets the Fields to Index parameter of this tool .
void	setIndexName(String indexName) Sets the Index Name parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setUnique(String unique) Sets the Unique 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

AddIndex

public AddIndex()

Creates the Add Attribute Index tool with defaults.

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

AddIndex

public AddIndex(Object inTable,
                Object fields)

Creates the Add 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 fields to be indexed.

fields - the list of fields that will participate in the index. Any number of fields can be specified.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the table containing the fields to be indexed. 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 fields to be indexed. This is a required parameter.

Parameters:

inTable - the table containing the fields to be indexed.

getFields

public Object getFields()

Returns the Fields to Index parameter of this tool . This parameter is the list of fields that will participate in the index. Any number of fields can be specified. This is a required parameter.

Returns:

the Fields to Index

setFields

public void setFields(Object fields)

Sets the Fields to Index parameter of this tool . This parameter is the list of fields that will participate in the index. Any number of fields can be specified. This is a required parameter.

Parameters:

fields - the list of fields that will participate in the index. Any number of fields can be specified.

getIndexName

public String getIndexName()

Returns the Index Name parameter of this tool . This parameter is the name of the new index. An index name is necessary when adding an index to geodatabase feature classes and tables. For other data types, such as shapefiles and coverage feature classes, index names cannot be specified. This is an optional parameter.

Returns:

the Index Name

setIndexName

public void setIndexName(String indexName)

Sets the Index Name parameter of this tool . This parameter is the name of the new index. An index name is necessary when adding an index to geodatabase feature classes and tables. For other data types, such as shapefiles and coverage feature classes, index names cannot be specified. This is an optional parameter.

Parameters:

indexName - the name of the new index. An index name is necessary when adding an index to geodatabase feature classes and tables. For other data types, such as shapefiles and coverage feature classes, index names cannot be specified.

getUnique

public String getUnique()

Returns the Unique parameter of this tool . This parameter is specifies whether the values in the index are unique. This is an optional parameter.

Returns:

the Unique

setUnique

public void setUnique(String unique)

Sets the Unique parameter of this tool . This parameter is specifies whether the values in the index are unique. This is an optional parameter.

Parameters:

unique - specifies whether the values in the index are unique.

getAscending

public String getAscending()

Returns the Ascending parameter of this tool . This parameter is specifies whether values are indexed in ascending order. This is an optional parameter.

Returns:

the Ascending

setAscending

public void setAscending(String ascending)

Sets the Ascending parameter of this tool . This parameter is specifies whether values are indexed in ascending order. This is an optional parameter.

Parameters:

ascending - specifies whether values are indexed in ascending order.

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