| |
|
| java.lang.Object org.jfree.report.function.AbstractExpression org.jfree.report.function.AbstractFunction org.jfree.report.function.TotalGroupSumQuotientFunction org.jfree.report.function.TotalGroupSumQuotientPercentFunction
TotalGroupSumQuotientPercentFunction | public class TotalGroupSumQuotientPercentFunction extends TotalGroupSumQuotientFunction (Code) | | A report function that calculates the quotient of two summed fields (columns) from the data-row. This function
produces a global total. The total sum of the group is known when the group processing starts and the report is not
performing a prepare-run. The sum is calculated in the prepare run and recalled in the printing run.
The function can be used in two ways: - to calculate a quotient for the entire report;
- to calculate a
quotient within a particular group;
This function expects its input values to be either java.lang.Number
instances or Strings that can be parsed to java.lang.Number instances using a java.text.DecimalFormat.
The function undestands three parameters. The dividend parameter is required and denotes the name of an
ItemBand-field which gets summed up as dividend. The divisor parameter is required and denotes the name
of an ItemBand-field which gets summed up as divisor.
The parameter group denotes the name of a group. When this group is started, the counter gets reseted to
null. This parameter is optional.
This function scales the computed percentage to 100. A value of 100% will therefore be returned as 100 instead of 1.
The result of this function cannot be used together with the percentage operator of the NumberFormat in a
Number-field.
author: Thomas Morgner |
Method Summary | |
public Object | getValue() Computes the scaled percentage. |
TotalGroupSumQuotientPercentFunction | public TotalGroupSumQuotientPercentFunction()(Code) | | Default Constructor.
|
getValue | public Object getValue()(Code) | | Computes the scaled percentage.
the computed percentage scaled to 100. |
|
|
|