java.lang.Object
com.esri.arcgisruntime.data.StatisticDefinition
Defines a statistic type and field to be used for statistics query in the
FeatureTable
.- Since:
- 100.2.0
-
Constructor Summary
ConstructorDescriptionStatisticDefinition
(String fieldName, StatisticType statisticType) Creates a statistic definition based on a field name and statistic type.StatisticDefinition
(String fieldName, StatisticType statisticType, String outputAlias) Creates a statistic definition for given field name, statistic type and optional output alias name. -
Method Summary
Modifier and TypeMethodDescriptionGets the name of the field in the table containing values on which the statistic should be computed.Gets the alias name for this statistic in the results.Gets the statistic type.void
setFieldName
(String fieldName) Sets the name of the field in the table containing values on which the statistic should be computed.void
setOutputAlias
(String outputAlias) Sets the alias name for this statistic in the results.void
setStatisticType
(StatisticType statisticType) Sets the statistic type.
-
Constructor Details
-
StatisticDefinition
Creates a statistic definition based on a field name and statistic type.- Parameters:
fieldName
- the name of the field in the table containing values for the statisticstatisticType
- the statistic type to calculate- Throws:
IllegalArgumentException
- if fieldName or statisticType is null- Since:
- 100.2.0
-
StatisticDefinition
Creates a statistic definition for given field name, statistic type and optional output alias name.- Parameters:
fieldName
- the name of the field in the table containing values for the statisticstatisticType
- the statistic type to calculateoutputAlias
- the optional name for the statistic in the results, can be null. If it is null, the output alias will be composed as Type+"_"+fieldName- Throws:
IllegalArgumentException
- if fieldName or statisticType is null- Since:
- 100.2.0
-
-
Method Details
-
getFieldName
Gets the name of the field in the table containing values on which the statistic should be computed.- Returns:
- the field name
- Since:
- 100.2.0
-
setFieldName
Sets the name of the field in the table containing values on which the statistic should be computed.- Parameters:
fieldName
- the name of the field- Throws:
IllegalArgumentException
- if the value is null or an empty string- Since:
- 100.4.0
-
getOutputAlias
Gets the alias name for this statistic in the results.
If an output alias is not specified, a default name that identifies the statistic type and input field name will be used for the result.- Returns:
- the output alias
- Since:
- 100.2.0
-
setOutputAlias
Sets the alias name for this statistic in the results.
If an output alias is not specified, a default name that identifies the statistic type and input field name will be used for the result.- Parameters:
outputAlias
- the output alias- Since:
- 100.4.0
-
getStatisticType
Gets the statistic type.- Returns:
- the statistic type
- Since:
- 100.2.0
-
setStatisticType
Sets the statistic type.- Parameters:
statisticType
- the statistic type- Throws:
IllegalArgumentException
- if statisticType is null- Since:
- 100.4.0
-