Package net.sf.jasperreports.engine

Interface JRElementDataset

All Superinterfaces:

Cloneable, DatasetRunHolder, JRCloneable

All Known Subinterfaces:

ChartDataset, JRCategoryDataset, JRChartDataset, JRCrosstabDataset, JRGanttDataset, JRHighLowDataset, JRPieDataset, JRTimePeriodDataset, JRTimeSeriesDataset, JRValueDataset, JRXyDataset, JRXyzDataset, MultiAxisDataset, SpiderDataset

All Known Implementing Classes:

BaseMultiAxisDataset, DesignMultiAxisDataset, FillItemDataset, FillMultiAxisDataset, FillSpiderDataset, JRBaseCategoryDataset, JRBaseChartDataset, JRBaseCrosstabDataset, JRBaseElementDataset, JRBaseGanttDataset, JRBaseHighLowDataset, JRBasePieDataset, JRBaseTimePeriodDataset, JRBaseTimeSeriesDataset, JRBaseValueDataset, JRBaseXyDataset, JRBaseXyzDataset, JRDesignCategoryDataset, JRDesignChartDataset, JRDesignCrosstabDataset, JRDesignElementDataset, JRDesignGanttDataset, JRDesignHighLowDataset, JRDesignPieDataset, JRDesignTimePeriodDataset, JRDesignTimeSeriesDataset, JRDesignValueDataset, JRDesignXyDataset, JRDesignXyzDataset, JRFillCategoryDataset, JRFillChartDataset, JRFillCrosstab.JRFillCrosstabDataset, JRFillElementDataset, JRFillGanttDataset, JRFillHighLowDataset, JRFillPieDataset, JRFillTimePeriodDataset, JRFillTimeSeriesDataset, JRFillValueDataset, JRFillXyDataset, JRFillXyzDataset, StandardSpiderDataset

public interface JRElementDataset
extends JRCloneable, DatasetRunHolder

Element datasets are used to represent the report data needed to generate a chart or crosstab. The dataset structure may vary with each chart type or crosstab. This is the superinterface for all datasets and contains common dataset properties.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Method Summary

Modifier and Type	Method	Description
void	collectExpressions(JRExpressionCollector collector)
DatasetResetTypeEnum	getDatasetResetType()	Gets the reset type.
JRDatasetRun	getDatasetRun()	Returns the sub dataset run for this chart dataset.
String	getIncrementGroup()	Gets the selected increment group in case of increment type group.
IncrementTypeEnum	getIncrementType()	Returns the increment type.
JRExpression	getIncrementWhenExpression()	Returns the "increment when" expression.
String	getResetGroup()	Gets the selected reset group in case of reset type group.

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

clone

Method Detail

getDatasetResetType

DatasetResetTypeEnum getDatasetResetType()

Gets the reset type. This specifies the range of report data used for filling the dataset.

Returns:

one of the reset constants in DatasetResetTypeEnum

getResetGroup

String getResetGroup()

Gets the selected reset group in case of reset type group.

getIncrementType

IncrementTypeEnum getIncrementType()

Returns the increment type. This specifies dataset values increment step.

Returns:

one of the increment constants in IncrementTypeEnum.

getIncrementGroup

String getIncrementGroup()

Gets the selected increment group in case of increment type group.

collectExpressions

void collectExpressions(JRExpressionCollector collector)

getDatasetRun

JRDatasetRun getDatasetRun()

Returns the sub dataset run for this chart dataset.

Specified by:

getDatasetRun in interface DatasetRunHolder

Returns:

the sub dataset run for this chart dataset

getIncrementWhenExpression

JRExpression getIncrementWhenExpression()

Returns the "increment when" expression.

This expression determines whether a dataset will be incremented or not.

The expression (if not null) is evaluated before each increment of the dataset. The increment will be carried on only when the result of the evaluation is Boolean.TRUE; if the result is null or false, the increment will not be performed.

Returns:

the "increment when" expression