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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.coveragetools.IndexItem
All Implemented Interfaces:
GPTool

public class IndexItem
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Creates an attribute index to increase access speed to the specified item during query operations. The Index Item tool is contained in the Coverage Tools tool box.

Software restrictions: ArcInfo only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
IndexItem()
          Creates the Index Item tool with defaults.
IndexItem(Object inInfoTable, Object indexItem)
          Creates the Index Item tool with the required parameters.
 
Method Summary
 Object getIndexItem()
          Returns the Index 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 Index 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

IndexItem

public IndexItem()
Creates the Index Item tool with defaults.

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


IndexItem

public IndexItem(Object inInfoTable,
                 Object indexItem)
Creates the Index 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 - ArcInfo Table, the name of the INFO table containing the item to be indexed.
indexItem - ArcInfo Item, the name of the item to be indexed.
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 to be indexed. 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 to be indexed. This is a required parameter.

Parameters:
inInfoTable - ArcInfo Table, the name of the INFO table containing the item to be indexed.

getIndexItem

public Object getIndexItem()
Returns the Index Item parameter of this tool . This parameter is ArcInfo Item, the name of the item to be indexed. This is a required parameter.

Returns:
the Index Item

setIndexItem

public void setIndexItem(Object indexItem)
Sets the Index Item parameter of this tool . This parameter is ArcInfo Item, the name of the item to be indexed. This is a required parameter.

Parameters:
indexItem - ArcInfo Item, the name of the item to be indexed.

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