Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.reduction

Class AggregateField

java.lang.Object

com.esri.arcgisruntime.mapping.reduction.AggregateField

public final class AggregateField
extends Object

Defines a field or statistical ArcadeExpression for summarizing aggregated data from an AggregationFeatureReduction.

Feature reduction uses statistical methods to aggregate geoelements into logical groups based on their location. Attribute values for each group (AggregateGeoElement) can be summarized for any numeric field using a specified AggregateStatisticType, such as the average, maximum, or sum. A common workflow is to summarize aggregated groups with the number of geoelements they represent.

Since:

200.3.0

Property Summary

Properties

Type	Property	Description
StringProperty	alias	A display name for the field that appears in a Popup, label, and other UI elements.
StringProperty	name	A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection.
ObjectProperty<ArcadeExpression>	statisticExpression	An Arcade expression that must evaluate to either a string or a number.
StringProperty	statisticFieldName	An attribute name from the source dataset that contains numeric values to summarize.
ObjectProperty<AggregateStatisticType>	statisticType	Defines the type of statistic for summarizing values returned from statisticFieldNameProperty() or statisticExpressionProperty().

Constructor Summary

Constructors

Constructor	Description
AggregateField(String name, ArcadeExpression statisticExpression, AggregateStatisticType statisticType)	Creates an AggregateField object.
AggregateField(String name, String statisticFieldName, AggregateStatisticType statisticType)	Creates an AggregateField object.

Method Summary

Modifier and Type	Method	Description
StringProperty	aliasProperty()	A display name for the field that appears in a Popup, label, and other UI elements.
String	getAlias()	Gets the value of the alias property.
String	getName()	Gets the value of the name property.
ArcadeExpression	getStatisticExpression()	Gets the value of the statisticExpression property.
String	getStatisticFieldName()	Gets the value of the statisticFieldName property.
AggregateStatisticType	getStatisticType()	Gets the value of the statisticType property.
StringProperty	nameProperty()	A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection.
void	setAlias(String alias)	Sets the value of the alias property.
void	setName(String name)	Sets the value of the name property.
void	setStatisticExpression(ArcadeExpression statisticExpression)	Sets the value of the statisticExpression property.
void	setStatisticFieldName(String statisticFieldName)	Sets the value of the statisticFieldName property.
void	setStatisticType(AggregateStatisticType statisticType)	Sets the value of the statisticType property.
ObjectProperty<ArcadeExpression>	statisticExpressionProperty()	An Arcade expression that must evaluate to either a string or a number.
StringProperty	statisticFieldNameProperty()	An attribute name from the source dataset that contains numeric values to summarize.
ObjectProperty<AggregateStatisticType>	statisticTypeProperty()	Defines the type of statistic for summarizing values returned from statisticFieldNameProperty() or statisticExpressionProperty().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

alias

public StringProperty aliasProperty

A display name for the field that appears in a Popup, label, and other UI elements.

Attempting to set the value to null will throw a NullPointerException exception.

Since:

200.3.0

See Also:

• getAlias()
• setAlias(String)
• aliasProperty()

name

public StringProperty nameProperty

A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection. Clusters will not draw correctly if this property is empty or does not match the field name used by AggregationFeatureReduction.rendererProperty().

For example, an AggregateField that summarizes 'population' values might have the alias 'population_sum'.

Attempting to set the value to null will throw a NullPointerException exception.

Since:

200.3.0

See Also:

• getName()
• setName(String)
• nameProperty()

statisticExpression

public ObjectProperty<ArcadeExpression> statisticExpressionProperty

An Arcade expression that must evaluate to either a string or a number.

The expression is evaluated for each geoelement represented by the AggregateGeoElement and the result of the expression is summarized using the given statistic type.

Since:

200.3.0

See Also:

• getStatisticExpression()
• setStatisticExpression(ArcadeExpression)
• statisticExpressionProperty()

statisticFieldName

public StringProperty statisticFieldNameProperty

An attribute name from the source dataset that contains numeric values to summarize.

Alternatively, an Arcade expression (statisticExpressionProperty()) can be used instead of an AggregateStatisticType. If present, this value always takes precedence over AggregateField.statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Since:

200.3.0

See Also:

• getStatisticFieldName()
• setStatisticFieldName(String)
• statisticFieldNameProperty()

statisticType

public ObjectProperty<AggregateStatisticType> statisticTypeProperty

Defines the type of statistic for summarizing values returned from statisticFieldNameProperty() or statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Since:

200.3.0

See Also:

• getStatisticType()
• setStatisticType(AggregateStatisticType)
• statisticTypeProperty()

Constructor Details

AggregateField

public AggregateField(String name,
 ArcadeExpression statisticExpression,
 AggregateStatisticType statisticType)

Creates an AggregateField object.

Parameters:

name - a name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection

statisticExpression - an Arcade expression that evaluates to either a string or a number

statisticType - type of statistic used to summarize numeric field for aggregated geoelements

Throws:

NullPointerException - if name is null

NullPointerException - if statisticExpression is null

NullPointerException - if statisticType is null

Since:

200.3.0

AggregateField

public AggregateField(String name,
 String statisticFieldName,
 AggregateStatisticType statisticType)

Creates an AggregateField object.

Parameters:

name - a name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection

statisticFieldName - an attribute name from the source dataset that contains numeric values to summarize

statisticType - type of statistic used to summarize numeric field for aggregated geoelements

Throws:

NullPointerException - if name is null

NullPointerException - if statisticFieldName is null

NullPointerException - if statisticType is null

Since:

200.3.0

Method Details

aliasProperty

public StringProperty aliasProperty()

A display name for the field that appears in a Popup, label, and other UI elements.

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the alias property

Since:

200.3.0

See Also:

