com.technia.tvc.core.table

Class TableCalculations

java.lang.Object

com.technia.tvc.core.table.TableCalculations

public class TableCalculations
extends java.lang.Object

Contains calculations that will be performed on the table content. To add a calculation to a column you can use the API of this class or settings on the column definition. The following settings are supported:

• Calculate Sum
• Calculate Average
• Calculate Maximum
• Calculate Minimum
• Calculate Median
• Calculate Standard Deviation

You may also use the Calculation Decimal Precision setting to control the decimal precision of the calculation.

Note that when the table is changed or when the column definitions in the table is reloaded the calculations that you have added programmatically will be removed.

Since:

6.3.3

Method Summary

Modifier and Type	Method and Description
void	addCalculation(Column column, TableCalculation calc) Adds a calculation to a column.
void	addCalculationsFromColumns() Add table calculations for columns based on the settings that have been defined on the column.
TableCalculationResults	calculate() Calculate the results of all TableCalculations for the visible columns.
TableCalculationResults	calculate(com.technia.tvc.commons.collections15.Predicate<Column> columnPredicate) Calculate the results of all TableCalculations for the selected columns.
void	clearCalculations() Removes all table calculations from this table.
TableCalculation[]	getCalculations() Returns all table calculations.
TableCalculation[]	getCalculations(Column column) Get all table calculations on a particular column.
TableCalculation[]	getCalculationsForColumns(com.technia.tvc.commons.collections15.Predicate<Column> columnPredicate) Returns all table calculations assigned to the selected columns.
TableCalculation[]	getCalculationsForVisibleColumns() Returns all table calculations assigned to visible columns.
TableDataFilter	getTableDataFilter() Returns a filter that decides which TableData instances to include when calculating.
boolean	hasCalculation(Column column, TableCalculation calc) Check if a calculation has been associated with a particular column.
boolean	hasCalculations() Check if any table calculations exist on the table.
boolean	hasCalculations(Column column) Checks if one or more table calculations have been added to a column.
boolean	hasCalculationsForColumns(com.technia.tvc.commons.collections15.Predicate<Column> columnPredicate) Returns true if the table has any calculations for the columns accepted by the predicate.
boolean	hasCalculationsForVisibleColumns() Checks if any table calculations are associated with the currently visible columns.
void	removeCalculation(Column column, TableCalculation calc) Remove a calculation from a column.
void	setTableDataFilter(TableDataFilter filter) Sets the filter that will be used to further filter the TableData instances that are included in the calculations.

Methods inherited from class java.lang.Object

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

Method Detail

getTableDataFilter

public TableDataFilter getTableDataFilter()

Returns a filter that decides which TableData instances to include when calculating. This filter will be used on top of existing filters for visibility on the TableBean. This can be used to for example only include root nodes in a structure when calculating.

Returns:

An additional filter used (if set) when filtering TableData.

Since:

6.3.3

See Also:

setTableDataFilter(TableDataFilter)

setTableDataFilter

public void setTableDataFilter(TableDataFilter filter)

Sets the filter that will be used to further filter the TableData instances that are included in the calculations.

Parameters:

filter - The new filter.

Since:

6.3.3

See Also:

getTableDataFilter()

calculate

public TableCalculationResults calculate()

Calculate the results of all TableCalculations for the visible columns.

Returns:

The results.

Since:

6.3.3

calculate

public TableCalculationResults calculate(com.technia.tvc.commons.collections15.Predicate<Column> columnPredicate)

Calculate the results of all TableCalculations for the selected columns.

Parameters:

columnPredicate - A predicate that decides which columns to include.

Returns:

The results.

Since:

6.3.3

getCalculations

public TableCalculation[] getCalculations()

Returns all table calculations.

Returns:

Returns all table calculations on this table.

Since:

6.3.3

getCalculationsForColumns

public TableCalculation[] getCalculationsForColumns(com.technia.tvc.commons.collections15.Predicate<Column> columnPredicate)

Returns all table calculations assigned to the selected columns.

Parameters:

columnPredicate - Selects columns.

Returns:

Returns all table calculations assigned to the selected columns.

Since:

6.3.3

getCalculationsForVisibleColumns

public TableCalculation[] getCalculationsForVisibleColumns()

Returns all table calculations assigned to visible columns.

Returns:

Returns all table calculations assigned to visible columns.

Since:

6.3.3

getCalculations

public TableCalculation[] getCalculations(Column column)

Get all table calculations on a particular column.

Parameters:

column - A column.

Returns:

Returns all table calculations for this column.

Since:

6.3.3

hasCalculations

public boolean hasCalculations()

Check if any table calculations exist on the table.

Returns:

Returns true if any table calculations exist for this table.

Since:

6.3.3

hasCalculationsForColumns

public boolean hasCalculationsForColumns(com.technia.tvc.commons.collections15.Predicate<Column> columnPredicate)

Returns true if the table has any calculations for the columns accepted by the predicate.

Parameters:

columnPredicate - A predecate that decides which columns to check.

Returns:

True if any of the accepted columns has calculations.

Since:

6.3.3

hasCalculationsForVisibleColumns

public boolean hasCalculationsForVisibleColumns()

Checks if any table calculations are associated with the currently visible columns.

Since:

6.3.3

hasCalculations

public boolean hasCalculations(Column column)

Checks if one or more table calculations have been added to a column.

Parameters:

column - A column.

Returns:

Returns true if the column has functions.

Since:

6.3.3

hasCalculation

public boolean hasCalculation(Column column,
                              TableCalculation calc)

Check if a calculation has been associated with a particular column.

Parameters:

column - A column.

calc - A calculation.

Returns:

Return true if it's associated.

Since:

6.3.3

addCalculation

public void addCalculation(Column column,
                           TableCalculation calc)

Adds a calculation to a column.

Parameters:

column - A column.

calc - The calculation to add to the column.

Throws:

java.lang.NullPointerException - If any argument is null.

Since:

6.3.3

addCalculationsFromColumns

public void addCalculationsFromColumns()

Add table calculations for columns based on the settings that have been defined on the column. This method will clear any table calculations that are currently associated with the columns in this table.

Since:

6.3.3

removeCalculation

public void removeCalculation(Column column,
                              TableCalculation calc)

Remove a calculation from a column.

Parameters:

column - A column.

calc - The calculation that should be removed from the column.

Throws:

java.lang.NullPointerException - If any argument is null.

Since:

6.3.3

clearCalculations

public void clearCalculations()

Removes all table calculations from this table.

Since:

6.3.3