com.jidesoft.pivot

Interface PivotSummaryCalculator

All Superinterfaces:

SummaryCalculator

All Known Implementing Classes:

BigDecimalSummaryCalculator, DefaultPivotSummaryCalculator

public interface PivotSummaryCalculator
extends SummaryCalculator

An interface used to calculate the summary for pivot table. It extends the SummaryCalculator under the grid package.

This interface added extra parameters (such as PivotValueProvider, PivotField, Values for rows and columns etc.) to addValue methods in case the summary calculation needs to know about it. However in our default implementation, these extra parameters are not used.

Field Summary

Fields inherited from interface com.jidesoft.grid.SummaryCalculator

ALLOWED_SUMMARIES_ALL, ALLOWED_SUMMARIES_COUNT, ALLOWED_SUMMARIES_MAX_MIN_COUNT, SUMMARY_CONSTANT, SUMMARY_COUNT, SUMMARY_CUSTOM, SUMMARY_MAX, SUMMARY_MEAN, SUMMARY_MIN, SUMMARY_NONE, SUMMARY_RESERVED_MAX, SUMMARY_STDDEV, SUMMARY_SUM, SUMMARY_VAR

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(IPivotDataModel dataModel, PivotField field, int rowIndex, int columnIndex, Object value) Deprecated. replaced by addValue(PivotValueProvider, PivotField, Values, Values, Object)
void	addValue(PivotValueProvider valueProvider, PivotField field, Object value) Deprecated. replaced by addValue(PivotValueProvider, PivotField, Values, Values, Object)
void	addValue(PivotValueProvider dataModel, PivotField field, Values rowValues, Values columnValues, Object value) Adds a value for calculation.

Methods inherited from interface com.jidesoft.grid.SummaryCalculator

addValue, clear, getAllowedSummaries, getAllowedSummaries, getCount, getNumberOfSummaries, getSummaryName, getSummaryResult

Method Detail

addValue

void addValue(PivotValueProvider dataModel,
            PivotField field,
            Values rowValues,
            Values columnValues,
            Object value)

Adds a value for calculation. Different from SummaryCalculator.addValue(Object) which only takes the value as parameter, this method provides PivotValueProvider, PivotField and row/column values of the cell as in the DataTableModel.

To get the row indices in the original table model, please try to use the following code.

 ((IPivotDataModel) dataModel).getDataAt(((DefaultValues) rowValues).toCompoundKey(), ((DefaultValues)
 columnValues).toCompoundKey());
 

Parameters:

dataModel - the PivotDataModel

field - the PivotField

rowValues - the row values corresponding to the cell to calculate.

columnValues - the column values corresponding to the cell to calculate.

value - the value

addValue

@Deprecated
void addValue(IPivotDataModel dataModel,
                       PivotField field,
                       int rowIndex,
                       int columnIndex,
                       Object value)

Deprecated. replaced by addValue(PivotValueProvider, PivotField, Values, Values, Object)

Adds a value for calculation. Different from SummaryCalculator.addValue(Object) which only takes the value as parameter, this method provides PivotDataModel, PivotField and row/column index of the cell as in the DataTableModel.

Parameters:

dataModel - the PivotDataModel

field - the PivotField

rowIndex - the row index as in the PivotDataModel#getDataTableModel. It could be -1 if the row index is not available.

columnIndex - the column index as in the PivotDataModel#getDataTableModel. It could be -1 if the column index is not available.

value - the value

addValue

@Deprecated
void addValue(PivotValueProvider valueProvider,
                       PivotField field,
                       Object value)

Deprecated. replaced by addValue(PivotValueProvider, PivotField, Values, Values, Object)

Adds a value for calculation..

Parameters:

valueProvider - the PivotValueProvider

field - the PivotField

value - the value