io.jmix.pivottable.model

Class Aggregation

java.lang.Object

io.jmix.pivottable.model.AbstractPivotObject

io.jmix.pivottable.model.Aggregation

All Implemented Interfaces:

java.io.Serializable

public class Aggregation
extends AbstractPivotObject

Constructor for an object which will aggregate results per cell (see documentation).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Aggregation()

Method Summary

Modifier and Type	Method and Description
Aggregation	addProperties(java.lang.String... properties)
java.lang.String	getCaption()
java.lang.Boolean	getCustom()
JsFunction	getFunction()
java.lang.String	getId()
AggregationMode	getMode()
java.util.List<java.lang.String>	getProperties()
Aggregation	setCaption(java.lang.String caption) When Aggregation is set as PivotTableModel.aggregation, then caption will be converted to aggregatorName - the name of the aggregator, used for display purposes in some renderers.
Aggregation	setCustom(java.lang.Boolean custom) Sets whatever a function defined in function field must be used as the aggregation.
Aggregation	setFunction(JsFunction function) Sets a function which will aggregate results per cell (see documentation).
Aggregation	setMode(AggregationMode mode) Sets one of predefined aggregation modes.
Aggregation	setProperties(java.util.List<java.lang.String> properties) Sets a collection of property names to pass as parameters to selected aggregation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Aggregation

public Aggregation()

Method Detail

getId

public java.lang.String getId()

Returns:

Id for the unique identification of this Aggregation

getMode

public AggregationMode getMode()

Returns:

one of predefined aggregation modes

setMode

public Aggregation setMode(AggregationMode mode)

Sets one of predefined aggregation modes.

Applies only when custom=false.

Parameters:

mode - one of predefined aggregation modes

Returns:

a reference to this object

See Also:

setCustom(Boolean)

getCaption

public java.lang.String getCaption()

Returns:

a caption of aggregation

setCaption

public Aggregation setCaption(java.lang.String caption)

When Aggregation is set as PivotTableModel.aggregation, then caption will be converted to aggregatorName - the name of the aggregator, used for display purposes in some renderers.

When Aggregation is added as one of Aggregations.aggregations, then caption will be converted to a key in dictionary of generators for aggregation functions in dropdown menu.

Parameters:

caption - a caption of aggregation

Returns:

a reference to this object

getCustom

public java.lang.Boolean getCustom()

Returns:

true if a function defined in function field must be used as the aggregation, false otherwise

setCustom

public Aggregation setCustom(java.lang.Boolean custom)

Sets whatever a function defined in function field must be used as the aggregation.

Parameters:

custom - true if a function defined in function field must be used as the aggregation, false otherwise

Returns:

a reference to this object

See Also:

setFunction(JsFunction)

getFunction

public JsFunction getFunction()

Returns:

a function which will aggregate results per cell

setFunction

public Aggregation setFunction(JsFunction function)

Sets a function which will aggregate results per cell (see documentation).

Applies only when custom=true.

Parameters:

function - a function which will aggregate results per cell

Returns:

a reference to this object

See Also:

setCustom(Boolean)

getProperties

public java.util.List<java.lang.String> getProperties()

Returns:

a collection of property names to pass as parameters to selected aggregation

setProperties

public Aggregation setProperties(java.util.List<java.lang.String> properties)

Sets a collection of property names to pass as parameters to selected aggregation.

Applies only when custom=false.

Parameters:

properties - a collection of property names to pass as parameters to selected aggregation

Returns:

a reference to this object

See Also:

setCustom(Boolean)

addProperties

public Aggregation addProperties(java.lang.String... properties)