|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.jrefinery.report.function.AbstractFunction | +--com.jrefinery.report.function.TotalCalculationFunction
A report function that stores the result of a calculation for a group or the complete report. The field value, that was read when the group finished, is stored and returned when the group gets active again in a higher processing level.
This function can be used to calculate total values for a group, f.I. a TotalMax for the group, which returns the maximum value encountered for that field in the current group. The computed values are available to all bands of the group.
The function undestands two parameters, the field
parameter is required and
denotes the name of an ItemBand-field which gets summed up.
The parameter group
denotes the name of a group. When this group is started,
the counter gets reseted to null. This parameter is optional.
Field Summary | |
static java.lang.String |
GROUP_PROPERTY
Literal text for the 'group' property. |
Fields inherited from interface com.jrefinery.report.function.Expression |
AUTOACTIVATE_PROPERTY |
Constructor Summary | |
TotalCalculationFunction()
Constructs a new function. |
Method Summary | |
java.lang.String |
getGroup()
Returns the name of the group to be totalled. |
java.lang.Object |
getValue()
Return the current expression value. |
void |
groupFinished(ReportEvent event)
Receives notification that a group has finished. |
void |
groupStarted(ReportEvent event)
Receives notification that a group has started. |
void |
reportInitialized(ReportEvent event)
Receives notification that the report has started. |
void |
setGroup(java.lang.String group)
Defines the name of the group to be totalled. |
Methods inherited from class com.jrefinery.report.function.AbstractFunction |
clone, getDataRow, getDependencyLevel, getInstance, getName, getProperties, getProperty, getProperty, initialize, isActive, itemsAdvanced, itemsFinished, itemsStarted, pageFinished, pageStarted, reportDone, reportFinished, reportStarted, setDataRow, setDependencyLevel, setName, setProperties, setProperty |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String GROUP_PROPERTY
Constructor Detail |
public TotalCalculationFunction()
Initially the function has no name...be sure to assign one before using the function.
Method Detail |
public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- the event.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- the event.public void groupFinished(ReportEvent event)
groupFinished
in interface ReportListener
groupFinished
in class AbstractFunction
event
- the event.public java.lang.String getGroup()
public void setGroup(java.lang.String group)
group
- the group name.public java.lang.Object getValue()
The value depends (obviously) on the expression implementation.
getValue
in interface Expression
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |