org.pentaho.reporting.engine.classic.core.function
Class TotalPageItemCountFunction

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.function.AbstractExpression
      extended by org.pentaho.reporting.engine.classic.core.function.AbstractFunction
          extended by org.pentaho.reporting.engine.classic.core.function.TotalItemCountFunction
              extended by org.pentaho.reporting.engine.classic.core.function.TotalPageItemCountFunction
All Implemented Interfaces:
Serializable, Cloneable, EventListener, PageEventListener, ReportListener, AggregationFunction, Expression, Function

public class TotalPageItemCountFunction
extends TotalItemCountFunction
implements PageEventListener

A report function that counts the total number of items contained in groups in a report. If no groupname is given, all items of the report are counted.

Like all Total-Functions, this function produces a precomputed grand total. The function's result is precomputed once and will not change later. Printing the result of this function in a group header returns the same value as printed in the group-footer.

The ItemCount can be used to produce a running row-count for a group or report.

To count the number of groups in a report, use the TotalGroupCountFunction.

Author:
Thomas Morgner
See Also:
Serialized Form

Constructor Summary
TotalPageItemCountFunction()
           
 
Method Summary
 void pageFinished(ReportEvent event)
          Handles the pageFinishedEvent.
 void pageStarted(ReportEvent event)
          Handles the pageStartedEvent.
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.TotalItemCountFunction
getGroup, getInstance, getValue, groupStarted, itemsAdvanced, reportInitialized, setGroup
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
groupFinished, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted
 
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
clone, getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener
groupFinished, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted
 
Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression
clone, getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime
 

Constructor Detail

TotalPageItemCountFunction

public TotalPageItemCountFunction()
Method Detail

pageStarted

public void pageStarted(ReportEvent event)
Handles the pageStartedEvent.

Specified by:
pageStarted in interface PageEventListener
Parameters:
event - the report event.

pageFinished

public void pageFinished(ReportEvent event)
Handles the pageFinishedEvent.

Specified by:
pageFinished in interface PageEventListener
Parameters:
event - the report event.