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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• The Output Table will consist of fields containing the result of the statistical operation.
• The following statistical operations are available with this tool: Sum, Mean, Maximum, Minimum, Range, Standard Deviation, Count, First, and Last. The Median operation is not available.
• A field will be created for each statistic type using the following naming convention: SUM_FIELD, MAX_FIELD, MIN_FIELD, RANGE_FIELD, STD_FIELD, FIRST_FIELD, LAST_FIELD, COUNT_FIELD. The field name is truncated to 10 characters when the Output Table is a dBASE table.
• If a Case field is specified, statistics will be calculated separately for each unique attribute value. The Output Table will contain only one record if no Case field is specified. If one is specified, there will be one record for each Case field value.
• Null values are excluded from all statistical calculations. For example, the AVERAGE of 10, 5 and NULL is 7.5 ((10+5)/2). The COUNT tool returns the number of values included in the statistical calculation, which in this case is 2.
• The Statistics Field(s) parameter 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 Statistics Field(s) parameter may not be populated with field names. The Add Field button allows you to add expected field(s) so you can complete the Summary Statistics dialog and continue to build your model.
• When using layers, only the currently selected features are used to calculate statistics.

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 - 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 - the output dBASE or geodatabase table that will store the calculated statistics.

statisticsFields - the numeric field containing attribute values used to calculate the specified statistic. Multiple statistic and field combinations may be specified. Null values are excluded from all statistical calculations. the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog box and continue to build your model. available statistics types are:

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is 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 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 - 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 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 the output dBASE or geodatabase table that will store the calculated statistics. This is a required parameter.

Parameters:

outTable - 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 the numeric field containing attribute values used to calculate the specified statistic. Multiple statistic and field combinations may be specified. Null values are excluded from all statistical calculations. the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog box and continue to build your model. available statistics 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 the numeric field containing attribute values used to calculate the specified statistic. Multiple statistic and field combinations may be specified. Null values are excluded from all statistical calculations. the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog box and continue to build your model. available statistics types are: This is a required parameter.

Parameters:

statisticsFields - the numeric field containing attribute values used to calculate the specified statistic. Multiple statistic and field combinations may be specified. Null values are excluded from all statistical calculations. the Add Field button, which is used only in ModelBuilder, allows you to add expected field(s) so you can complete the dialog box and continue to build your model. available statistics types are:

getCaseField

public Object getCaseField()

Returns the Case field parameter of this tool . This parameter is the fields in the Input Table used to calculate statistics separately for each unique attribute value (or combination of attribute 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 the fields in the Input Table used to calculate statistics separately for each unique attribute value (or combination of attribute values when multiple fields are specified). This is an optional parameter.

Parameters:

caseField - the fields in the Input Table used to calculate statistics separately for each unique attribute value (or combination of attribute 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