Package de.uplanet.lucy.server.auxiliaries.chart

Class NumberByStringAggregator

java.lang.Object

de.uplanet.lucy.server.auxiliaries.chart.AbstractNumberAggregator<String,SumByStringAggregatorBucket>

de.uplanet.lucy.server.auxiliaries.chart.NumberByStringAggregator

public final class NumberByStringAggregator
extends AbstractNumberAggregator<String,SumByStringAggregatorBucket>

This class can be used to aggregate numbers while grouping them by strings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NumberByStringAggregator.SortableSumByStringAggregatorBucketList

Constructor Summary

Constructors

Constructor	Description
NumberByStringAggregator(Comparator<? super String> p_comparator)	Create an aggregator for string values.

Method Summary

Modifier and Type	Method	Description
void	add(String p_strCategory, String p_strRow, Number p_value, String p_strSingleId)	Add an observation.
NumberByStringAggregator.SortableSumByStringAggregatorBucketList	getAggregatedValues()	Get an ascendingly ordered list of aggregated values.

Methods inherited from class de.uplanet.lucy.server.auxiliaries.chart.AbstractNumberAggregator

getRowComparator, isGroupValueWasNull, isIgnoreIfGroupingValueIsNull, isIgnoreIfRowValueIsNull, isIgnoreIfValueIsNull, isMapNullValueToDefault, isRowValueWasNull, isValueWasNull, setCaseInsensitiveRowComparator, setCaseSensitiveRowComparator, setIgnoreIfGroupingValueIsNull, setIgnoreIfRowValueIsNull, setIgnoreIfValueIsNull, setMapNullValueToDefault, setRowComparator

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberByStringAggregator

public NumberByStringAggregator(Comparator<? super String> p_comparator)

Create an aggregator for string values.

If a comparator is given category values for which this comparator returns a value of zero are considered equal.

Parameters:

p_comparator - A comparator for string values, or null.

Method Detail

getAggregatedValues

public NumberByStringAggregator.SortableSumByStringAggregatorBucketList getAggregatedValues()

Get an ascendingly ordered list of aggregated values.

Specified by:

getAggregatedValues in class AbstractNumberAggregator<String,SumByStringAggregatorBucket>

Returns:

The list of aggregated values.

add

public void add(String p_strCategory,
                String p_strRow,
                Number p_value,
                String p_strSingleId)

Add an observation.

Parameters:

p_strCategory - The category value.

p_strRow - The row value.

p_value - The value.

p_strSingleId - A an identifier that is being stored as long as there is exactly one such identifier for a group (normally a record ID).