Package org.pentaho.plugin.jfreereport.reportcharts.collectors

Class AbstractCollectorFunction

java.lang.Object

org.pentaho.reporting.engine.classic.core.function.AbstractExpression

org.pentaho.reporting.engine.classic.core.function.AbstractFunction

org.pentaho.plugin.jfreereport.reportcharts.collectors.AbstractCollectorFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, org.pentaho.reporting.engine.classic.core.event.ReportListener, org.pentaho.reporting.engine.classic.core.function.Expression, org.pentaho.reporting.engine.classic.core.function.Function

Direct Known Subclasses:

CategorySetDataCollector, IntervalXYSeriesCollector, PieDataSetCollector, PivotCategorySetCollector, TimeSeriesCollector, ValueDataSetCollector, XYSeriesCollector, XYZSeriesCollector

public abstract class AbstractCollectorFunction
extends org.pentaho.reporting.engine.classic.core.function.AbstractFunction

A base class for collector functions. The series name can be given as either an static text or a column name. If given and not empty, a column name takes precedence over a static series name.

Author:

Thomas Morgner.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractCollectorFunction()

Method Summary

Modifier and Type	Method	Description
protected void	buildDataset()
protected abstract org.jfree.data.general.Dataset	createNewDataset()
protected String	generateName(int index)
Boolean	getAutoGenerateMissingSeriesNames()
String	getCrosstabFilterGroup()
protected org.jfree.data.general.Dataset	getDataSet()
org.pentaho.reporting.engine.classic.core.function.Expression	getInstance()	Return a completly separated copy of this function.
protected int	getLastGroupSequenceNumber()
protected int	getMaximumSeriesIndex()
String	getResetGroup()
String[]	getSeriesColumn()
String	getSeriesColumn(int index)
int	getSeriesColumnCount()
String[]	getSeriesName()
String	getSeriesName(int index)
int	getSeriesNameCount()
protected org.pentaho.reporting.engine.classic.core.states.ReportStateKey	getStateKey()
String	getSummaryGroup()
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	isSummaryDataSet()
void	itemsAdvanced(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)	Receives notification that a row of data is being processed.
protected Comparable	querySeriesValue(int index)
void	reportInitialized(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
void	setAutoGenerateMissingSeriesNames(Boolean autoGenerateMissingSeriesNames)
void	setCrosstabFilterGroup(String crosstabFilterGroup)
void	setResetGroup(String resetGroup)
void	setSeriesColumn(int index, String field)
void	setSeriesColumn(String[] fields)
void	setSeriesName(int index, String field)
void	setSeriesName(String[] fields)
void	setSummaryGroup(String summaryGroup)
void	summaryRowSelection(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

AbstractCollectorFunction

public AbstractCollectorFunction()

Method Detail

getCrosstabFilterGroup

public String getCrosstabFilterGroup()

setCrosstabFilterGroup

public void setCrosstabFilterGroup(String crosstabFilterGroup)

isSummaryDataSet

public boolean isSummaryDataSet()

setSeriesName

public void setSeriesName(int index,
                          String field)

getSeriesName

public String getSeriesName(int index)

getSeriesNameCount

public int getSeriesNameCount()

getSeriesName

public String[] getSeriesName()

setSeriesName

public void setSeriesName(String[] fields)

setSeriesColumn

public void setSeriesColumn(int index,
                            String field)

getSeriesColumn

public String getSeriesColumn(int index)

getSeriesColumnCount

public int getSeriesColumnCount()

getSeriesColumn

public String[] getSeriesColumn()

setSeriesColumn

public void setSeriesColumn(String[] fields)

getResetGroup

public String getResetGroup()

setResetGroup

public void setResetGroup(String resetGroup)

getSummaryGroup

public String getSummaryGroup()

setSummaryGroup

public void setSummaryGroup(String summaryGroup)

getValue

public final Object getValue()

Return the current expression value.

The value depends (obviously) on the expression implementation.

Returns:

the value of the function.

reportInitialized

public final void reportInitialized(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)

Specified by:

reportInitialized in interface org.pentaho.reporting.engine.classic.core.event.ReportListener

Overrides:

reportInitialized in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

getStateKey

protected org.pentaho.reporting.engine.classic.core.states.ReportStateKey getStateKey()

getLastGroupSequenceNumber

protected int getLastGroupSequenceNumber()

groupStarted

public final void groupStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)

Specified by:

groupStarted in interface org.pentaho.reporting.engine.classic.core.event.ReportListener

Overrides:

groupStarted in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

itemsAdvanced

public final void itemsAdvanced(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)

Receives notification that a row of data is being processed.

Specified by:

itemsAdvanced in interface org.pentaho.reporting.engine.classic.core.event.ReportListener

Overrides:

itemsAdvanced in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

Parameters:

event - the event.

groupFinished

public final void groupFinished(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)

Receives notification that a group has finished.

Specified by:

groupFinished in interface org.pentaho.reporting.engine.classic.core.event.ReportListener

Overrides:

groupFinished in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

Parameters:

event - the event.

summaryRowSelection

public void summaryRowSelection(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)

Specified by:

summaryRowSelection in interface org.pentaho.reporting.engine.classic.core.event.ReportListener

Overrides:

summaryRowSelection in class org.pentaho.reporting.engine.classic.core.function.AbstractFunction

buildDataset

protected void buildDataset()

createNewDataset

protected abstract org.jfree.data.general.Dataset createNewDataset()

getDataSet

protected org.jfree.data.general.Dataset getDataSet()

getMaximumSeriesIndex

protected int getMaximumSeriesIndex()

getAutoGenerateMissingSeriesNames

public Boolean getAutoGenerateMissingSeriesNames()

setAutoGenerateMissingSeriesNames

public void setAutoGenerateMissingSeriesNames(Boolean autoGenerateMissingSeriesNames)

generateName

protected String generateName(int index)

querySeriesValue

protected Comparable querySeriesValue(int index)

getInstance

public org.pentaho.reporting.engine.classic.core.function.Expression getInstance()

Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.

Specified by:

getInstance in interface org.pentaho.reporting.engine.classic.core.function.Expression

Overrides:

getInstance in class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

Returns:

a copy of this function.