|
||||||||||
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.EventMonitorFunction
public class EventMonitorFunction
A function that logs each event that it receives. This function can be used for debugging purposes.
Constructor Summary | |
---|---|
EventMonitorFunction()
Creates a new function. |
|
EventMonitorFunction(String name)
Creates a new function. |
Method Summary | |
---|---|
Object |
getValue()
Returns null since this function is for generating log messages only. |
void |
groupFinished(ReportEvent event)
Receives notification that a group has finished. |
void |
groupStarted(ReportEvent event)
Receives notification that a group has started. |
boolean |
isDeepTraversing()
Returns whether this expression will receive events from subreports. |
void |
itemsAdvanced(ReportEvent event)
Receives notification that a row of data is being processed. |
void |
itemsFinished(ReportEvent event)
Receives notification that a group of item bands has been completed. |
void |
itemsStarted(ReportEvent event)
Receives notification that a group of item bands is about to be processed. |
void |
pageFinished(ReportEvent event)
Receives notification that a page has ended. |
void |
pageStarted(ReportEvent event)
Receives notification that a page has started. |
void |
reportDone(ReportEvent event)
Receives notification that report generation has completed, the report footer was printed, no more output is done. |
void |
reportFinished(ReportEvent event)
Receives notification that the report has finished. |
void |
reportInitialized(ReportEvent event)
Receives notification that report generation initializes the current run. |
void |
reportStarted(ReportEvent event)
Receives notification that the report has started. |
void |
setDeepTraversing(boolean deepTraversing)
Defines, whether this expression will receive events from subreports. |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression |
---|
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, 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.function.Expression |
---|
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setDependencyLevel, setName, setRuntime |
Constructor Detail |
---|
public EventMonitorFunction()
public EventMonitorFunction(String name)
name
- the name of the functionMethod Detail |
---|
public void reportStarted(ReportEvent event)
reportStarted
in interface ReportListener
reportStarted
in class AbstractFunction
event
- the event.public void reportFinished(ReportEvent event)
reportFinished
in interface ReportListener
reportFinished
in class AbstractFunction
event
- the event.public void reportDone(ReportEvent event)
reportDone
in interface ReportListener
reportDone
in class AbstractFunction
event
- The event.public void pageStarted(ReportEvent event)
pageStarted
in interface PageEventListener
event
- the event.public void pageFinished(ReportEvent event)
pageFinished
in interface PageEventListener
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 void itemsAdvanced(ReportEvent event)
itemsAdvanced
in interface ReportListener
itemsAdvanced
in class AbstractFunction
event
- the event.public void itemsStarted(ReportEvent event)
itemsStarted
in interface ReportListener
itemsStarted
in class AbstractFunction
event
- the event.public void itemsFinished(ReportEvent event)
itemsFinished
in interface ReportListener
itemsFinished
in class AbstractFunction
event
- the event.public void reportInitialized(ReportEvent event)
The event carries a ReportState.Started state. Use this to initialize the report.
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- The event.public Object getValue()
null
since this function is for generating log messages only.
getValue
in interface Expression
null
).public boolean isDeepTraversing()
isDeepTraversing
in interface Expression
isDeepTraversing
in class AbstractExpression
public void setDeepTraversing(boolean deepTraversing)
deepTraversing
- true, if the function is deep-traversing, false otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |