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

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

public class AddSpatialIndex
extends AbstractGPTool

Adds a spatial index to a shapefile, file geodatabase, or ArcSDE feature class. Use this tool to either add a spatial index to a shapefile or feature class that does not already have one or to rebuild an existing spatial index. The Add Spatial 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
AddSpatialIndex()
          Creates the Add Spatial Index tool with defaults.
AddSpatialIndex(Object inFeatures)
          Creates the Add Spatial Index tool with the required parameters.
 
Method Summary
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool (Read only).
 double getSpatialGrid1()
          Returns the Spatial Grid 1 parameter of this tool .
 double getSpatialGrid2()
          Returns the Spatial Grid 2 parameter of this tool .
 double getSpatialGrid3()
          Returns the Spatial Grid 3 parameter of this tool .
 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 setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setSpatialGrid1(double spatialGrid1)
          Sets the Spatial Grid 1 parameter of this tool .
 void setSpatialGrid2(double spatialGrid2)
          Sets the Spatial Grid 2 parameter of this tool .
 void setSpatialGrid3(double spatialGrid3)
          Sets the Spatial Grid 3 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

AddSpatialIndex

public AddSpatialIndex()
Creates the Add Spatial Index tool with defaults.

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


AddSpatialIndex

public AddSpatialIndex(Object inFeatures)
Creates the Add Spatial 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:
inFeatures - arcSDE feature class, file geodatabase feature class, or shapefile to which a spatial index is to be added or rebuilt.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is arcSDE feature class, file geodatabase feature class, or shapefile to which a spatial index is to be added or rebuilt. This is a required parameter.

Returns:
the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Features parameter of this tool . This parameter is arcSDE feature class, file geodatabase feature class, or shapefile to which a spatial index is to be added or rebuilt. This is a required parameter.

Parameters:
inFeatures - arcSDE feature class, file geodatabase feature class, or shapefile to which a spatial index is to be added or rebuilt.

getSpatialGrid1

public double getSpatialGrid1()
Returns the Spatial Grid 1 parameter of this tool . This parameter is the Spatial Grid 1, 2, and 3 parameters apply only to file geodatabase and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0, and ArcGIS will compute optimal sizes for you. This is an optional parameter.

Returns:
the Spatial Grid 1

setSpatialGrid1

public void setSpatialGrid1(double spatialGrid1)
Sets the Spatial Grid 1 parameter of this tool . This parameter is the Spatial Grid 1, 2, and 3 parameters apply only to file geodatabase and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0, and ArcGIS will compute optimal sizes for you. This is an optional parameter.

Parameters:
spatialGrid1 - the Spatial Grid 1, 2, and 3 parameters apply only to file geodatabase and certain ArcSDE geodatabase feature classes. If you are unfamiliar with setting grid sizes, leave these options as 0,0,0, and ArcGIS will compute optimal sizes for you.

getSpatialGrid2

public double getSpatialGrid2()
Returns the Spatial Grid 2 parameter of this tool . This parameter is cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. This is an optional parameter.

Returns:
the Spatial Grid 2

setSpatialGrid2

public void setSpatialGrid2(double spatialGrid2)
Sets the Spatial Grid 2 parameter of this tool . This parameter is cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1. This is an optional parameter.

Parameters:
spatialGrid2 - cell size of the second spatial grid. Leave the size at 0 if you only want one grid. Otherwise, set the size to at least three times larger than Spatial Grid 1.

getSpatialGrid3

public double getSpatialGrid3()
Returns the Spatial Grid 3 parameter of this tool . This parameter is cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2. This is an optional parameter.

Returns:
the Spatial Grid 3

setSpatialGrid3

public void setSpatialGrid3(double spatialGrid3)
Sets the Spatial Grid 3 parameter of this tool . This parameter is cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2. This is an optional parameter.

Parameters:
spatialGrid3 - cell size of the third spatial grid. Leave the size at 0 if you only want two grids. Otherwise, set the size to at least three times larger than Spatial Grid 2.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Feature Class

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