com.technia.tvc.core.table

Class TableCalculation

java.lang.Object

com.technia.tvc.core.table.TableCalculation

All Implemented Interfaces:

java.lang.Comparable<TableCalculation>

public abstract class TableCalculation
extends java.lang.Object
implements java.lang.Comparable<TableCalculation>

Defines a calculation that can be used in a table.

Since:

6.3.3

Field Summary

Fields

Modifier and Type	Field and Description
static TableCalculation	AVERAGE Returns the average (mean) value.
static TableCalculation	MAXIMUM Returns the largest number.
static TableCalculation	MEDIAN Returns the median number.
static TableCalculation	MINIMUM Returns the smallest number.
static TableCalculation	STDDEV Returns the standard deviation.
static TableCalculation	SUM Returns the sum (total) of all values.

Method Summary

Modifier and Type	Method and Description
abstract java.math.BigDecimal	calculate(java.math.BigDecimal[] numbers, Column column) Calculate the result given the specified numbers.
int	compareTo(TableCalculation f)
protected int	getDecimalPrecision(Column column)
java.lang.String	getName() Returns the name of the calculation.
MultilingualText	getTitle() Returns the title of the calculation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUM

public static final TableCalculation SUM

Returns the sum (total) of all values.

Since:

6.3.3

AVERAGE

public static final TableCalculation AVERAGE

Returns the average (mean) value.

Since:

6.3.3

MAXIMUM

public static final TableCalculation MAXIMUM

Returns the largest number.

Since:

6.3.3

MINIMUM

public static final TableCalculation MINIMUM

Returns the smallest number.

Since:

6.3.3

MEDIAN

public static final TableCalculation MEDIAN

Returns the median number.

Since:

6.3.3

STDDEV

public static final TableCalculation STDDEV

Returns the standard deviation.

Since:

6.3.3

Method Detail

getDecimalPrecision

protected int getDecimalPrecision(Column column)

calculate

public abstract java.math.BigDecimal calculate(java.math.BigDecimal[] numbers,
                                               Column column)

Calculate the result given the specified numbers.

Parameters:

numbers - The numbers to calculate over. This array must be sorted in ascending order, i.e., the smallest number is first and the largest number is last.

column - The column in which the calculation is taking place.

Returns:

The result of the calculation.

Since:

6.3.3

getTitle

public MultilingualText getTitle()

Returns the title of the calculation.

Returns:

The title.

Since:

6.3.3

compareTo

public int compareTo(TableCalculation f)

Specified by:

compareTo in interface java.lang.Comparable<TableCalculation>

getName

public java.lang.String getName()

Returns the name of the calculation.

Returns:

The name.

Since:

6.3.3

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object