public class IndexNumberGeneratorFunction
extends org.pentaho.reporting.engine.classic.core.function.AbstractFunction
Constructor and Description |
---|
IndexNumberGeneratorFunction()
Creates an unnamed function.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clones the expression.
|
int |
getDepth() |
org.pentaho.reporting.engine.classic.core.function.Expression |
getInstance()
Return a completly separated copy of this function.
|
Object |
getValue()
Return the current expression value.
|
void |
groupFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that a group has finished.
|
void |
groupStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event) |
boolean |
isCollectDetails() |
boolean |
isDeepTraversing()
Checks whether this expression is a deep-traversing expression.
|
void |
itemsAdvanced(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that a row of data is being processed.
|
void |
itemsFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that a group of item bands has been completed.
|
void |
itemsStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that a group of item bands is about to be processed.
|
void |
reportInitialized(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that report generation initializes the current run.
|
void |
reportStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that the report has started.
|
void |
setCollectDetails(boolean collectDetails) |
void |
setDepth(int depth) |
reportDone, reportFinished, summaryRowSelection
getDataRow, getDependencyLevel, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime
public IndexNumberGeneratorFunction()
AbstractExpression.setName(java.lang.String)
before the function
is added to the report's function collection.public boolean isCollectDetails()
public void setCollectDetails(boolean collectDetails)
public int getDepth()
public void setDepth(int depth)
public void reportInitialized(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
The event carries a ReportState.Started state. Use this to initialize the report.
reportInitialized
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
reportInitialized
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
event
- The event.public void reportStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
reportStarted
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
reportStarted
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
event
- the event.public void groupStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
groupStarted
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
groupStarted
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
public void itemsStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
The next events will be itemsAdvanced events until the itemsFinished event is raised.
itemsStarted
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
itemsStarted
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
event
- The event.public void itemsAdvanced(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
itemsAdvanced
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
itemsAdvanced
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
event
- the event.public void itemsFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
The itemBand is finished, the report starts to close open groups.
itemsFinished
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
itemsFinished
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
event
- The event.public void groupFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
groupFinished
in interface org.pentaho.reporting.engine.classic.core.event.ReportListener
groupFinished
in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction
event
- the event.public Object getValue()
public Object clone() throws CloneNotSupportedException
Expressions maintain no state, cloning is done at the beginning of the report processing to disconnect the expression from any other object space.
clone
in interface org.pentaho.reporting.engine.classic.core.function.Expression
clone
in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
CloneNotSupportedException
- this should never happen.public boolean isDeepTraversing()
isDeepTraversing
in interface org.pentaho.reporting.engine.classic.core.function.Expression
isDeepTraversing
in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
public org.pentaho.reporting.engine.classic.core.function.Expression getInstance()
getInstance
in interface org.pentaho.reporting.engine.classic.core.function.Expression
getInstance
in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
Copyright © 2019 Hitachi Vantara. All rights reserved.