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

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

public class Analyze
extends AbstractGPTool

Updates relational database management system (RDBMS) statistics of business tables, feature tables, and delta tables along with the statistics of those tables' indexes The Analyze tool is contained in the Data Management Tools tool box.

Software restrictions: ArcInfo and ArcEditor only

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Analyze()
          Creates the Analyze tool with defaults.
Analyze(Object inDataset, Object components)
          Creates the Analyze tool with the required parameters.
 
Method Summary
 Object getComponents()
          Returns the Components to Analyze parameter of this tool .
 Object getInDataset()
          Returns the Input Dataset parameter of this tool .
 Object getOutDataset()
          Returns the Output Dataset 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 setComponents(Object components)
          Sets the Components to Analyze parameter of this tool .
 void setInDataset(Object inDataset)
          Sets the Input Dataset 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

Analyze

public Analyze()
Creates the Analyze tool with defaults.

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


Analyze

public Analyze(Object inDataset,
               Object components)
Creates the Analyze 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:
inDataset - Layer | Table View | Dataset, the table or feature class to be analyzed.
components - 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

getInDataset

public Object getInDataset()
Returns the Input Dataset parameter of this tool . This parameter is Layer | Table View | Dataset, the table or feature class to be analyzed. This is a required parameter.

Returns:
the Input Dataset

setInDataset

public void setInDataset(Object inDataset)
Sets the Input Dataset parameter of this tool . This parameter is Layer | Table View | Dataset, the table or feature class to be analyzed. This is a required parameter.

Parameters:
inDataset - Layer | Table View | Dataset, the table or feature class to be analyzed.

getComponents

public Object getComponents()
Returns the Components to Analyze 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 Components to Analyze

setComponents

public void setComponents(Object components)
Sets the Components to Analyze 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:
components - 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.

getOutDataset

public Object getOutDataset()
Returns the Output Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Dataset

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