• getAlias()
• setAlias(String)

getAlias

public String getAlias()

Gets the value of the alias property.

Property description:

A display name for the field that appears in a Popup, label, and other UI elements.

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the value of the alias property

Since:

200.3.0

See Also:

• setAlias(String)
• aliasProperty()

setAlias

public void setAlias(String alias)

Sets the value of the alias property.

Property description:

A display name for the field that appears in a Popup, label, and other UI elements.

Attempting to set the value to null will throw a NullPointerException exception.

Parameters:

alias - the value for the alias property

Since:

200.3.0

See Also:

• getAlias()
• aliasProperty()

nameProperty

public StringProperty nameProperty()

A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection. Clusters will not draw correctly if this property is empty or does not match the field name used by AggregationFeatureReduction.rendererProperty().

For example, an AggregateField that summarizes 'population' values might have the alias 'population_sum'.

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the name property

Since:

200.3.0

See Also:

• getName()
• setName(String)

getName

public String getName()

Gets the value of the name property.

Property description:

A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection. Clusters will not draw correctly if this property is empty or does not match the field name used by AggregationFeatureReduction.rendererProperty().

For example, an AggregateField that summarizes 'population' values might have the alias 'population_sum'.

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the value of the name property

Since:

200.3.0

See Also:

• setName(String)
• nameProperty()

setName

public void setName(String name)

Sets the value of the name property.

Property description:

A name that uniquely identifies the aggregate field within the AggregationFeatureReduction.getAggregateFields() collection. Clusters will not draw correctly if this property is empty or does not match the field name used by AggregationFeatureReduction.rendererProperty().

For example, an AggregateField that summarizes 'population' values might have the alias 'population_sum'.

Attempting to set the value to null will throw a NullPointerException exception.

Parameters:

name - the value for the name property

Since:

200.3.0

See Also:

• getName()
• nameProperty()

statisticExpressionProperty

public ObjectProperty<ArcadeExpression> statisticExpressionProperty()

An Arcade expression that must evaluate to either a string or a number.

The expression is evaluated for each geoelement represented by the AggregateGeoElement and the result of the expression is summarized using the given statistic type.

Returns:

the statisticExpression property

Since:

200.3.0

See Also:

• getStatisticExpression()
• setStatisticExpression(ArcadeExpression)

getStatisticExpression

public ArcadeExpression getStatisticExpression()

Gets the value of the statisticExpression property.

Property description:

An Arcade expression that must evaluate to either a string or a number.

The expression is evaluated for each geoelement represented by the AggregateGeoElement and the result of the expression is summarized using the given statistic type.

Returns:

the value of the statisticExpression property

Since:

200.3.0

See Also:

• setStatisticExpression(ArcadeExpression)
• statisticExpressionProperty()

setStatisticExpression

public void setStatisticExpression(ArcadeExpression statisticExpression)

Sets the value of the statisticExpression property.

Property description:

An Arcade expression that must evaluate to either a string or a number.

The expression is evaluated for each geoelement represented by the AggregateGeoElement and the result of the expression is summarized using the given statistic type.

Parameters:

statisticExpression - the value for the statisticExpression property

Since:

200.3.0

See Also:

• getStatisticExpression()
• statisticExpressionProperty()

statisticFieldNameProperty

public StringProperty statisticFieldNameProperty()

An attribute name from the source dataset that contains numeric values to summarize.

Alternatively, an Arcade expression (statisticExpressionProperty()) can be used instead of an AggregateStatisticType. If present, this value always takes precedence over AggregateField.statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the statisticFieldName property

Since:

200.3.0

See Also:

• getStatisticFieldName()
• setStatisticFieldName(String)

getStatisticFieldName

public String getStatisticFieldName()

Gets the value of the statisticFieldName property.

Property description:

An attribute name from the source dataset that contains numeric values to summarize.

Alternatively, an Arcade expression (statisticExpressionProperty()) can be used instead of an AggregateStatisticType. If present, this value always takes precedence over AggregateField.statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the value of the statisticFieldName property

Since:

200.3.0

See Also:

• setStatisticFieldName(String)
• statisticFieldNameProperty()

setStatisticFieldName

public void setStatisticFieldName(String statisticFieldName)

Sets the value of the statisticFieldName property.

Property description:

An attribute name from the source dataset that contains numeric values to summarize.

Alternatively, an Arcade expression (statisticExpressionProperty()) can be used instead of an AggregateStatisticType. If present, this value always takes precedence over AggregateField.statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Parameters:

statisticFieldName - the value for the statisticFieldName property

Since:

200.3.0

See Also:

• getStatisticFieldName()
• statisticFieldNameProperty()

statisticTypeProperty

public ObjectProperty<AggregateStatisticType> statisticTypeProperty()

Defines the type of statistic for summarizing values returned from statisticFieldNameProperty() or statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the statisticType property

Since:

200.3.0

See Also:

• getStatisticType()
• setStatisticType(AggregateStatisticType)

getStatisticType

public AggregateStatisticType getStatisticType()

Gets the value of the statisticType property.

Property description:

Defines the type of statistic for summarizing values returned from statisticFieldNameProperty() or statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Returns:

the value of the statisticType property

Since:

200.3.0

See Also:

• setStatisticType(AggregateStatisticType)
• statisticTypeProperty()

setStatisticType

public void setStatisticType(AggregateStatisticType statisticType)

Sets the value of the statisticType property.

Property description:

Defines the type of statistic for summarizing values returned from statisticFieldNameProperty() or statisticExpressionProperty().

Attempting to set the value to null will throw a NullPointerException exception.

Parameters:

statisticType - the value for the statisticType property

Since:

200.3.0

See Also:

• getStatisticType()
• statisticTypeProperty()