com.esri.arcgis.geoprocessing.tools.analysistools
Class Statistics

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

public class Statistics
extends AbstractGPTool

Calculates summary statistics for field(s) in a table. The Summary Statistics tool is contained in the Analysis Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Statistics()
          Creates the Summary Statistics tool with defaults.
Statistics(Object inTable, Object outTable, Object statisticsFields)
          Creates the Summary Statistics tool with the required parameters.
 
Method Summary
 Object getCaseField()
          Returns the Case field parameter of this tool .
 Object getInTable()
          Returns the Input Table parameter of this tool .
 Object getOutTable()
          Returns the Output Table parameter of this tool .
 Object getStatisticsFields()
          Returns the Statistics Field(s) 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 setCaseField(Object caseField)
          Sets the Case field parameter of this tool .
 void setInTable(Object inTable)
          Sets the Input Table parameter of this tool .
 void setOutTable(Object outTable)
          Sets the Output Table parameter of this tool .
 void setStatisticsFields(Object statisticsFields)
          Sets the Statistics Field(s) 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

Statistics

public Statistics()
Creates the Summary Statistics tool with defaults.

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


Statistics

public Statistics(Object inTable,
                  Object outTable,
                  Object statisticsFields)
Creates the Summary Statistics 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 - Table View | Raster Layer, the input table containing the field(s) that will be used to calculate statistics. The input can be an INFO table, a dBASE table, an OLE DB table, a VPF table, or a feature class.
outTable - Table, the output dBASE or geodatabase table that will store the calculated statistics.
statisticsFields - (Field String; Field String;...), available statistic types are:
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is Table View | Raster Layer, the input table containing the field(s) that will be used to calculate statistics. The input can be an INFO table, a dBASE table, an OLE DB table, a VPF table, or a feature 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 Table View | Raster Layer, the input table containing the field(s) that will be used to calculate statistics. The input can be an INFO table, a dBASE table, an OLE DB table, a VPF table, or a feature class. This is a required parameter.

Parameters:
inTable - Table View | Raster Layer, the input table containing the field(s) that will be used to calculate statistics. The input can be an INFO table, a dBASE table, an OLE DB table, a VPF table, or a feature class.

getOutTable

public Object getOutTable()
Returns the Output Table parameter of this tool . This parameter is Table, the output dBASE or geodatabase table that will store the calculated statistics. This is a required parameter.

Returns:
the Output Table

setOutTable

public void setOutTable(Object outTable)
Sets the Output Table parameter of this tool . This parameter is Table, the output dBASE or geodatabase table that will store the calculated statistics. This is a required parameter.

Parameters:
outTable - Table, the output dBASE or geodatabase table that will store the calculated statistics.

getStatisticsFields

public Object getStatisticsFields()
Returns the Statistics Field(s) parameter of this tool . This parameter is (Field String; Field String;...), available statistic types are: This is a required parameter.

Returns:
the Statistics Field(s)

setStatisticsFields

public void setStatisticsFields(Object statisticsFields)
Sets the Statistics Field(s) parameter of this tool . This parameter is (Field String; Field String;...), available statistic types are: This is a required parameter.

Parameters:
statisticsFields - (Field String; Field String;...), available statistic types are:

getCaseField

public Object getCaseField()
Returns the Case field parameter of this tool . This parameter is Field, the fields in the Input Table used to calculate statistics separately for each unique attribute value (or combination of attributes values when multiple fields are specified). This is an optional parameter.

Returns:
the Case field

setCaseField

public void setCaseField(Object caseField)
Sets the Case field parameter of this tool . This parameter is Field, the fields in the Input Table used to calculate statistics separately for each unique attribute value (or combination of attributes values when multiple fields are specified). This is an optional parameter.

Parameters:
caseField - Field, the fields in the Input Table used to calculate statistics separately for each unique attribute value (or combination of attributes values when multiple fields are specified).

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