Interface AggregationRequestable<E>

Type Parameters:

E - is the type of the elements a AggregationRequestable.

All Known Subinterfaces:

IArrayList<E>, IContainer<E>, ILinkedList<E>, IMatrix<E>, IMatrixColumn<E>, IMatrixRow<E>, ISqlRecord

All Known Implementing Classes:

AbstractContainer, AbstractExtendedContainer, ArrayContainerView, ArrayList, ContainerView, FilterContainerView, ImmutableList, IntervallContainerView, IterableContainerView, LinkedList, MappingContainerView, Matrix, MatrixColumn, MatrixRow, MultiContainerView, SingleContainer, SqlRecord

public interface AggregationRequestable<E>

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
double	getAverage(Function<E,Number> valueMapper)
double	getAverageOrZero(Function<E,Number> valueMapper)
<C extends Comparable<C>> C	getMax(Function<E,C> comparableMapper)
double	getMaxOrZero(Function<E,Number> numberMapper)
double	getMedian(Function<E,Number> numberMapper)
double	getMedianOrZero(Function<E,Number> numberMapper)
<C extends Comparable<C>> C	getMin(Function<E,C> comparableMapper)
double	getMinOrZero(Function<E,Number> numberMapper)
double	getStandardDeviation(Function<E,Number> numberMapper)
BigDecimal	getSum(Function<E,Number> valueMapper)
BigInteger	getSumOfInts(ToIntFunction<E> intMapper)
double	getVariance(Function<E,Number> numberMapper)

Method Details

getAverage

double getAverage(Function<E,Number> valueMapper)

Parameters:

valueMapper -

Returns:

the average of the values the given valueMapper maps from the elements of the current AggregationRequestable. Maps null elements to 0.0.

Throws:

RuntimeException - if the given valueMapper is null.

RuntimeException - if the current AggregationRequestable is empty.

getAverageOrZero

double getAverageOrZero(Function<E,Number> valueMapper)

Parameters:

valueMapper -

Returns:

the average of the values the given valueMapper maps from the elements of the current AggregationRequestable if the current AggregationRequestable contains any, 0.0 otherwise. Maps null elements to 0.0.

Throws:

RuntimeException - if the given valueMapper is null.

getMax

<C extends Comparable<C>> C getMax(Function<E,C> comparableMapper)

Type Parameters:

C - is the type of the Comparables the given comparableMapper maps from the elements of the current AggregationRequestable.

Parameters:

comparableMapper -

Returns:

the biggest Comparable the given comparableMapper maps from the elements of the current AggregationRequestable. Ignores null elements.

Throws:

RuntimeException - if the given comparableMapper is null.

RuntimeException - if the current AggregationRequestable does not contain a non-null element.

getMaxOrZero

double getMaxOrZero(Function<E,Number> numberMapper)

Parameters:

numberMapper -

Returns:

the biggest number the given numberMapper maps from the non-null elements of the current AggregationRequestable if the current AggregationRequestable contains non-null elements, 0.0 otherwise.

getMedian

double getMedian(Function<E,Number> numberMapper)

Parameters:

numberMapper -

Returns:

the median of the numbers the given numberMapper maps from the elements of the current AggregationRequestable. Maps null elements to 0.0.

Throws:

RuntimeException - if the given numberMapper is null.

RuntimeException - if the current AggregationRequestable is empty.

getMedianOrZero

double getMedianOrZero(Function<E,Number> numberMapper)

Parameters:

numberMapper -

Returns:

the median of the numbers the given numberMapper maps from the elements of the current AggregationRequestable if the current AggregationRequestable is not empty, 0.0 otherwise. Maps null elements to 0.0.

Throws:

RuntimeException - if the given numberMapper is null.

getMin

<C extends Comparable<C>> C getMin(Function<E,C> comparableMapper)

Type Parameters:

C - is the type of the Comparables the given comparableMapper maps from the elements of the current AggregationRequestable.

Parameters:

comparableMapper -

Returns:

the smallest Comparable the given comparableMapper maps from the elements of the current AggregationRequestable. Ignores null elements.

Throws:

RuntimeException - if the given comparableMapper is null.

RuntimeException - if the current AggregationRequestable does not contain a non-null element.

getMinOrZero

double getMinOrZero(Function<E,Number> numberMapper)

Parameters:

numberMapper -

Returns:

the smallest number the given numberMapper maps from the non-null elements of the current AggregationRequestable if the current AggregationRequestable contains non-null elements, 0.0 otherwise.

getStandardDeviation

double getStandardDeviation(Function<E,Number> numberMapper)

Parameters:

numberMapper -

Returns:

the standard deviation of the numbers the given numberMapper maps from the elements of the current AggregationRequestable.

Throws:

RuntimeException - if the given numberMapper is null.

RuntimeException - if the current AggregationRequestable is empty.

getSum

BigDecimal getSum(Function<E,Number> valueMapper)

Parameters:

valueMapper -

Returns:

the sum of the values the given valueMapper maps from the elements of the current AggregationRequestable. Maps null elements to 0.0.

Throws:

RuntimeException - if the given valueMapper is null.

getSumOfInts

BigInteger getSumOfInts(ToIntFunction<E> intMapper)

Parameters:

intMapper -

Returns:

the sum of the ints the given intMapper maps from the elements of the current AggregationRequestable. Maps null elements to 0.0.

Throws:

RuntimeException - if the given intMapper is null.

getVariance

double getVariance(Function<E,Number> numberMapper)

Parameters:

numberMapper -

Returns:

the variance of the numbers the given numberMapper maps from the elements of the current AggregationRequestable. Maps null elements to 0.0.

Throws:

RuntimeException - if the given numberMapper is null.

RuntimeException - if the current AggregationRequestable is empty.