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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.Frequency

All Implemented Interfaces:

GPTool

public class Frequency
extends AbstractGPTool

Reads a table and a set of fields and creates a new table containing unique field values and the number of occurrences of each unique field value. The Frequency tool is contained in the Analysis Tools tool box.

Usage tips:

• The output table will contain the fieldand the specified frequency field(s) and summary field(s).
• The output table will contain the frequency calculation for each attribute value combination of the specified frequency field(s).
• If a summary field is specified, the unique attribute values of the frequency calculation are summarized by the numeric attribute values of each summary field.
• When using layers, only the currently selected features are used in calculations.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Frequency()
Creates the Frequency tool with defaults.

Frequency(Object inTable, Object outTable, Object frequencyFields)
Creates the Frequency tool with the required parameters.

Method Summary

Object	getFrequencyFields() Returns the Frequency Field(s) 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	getSummaryFields() Returns the Summary 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	setFrequencyFields(Object frequencyFields) Sets the Frequency Field(s) 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	setSummaryFields(Object summaryFields) Sets the Summary 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

Frequency

public Frequency()

Creates the Frequency tool with defaults.

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

Frequency

public Frequency(Object inTable,
                 Object outTable,
                 Object frequencyFields)

Creates the Frequency 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 table containing the field(s) that will be used to calculate frequency statistics. This table can be an INFO or OLE DB table, a dBASE or a VPF table, or a feature class table.

outTable - the table that will store the calculated frequency statistics.

frequencyFields - the attribute field or fields that will be used to calculate frequency statistics.

Method Detail

getInTable

public Object getInTable()

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

Parameters:

inTable - the table containing the field(s) that will be used to calculate frequency statistics. This table can be an INFO or OLE DB table, a dBASE or a VPF table, or a feature class table.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the table that will store the calculated frequency 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 table that will store the calculated frequency statistics. This is a required parameter.

Parameters:

outTable - the table that will store the calculated frequency statistics.

getFrequencyFields

public Object getFrequencyFields()

Returns the Frequency Field(s) parameter of this tool . This parameter is the attribute field or fields that will be used to calculate frequency statistics. This is a required parameter.

Returns:

the Frequency Field(s)

setFrequencyFields

public void setFrequencyFields(Object frequencyFields)

Sets the Frequency Field(s) parameter of this tool . This parameter is the attribute field or fields that will be used to calculate frequency statistics. This is a required parameter.

Parameters:

frequencyFields - the attribute field or fields that will be used to calculate frequency statistics.

getSummaryFields

public Object getSummaryFields()

Returns the Summary Field(s) parameter of this tool . This parameter is the attribute field or fields to sum and add to the output table. Null values are excluded from this calculation. This is an optional parameter.

Returns:

the Summary Field(s)

setSummaryFields

public void setSummaryFields(Object summaryFields)

Sets the Summary Field(s) parameter of this tool . This parameter is the attribute field or fields to sum and add to the output table. Null values are excluded from this calculation. This is an optional parameter.

Parameters:

summaryFields - the attribute field or fields to sum and add to the output table. Null values are excluded from this calculation.

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