Package net.sf.jasperreports.charts.fill

Class JRFillTimeSeriesDataset

java.lang.Object

net.sf.jasperreports.engine.fill.JRFillElementDataset

net.sf.jasperreports.charts.fill.JRFillChartDataset

net.sf.jasperreports.charts.fill.JRFillTimeSeriesDataset

All Implemented Interfaces:

Cloneable, JRChartDataset, JRTimeSeriesDataset, DatasetRunHolder, JRCloneable, JRElementDataset

public class JRFillTimeSeriesDataset
extends JRFillChartDataset
implements JRTimeSeriesDataset

Author:

Flavius Sana (flavius_sana@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_NAME
protected JRFillTimeSeries[]	timeSeries

Fields inherited from class net.sf.jasperreports.engine.fill.JRFillElementDataset

datasetRun, incrementGroup, parent, resetGroup

Fields inherited from interface net.sf.jasperreports.charts.JRChartDataset

CATEGORY_DATASET, GANTT_DATASET, HIGHLOW_DATASET, PIE_DATASET, TIMEPERIOD_DATASET, TIMESERIES_DATASET, VALUE_DATASET, XY_DATASET, XYZ_DATASET

Constructor Summary

Constructors

Constructor	Description
JRFillTimeSeriesDataset(JRTimeSeriesDataset timeSeriesDataset, ChartsFillObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
void	collectExpressions(ChartsExpressionCollector collector)
void	collectExpressions(JRExpressionCollector collector)
protected void	customEvaluate(JRCalculator calculator)	Evaluates the expressions associated with the dataset.
protected void	customIncrement()	Increments the dataset by collecting the result of the expression evaluation.
protected void	customInitialize()	Initializes the element dataset.
org.jfree.data.general.Dataset	getCustomDataset()
byte	getDatasetType()	Gets the dataset type.
Map<Comparable<?>,Map<org.jfree.data.time.RegularTimePeriod,JRPrintHyperlink>>	getItemHyperlinks()
Object	getLabelGenerator()
JRTimeSeries[]	getSeries()
TimePeriodEnum	getTimePeriod()
boolean	hasItemHyperlinks()
void	setTimePeriod(TimePeriodEnum timePeriod)
void	validate(ChartsVerifier verifier)	Validates the dataset using a verifier.

Methods inherited from class net.sf.jasperreports.charts.fill.JRFillChartDataset

getDataset

Methods inherited from class net.sf.jasperreports.engine.fill.JRFillElementDataset

clone, evaluate, evaluateDatasetRun, evaluateIncrementWhenExpression, getDatasetResetType, getDatasetRun, getFillDataset, getFiller, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getInputDataset, getLocale, getResetGroup, getTimeZone, increment, initialize, setBand

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Methods inherited from interface net.sf.jasperreports.engine.JRElementDataset

getDatasetResetType, getDatasetRun, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getResetGroup

Field Detail

EXCEPTION_MESSAGE_KEY_SERIES_NULL_NAME

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_NAME

See Also:

Constant Field Values

timeSeries

protected JRFillTimeSeries[] timeSeries

Constructor Detail

JRFillTimeSeriesDataset

public JRFillTimeSeriesDataset(JRTimeSeriesDataset timeSeriesDataset,
                               ChartsFillObjectFactory factory)

Method Detail

getSeries

public JRTimeSeries[] getSeries()

Specified by:

getSeries in interface JRTimeSeriesDataset

Returns:

an array of JRTimeSeries objects representing the series for the Time Series chart

See Also:

JRTimeSeries

customInitialize

protected void customInitialize()

Description copied from class: JRFillElementDataset

Initializes the element dataset.

The dataset is initialized before being used and after each time the dataset gets reset.

Specified by:

customInitialize in class JRFillElementDataset

See Also:

JRFillElementDataset.getDatasetResetType()

customEvaluate

protected void customEvaluate(JRCalculator calculator)
                       throws JRExpressionEvalException

Description copied from class: JRFillElementDataset

Evaluates the expressions associated with the dataset.

Usually, the result of the evaluation would be preserved so that it is used in JRFillElementDataset.customIncrement()

Specified by:

customEvaluate in class JRFillElementDataset

Parameters:

calculator - used to evaluate expressions

Throws:

JRExpressionEvalException - any exception that occurs while evaluating expressions

customIncrement

protected void customIncrement()

Description copied from class: JRFillElementDataset

Increments the dataset by collecting the result of the expression evaluation.

Specified by:

customIncrement in class JRFillElementDataset

getCustomDataset

public org.jfree.data.general.Dataset getCustomDataset()

Specified by:

getCustomDataset in class JRFillChartDataset

getTimePeriod

public TimePeriodEnum getTimePeriod()

Specified by:

getTimePeriod in interface JRTimeSeriesDataset

Returns:

the time period. Specifies the type of the data series inside the dataset. Time series can contain numeric values associated with days, months, years, or other predefined time periods.

See Also:

TimePeriodEnum

setTimePeriod

public void setTimePeriod(TimePeriodEnum timePeriod)

Specified by:

setTimePeriod in interface JRTimeSeriesDataset

Parameters:

timePeriod - the time period associated with days, months, years, or other predefined time periods.

See Also:

TimePeriodEnum

getDatasetType

public byte getDatasetType()

Description copied from interface: JRChartDataset

Gets the dataset type. Must be one of the dataset type constants defined in this class.

Specified by:

getDatasetType in interface JRChartDataset

getLabelGenerator

public Object getLabelGenerator()

Specified by:

getLabelGenerator in class JRFillChartDataset

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElementDataset

collectExpressions

public void collectExpressions(ChartsExpressionCollector collector)

Specified by:

collectExpressions in interface JRChartDataset

getItemHyperlinks

public Map<Comparable<?>,Map<org.jfree.data.time.RegularTimePeriod,JRPrintHyperlink>> getItemHyperlinks()

hasItemHyperlinks

public boolean hasItemHyperlinks()

validate

public void validate(ChartsVerifier verifier)

Description copied from interface: JRChartDataset

Validates the dataset using a verifier.

Broken rules are collected by the verifier.

Specified by:

validate in interface JRChartDataset

Parameters:

verifier - the verifier to use for validation