org.thymeleaf.expression
Class Aggregates

Object
  extended by org.thymeleaf.expression.Aggregates

public final class Aggregates
extends Object

Utility class for performing aggregation operations on numbers (collections or arrays).

An object of this class is usually available in variable evaluation expressions with the name #aggregates.

Since:
1.0
Author:
Daniel Fernández

Constructor Summary
Aggregates()
           Create an object of this class.
 
Method Summary
 BigDecimal avg(byte[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal avg(double[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal avg(float[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal avg(int[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal avg(Iterable<? extends Number> target)
           Returns the average of all the numbers contained in the provided iterable (e.g. a collection).
 BigDecimal avg(long[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal avg(Number[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal avg(short[] target)
           Returns the average of all the numbers contained in the provided array.
 BigDecimal sum(byte[] target)
           Returns the sum of all the numbers contained in the provided array.
 BigDecimal sum(double[] target)
           Returns the sum of all the numbers contained in the provided array.
 BigDecimal sum(float[] target)
           Returns the sum of all the numbers contained in the provided array.
 BigDecimal sum(int[] target)
           Returns the sum of all the numbers contained in the provided array.
 BigDecimal sum(Iterable<? extends Number> target)
           Returns the sum of all the numbers contained in the provided iterable (e.g. a collection).
 BigDecimal sum(long[] target)
           Returns the sum of all the numbers contained in the provided array.
 BigDecimal sum(Number[] target)
           Returns the sum of all the numbers contained in the provided array.
 BigDecimal sum(short[] target)
           Returns the sum of all the numbers contained in the provided array.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Aggregates

public Aggregates()

Create an object of this class.

Normally, this is only executed internally by the expression evaluation subsystems in dialects.

Method Detail

sum

public BigDecimal sum(Iterable<? extends Number> target)

Returns the sum of all the numbers contained in the provided iterable (e.g. a collection).

This method delegates on AggregateUtils.sum(Iterable).

Parameters:
target - the iterable containing the number objects
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(Number[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(Object[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(byte[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(byte[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(short[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(short[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(int[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(int[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(long[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(long[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(float[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(float[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

sum

public BigDecimal sum(double[] target)

Returns the sum of all the numbers contained in the provided array.

This method delegates on AggregateUtils.sum(double[]).

Parameters:
target - the array of numbers
Returns:
the sum, as a BigDecimal

avg

public BigDecimal avg(Iterable<? extends Number> target)

Returns the average of all the numbers contained in the provided iterable (e.g. a collection).

This method delegates on AggregateUtils.avg(Iterable).

Parameters:
target - the iterable containing the number objects
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(Number[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(Object[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(byte[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(byte[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(short[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(short[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(int[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(int[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(long[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(long[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(float[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(float[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal

avg

public BigDecimal avg(double[] target)

Returns the average of all the numbers contained in the provided array.

This method delegates on AggregateUtils.avg(double[]).

Parameters:
target - the array of numbers
Returns:
the average, as a BigDecimal


Copyright © 2012 The THYMELEAF team. All Rights Reserved.