01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * TotalItemCountFunction.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.function;
30:
31: import org.jfree.report.event.PageEventListener;
32: import org.jfree.report.event.ReportEvent;
33: import org.jfree.report.states.LayoutProcess;
34: import org.jfree.report.util.IntegerCache;
35:
36: /**
37: * A report function that counts the total number of items contained in groups in a
38: * report. If no groupname is given, all items of the report are counted.
39: * <p/>
40: * Like all Total-Functions, this function produces a precomputed grand total. The function's result
41: * is precomputed once and will not change later. Printing the result of this function in a group header
42: * returns the same value as printed in the group-footer.
43: * <p/>
44: * The ItemCount can be used to produce a running row-count for a group or report.
45: * <p/>
46: * To count the number of groups in a report, use the TotalGroupCountFunction.
47: *
48: * @author Thomas Morgner
49: */
50: public class TotalPageItemCountFunction extends TotalItemCountFunction
51: implements PageEventListener {
52: public TotalPageItemCountFunction() {
53: }
54:
55: protected boolean isPrepareRunLevel(final ReportEvent event) {
56: if (event.getState().isPrepareRun()
57: && event.getState().getLevel() == LayoutProcess.LEVEL_PAGINATE) {
58: return true;
59: }
60: return false;
61: }
62:
63: /**
64: * Handles the pageStartedEvent.
65: *
66: * @param event the report event.
67: */
68: public void pageStarted(final ReportEvent event) {
69: }
70:
71: /**
72: * Handles the pageFinishedEvent.
73: *
74: * @param event the report event.
75: */
76: public void pageFinished(final ReportEvent event) {
77: setCount(IntegerCache.getInteger(0));
78: }
79: }
|