|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.function.AbstractExpression
org.pentaho.reporting.engine.classic.core.function.AbstractFunction
org.pentaho.reporting.engine.classic.core.function.ItemCountFunction
public class ItemCountFunction
A report function that counts items in a report. If the "group" property is set, the item count is reset to zero whenever the group changes.
Constructor Summary | |
---|---|
ItemCountFunction()
Constructs an unnamed function. |
|
ItemCountFunction(String name)
Constructs an item count report function. |
Method Summary | |
---|---|
String |
getGroup()
Returns the name of the group (possibly null) for this function. |
Object |
getValue()
Returns the number of items counted (so far) by the function. |
void |
groupStarted(ReportEvent event)
Receives notification that a new group is about to start. |
void |
itemsAdvanced(ReportEvent event)
Received notification of a move to the next row of data. |
void |
reportInitialized(ReportEvent event)
Receives notification that a new report is about to start. |
void |
setGroup(String group)
Setss the name of the group for this function. |
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, getInstance, 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, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime |
Constructor Detail |
---|
public ItemCountFunction()
This constructor is intended for use by the SAX handler class only.
public ItemCountFunction(String name)
name
- The name of the function.
NullPointerException
- if the name is nullMethod Detail |
---|
public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- the event.public String getGroup()
getGroup
in interface AggregationFunction
public void setGroup(String group)
setGroup
in interface AggregationFunction
group
- The group name.public void groupStarted(ReportEvent event)
groupStarted
in interface ReportListener
groupStarted
in class AbstractFunction
event
- Information about the event.public void itemsAdvanced(ReportEvent event)
itemsAdvanced
in interface ReportListener
itemsAdvanced
in class AbstractFunction
event
- Information about the event.public Object getValue()
getValue
in interface Expression
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |