|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object java.lang.Enum<CalculationEnum> net.sf.jasperreports.engine.type.CalculationEnum
public enum CalculationEnum
Enum Constant Summary | |
---|---|
AVERAGE
The value is obtained by calculating the average for the series of values obtained by evaluating the variable's expression for each record in the data source. |
|
COUNT
The value is calculated by counting the non-null values of the variable expression with every iteration in the data source. |
|
DISTINCT_COUNT
The value is calculated by counting the distinct non-null values of the variable expression with every iteration in the data source. |
|
FIRST
The variable keeps the first value and does not increment it on subsequent iterations. |
|
HIGHEST
The value of the variable represents the highest in the series of values obtained by evaluating the variable's expression for each data source record. |
|
LOWEST
The value of the variable represents the lowest in the series of values obtained by evaluating the variable's expression for each data source record. |
|
NOTHING
The value is calculated by simply evaluating the variable expression. |
|
STANDARD_DEVIATION
The value is obtained by calculating the standard deviation for the series of values returned by evaluating the variable's expression. |
|
SUM
The value is calculated by summing up the values returned by the variable's expression. |
|
SYSTEM
The value is not calculated by JasperReports. |
|
VARIANCE
The value is obtained by calculating the variance for the series of values returned by evaluating the variable's expression. |
Method Summary | |
---|---|
static CalculationEnum |
getByName(java.lang.String name)
|
static CalculationEnum |
getByValue(byte value)
|
static CalculationEnum |
getByValue(java.lang.Byte value)
|
java.lang.String |
getName()
|
byte |
getValue()
|
java.lang.Byte |
getValueByte()
|
static CalculationEnum |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static CalculationEnum[] |
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final CalculationEnum NOTHING
public static final CalculationEnum COUNT
public static final CalculationEnum SUM
public static final CalculationEnum AVERAGE
In order to calculate the average, the engine creates behind the scenes a helper report variable that calculates the sum of the values and uses it to calculate the average for those values. This helper sum variable gets its name from the corresponding average variable suffixed with "_SUM" sequence. This helper variable can be used in other report expressions just like any normal variable.
public static final CalculationEnum LOWEST
public static final CalculationEnum HIGHEST
public static final CalculationEnum STANDARD_DEVIATION
Just like for the variables that calculate the average, the engine creates and uses helper report variables for first obtaining the sum and the count that correspond to your current series of values. The name for those helper variables that are created behind the scenes is obtained by suffixing the user variable with the "_SUM" or "_COUNT" suffix and they can be used in other report expressions like any other report variable.
For variables that calculate the standard deviation, there is always a helper variable present, that first calculates the variance for the series of values and it has the "_VARIANCE" suffix added to its name.
public static final CalculationEnum VARIANCE
public static final CalculationEnum SYSTEM
public static final CalculationEnum FIRST
public static final CalculationEnum DISTINCT_COUNT
Method Detail |
---|
public static CalculationEnum[] values()
for (CalculationEnum c : CalculationEnum.values()) System.out.println(c);
public static CalculationEnum valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic java.lang.Byte getValueByte()
getValueByte
in interface JREnum
public final byte getValue()
getValue
in interface JREnum
public java.lang.String getName()
getName
in interface JREnum
public static CalculationEnum getByName(java.lang.String name)
public static CalculationEnum getByValue(java.lang.Byte value)
public static CalculationEnum getByValue(byte value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |