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

Class TimeSeriesCollector

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

org.pentaho.plugin.jfreereport.reportcharts.collectors.TimeSeriesCollector

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

public class TimeSeriesCollector
extends AbstractCollectorFunction

The number of entries in the series, value, and timeValueColumns properties must be the same. The function will collect from tuples of {series, value (y), timeValue (x)}.

Author:

Thomas Morgner.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TimeSeriesCollector()

Method Summary

Modifier and Type	Method	Description
protected void	buildDataset()
protected org.jfree.data.general.Dataset	createNewDataset()
org.pentaho.reporting.engine.classic.core.function.Expression	getInstance()	Return a completly separated copy of this function.
protected HashMap<Comparable,org.jfree.data.time.TimeSeries>	getSeriesMap()
Class	getTimePeriod()
String[]	getTimeValueColumn()
String	getTimeValueColumn(int index)
int	getTimeValueColumnCount()
String[]	getValueColumn()
String	getValueColumn(int index)
int	getValueColumnCount()
void	reportDone(org.pentaho.reporting.engine.classic.core.event.ReportEvent event)	Receives notification that report generation has completed, the report footer was printed, no more output is done.
void	setTimePeriod(Class timePeriod)
void	setTimeValueColumn(int index, String field)
void	setTimeValueColumn(String[] fields)
void	setValueColumn(int index, String field)
void	setValueColumn(String[] fields)

Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.collectors.AbstractCollectorFunction

generateName, getAutoGenerateMissingSeriesNames, getCrosstabFilterGroup, getDataSet, getLastGroupSequenceNumber, getMaximumSeriesIndex, getResetGroup, getSeriesColumn, getSeriesColumn, getSeriesColumnCount, getSeriesName, getSeriesName, getSeriesNameCount, getStateKey, getSummaryGroup, getValue, groupFinished, groupStarted, isSummaryDataSet, itemsAdvanced, querySeriesValue, reportInitialized, setAutoGenerateMissingSeriesNames, setCrosstabFilterGroup, setResetGroup, setSeriesColumn, setSeriesColumn, setSeriesName, setSeriesName, setSummaryGroup, summaryRowSelection

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

itemsFinished, itemsStarted, 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

TimeSeriesCollector

public TimeSeriesCollector()

Method Detail

createNewDataset

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

Specified by:

createNewDataset in class AbstractCollectorFunction

getTimePeriod

public Class getTimePeriod()

setTimePeriod

public void setTimePeriod(Class timePeriod)

getSeriesMap

protected HashMap<Comparable,org.jfree.data.time.TimeSeries> getSeriesMap()

setValueColumn

public void setValueColumn(int index,
                           String field)

setTimeValueColumn

public void setTimeValueColumn(int index,
                               String field)

getValueColumn

public String getValueColumn(int index)

getValueColumnCount

public int getValueColumnCount()

getValueColumn

public String[] getValueColumn()

setValueColumn

public void setValueColumn(String[] fields)

getTimeValueColumn

public String getTimeValueColumn(int index)

getTimeValueColumnCount

public int getTimeValueColumnCount()

getTimeValueColumn

public String[] getTimeValueColumn()

setTimeValueColumn

public void setTimeValueColumn(String[] fields)

buildDataset

protected void buildDataset()

Overrides:

buildDataset in class AbstractCollectorFunction

reportDone

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

Receives notification that report generation has completed, the report footer was printed, no more output is done. This is a helper event to shut down the output service.

Specified by:

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

Overrides:

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

Parameters:

event - The event.

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 AbstractCollectorFunction

Returns:

a copy of this function.