com.day.cq.reporting

Interface Aggregate

public interface Aggregate

This interface must be implemented by each aggregate's implementation.

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregateValue(CellValue valueToAggregate) Aggregates the specified value.
String	getAggregatedType() Returns the data type of aggregated values.
CellValue	getAggregatedValue(Report report) Returns the aggregated value.
CellValue	getColumnTotal(Report report) Returns the totalled aggregate value for the entire column, if available.
void	reset() Resets the aggregate to its initial state.
boolean	useDistinctValues() Determines if the aggregate requires distinct values.

Method Detail

reset

void reset()

Resets the aggregate to its initial state.

useDistinctValues

boolean useDistinctValues()

Determines if the aggregate requires distinct values.

Returns:

true if the aggregate uses distinct values for calculation

aggregateValue

void aggregateValue(CellValue valueToAggregate)

Aggregates the specified value.

Parameters:

valueToAggregate - The value to aggregate

getAggregatedValue

CellValue getAggregatedValue(Report report)

Returns the aggregated value.

Parameters:

report - The report

Returns:

The aggregated value

getColumnTotal

CellValue getColumnTotal(Report report)

Returns the totalled aggregate value for the entire column, if available.

Parameters:

report - The report

Returns:

The totalled aggregate value; null if no totalled aggregate value is available

getAggregatedType

String getAggregatedType()

Returns the data type of aggregated values.

Returns:

The data type