Package org.pentaho.plugin.jfreereport.reportcharts

Class BaseCollectorFunction

java.lang.Object

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

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

org.pentaho.plugin.jfreereport.reportcharts.BaseCollectorFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ICollectorFunction, 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:

CategorySetCollectorFunction, TimeSeriesCollectorFunction, XYSeriesCollectorFunction

public abstract class BaseCollectorFunction
extends org.pentaho.reporting.engine.classic.core.function.AbstractFunction
implements ICollectorFunction

Creation-Date: 07.06.2007, 18:30:22

Author:

Gretchen Moran

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseCollectorFunction()

Method Summary

Modifier and Type	Method	Description
protected org.jfree.data.general.Dataset	createNewDataset()
Object	getCacheKey()
Object	getDatasourceValue()
String	getGroup()
org.pentaho.reporting.engine.classic.core.function.Expression	getInstance()	Return a completly separated copy of this function.
org.jfree.data.general.AbstractDataset	getNewDataset()	Deprecated. This is not a getter and is an internal function! Protected and should have a different name!
String	getResetGroup()
String[]	getSeriesName()
String	getSeriesName(int index)
int	getSeriesNameCount()
Object	getValue()
void	groupStarted(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
boolean	isSeriesColumn()
boolean	isSummaryOnly()
void	reportInitialized(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)
void	setGroup(String group)
void	setResetGroup(String resetGroup)
void	setSeriesColumn(boolean value)
void	setSeriesName(int index, String field)
void	setSeriesName(String[] fields)
void	setSummaryOnly(boolean value)

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

groupFinished, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted, summaryRowSelection

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

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

Constructor Detail

BaseCollectorFunction

protected BaseCollectorFunction()

Method Detail

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)

createNewDataset

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

isSummaryOnly

public boolean isSummaryOnly()

setSummaryOnly

public void setSummaryOnly(boolean value)

isSeriesColumn

public boolean isSeriesColumn()

setSeriesColumn

public void setSeriesColumn(boolean value)

getGroup

public String getGroup()

Specified by:

getGroup in interface ICollectorFunction

Returns:

setGroup

public void setGroup(String group)

getResetGroup

public String getResetGroup()

setResetGroup

public void setResetGroup(String resetGroup)

getValue

public Object getValue()

Specified by:

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

Specified by:

getValue in interface ICollectorFunction

Returns:

the dataset

getDatasourceValue

public Object getDatasourceValue()

Specified by:

getDatasourceValue in interface ICollectorFunction

reportInitialized

public 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

groupStarted

public 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

getInstance

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

Return a completly separated copy of this function. The copy no longer shares any changeable objects with the original function. Also from Thomas: Should retain data from the report definition, but clear calculated data.

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.

getCacheKey

public Object getCacheKey()

Specified by:

getCacheKey in interface ICollectorFunction

getNewDataset

public org.jfree.data.general.AbstractDataset getNewDataset()

Deprecated.

This is not a getter and is an internal function! Protected and should have a different name!

Returns: