public class TocDataGeneratorFunction
extends org.pentaho.reporting.engine.classic.core.function.AbstractFunction
implements org.pentaho.reporting.engine.classic.core.event.PageEventListener
Constructor and Description |
---|
TocDataGeneratorFunction()
Creates an unnamed function.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clones the expression.
|
int |
getDependencyLevel()
Returns the dependency level for the expression (controls evaluation order for expressions and functions).
|
String[] |
getGroup()
Returns all defined groups as array of strings.
|
String |
getGroup(int index)
Returns the defined field at the given index-position.
|
int |
getGroupCount()
Returns the number of groups defined in this expression.
|
String |
getIndexSeparator() |
org.pentaho.reporting.engine.classic.core.function.Expression |
getInstance()
Return a completly separated copy of this function.
|
org.pentaho.reporting.engine.classic.core.util.TypedTableModel |
getModel() |
String |
getTitleField() |
String |
getTitleFormula() |
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 |
pageFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that a page is completed.
|
void |
pageStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
Receives notification that a new page is being started.
|
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 |
setDependencyLevel(int dependencyLevel) |
void |
setGroup(int index,
String field)
Defines the field in the field-list at the given index.
|
void |
setGroup(String[] fields)
Defines all groups as array.
|
void |
setIndexSeparator(String indexSeparator) |
void |
setTitleField(String titleField) |
void |
setTitleFormula(String titleFormula) |
reportDone, reportFinished, summaryRowSelection
getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isPreserve, setActive, setName, setPreserve, setRuntime
public TocDataGeneratorFunction()
AbstractExpression.setName(java.lang.String)
before the function
is added to the report's function collection.public void setDependencyLevel(int dependencyLevel)
setDependencyLevel
in interface org.pentaho.reporting.engine.classic.core.function.Expression
setDependencyLevel
in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
public int getDependencyLevel()
getDependencyLevel
in interface org.pentaho.reporting.engine.classic.core.function.Expression
getDependencyLevel
in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression
public String getIndexSeparator()
public void setIndexSeparator(String indexSeparator)
public String getTitleFormula()
public void setTitleFormula(String titleFormula)
public String getTitleField()
public void setTitleField(String titleField)
public boolean isCollectDetails()
public void setCollectDetails(boolean collectDetails)
public void setGroup(int index, String field)
index
- the position in the list, where the field should be defined.field
- the name of the field.public String getGroup(int index)
index
- the position of the field name that should be queried.public int getGroupCount()
public String[] getGroup()
public void setGroup(String[] fields)
fields
- the new list of groups.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 void pageStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
pageStarted
in interface org.pentaho.reporting.engine.classic.core.event.PageEventListener
event
- The event.public void pageFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
pageFinished
in interface org.pentaho.reporting.engine.classic.core.event.PageEventListener
event
- The event.public Object getValue()
getValue
in interface org.pentaho.reporting.engine.classic.core.function.Expression
public org.pentaho.reporting.engine.classic.core.util.TypedTableModel getModel()
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 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 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.