Package net.sf.jasperreports.engine.base

Class JRBaseElementDataset

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElementDataset

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, DatasetRunHolder, JRCloneable, JRElementDataset

Direct Known Subclasses:

BaseMultiAxisDataset, JRBaseChartDataset, JRBaseCrosstabDataset, JRDesignElementDataset

public class JRBaseElementDataset
extends java.lang.Object
implements JRElementDataset, java.io.Serializable

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DatasetResetTypeEnum	datasetResetType
protected JRDatasetRun	datasetRun
protected JRGroup	incrementGroup
protected IncrementTypeEnum	incrementTypeValue
protected JRExpression	incrementWhenExpression
protected JRGroup	resetGroup

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRBaseElementDataset()
protected	JRBaseElementDataset(JRElementDataset dataset)
protected	JRBaseElementDataset(JRElementDataset dataset, JRBaseObjectFactory factory)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

datasetResetType

protected DatasetResetTypeEnum datasetResetType

incrementTypeValue

protected IncrementTypeEnum incrementTypeValue

resetGroup

protected JRGroup resetGroup

incrementGroup

protected JRGroup incrementGroup

datasetRun

protected JRDatasetRun datasetRun

incrementWhenExpression

protected JRExpression incrementWhenExpression

Constructor Detail

JRBaseElementDataset

protected JRBaseElementDataset()

JRBaseElementDataset

protected JRBaseElementDataset(JRElementDataset dataset)

JRBaseElementDataset

protected JRBaseElementDataset(JRElementDataset dataset,
                               JRBaseObjectFactory factory)

Method Detail

getDatasetResetType

public DatasetResetTypeEnum getDatasetResetType()

Description copied from interface: JRElementDataset

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

Specified by:

getDatasetResetType in interface JRElementDataset

Returns:

one of the reset constants in DatasetResetTypeEnum

getIncrementTypeValue

public IncrementTypeEnum getIncrementTypeValue()

Description copied from interface: JRElementDataset

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

Specified by:

getIncrementTypeValue in interface JRElementDataset

Returns:

one of the increment constants in IncrementTypeEnum.

getResetGroup

public JRGroup getResetGroup()

Description copied from interface: JRElementDataset

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

Specified by:

getResetGroup in interface JRElementDataset

getIncrementGroup

public JRGroup getIncrementGroup()

Description copied from interface: JRElementDataset

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

Specified by:

getIncrementGroup in interface JRElementDataset

getDatasetRun

public JRDatasetRun getDatasetRun()

Description copied from interface: JRElementDataset

Returns the sub dataset run for this chart dataset.

Specified by:

getDatasetRun in interface DatasetRunHolder

Specified by:

getDatasetRun in interface JRElementDataset

Returns:

the sub dataset run for this chart dataset

getIncrementWhenExpression

public JRExpression getIncrementWhenExpression()

Description copied from interface: JRElementDataset

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.

Specified by:

getIncrementWhenExpression in interface JRElementDataset

Returns:

the "increment when" expression

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElementDataset

clone

public java.lang.Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class java.lang.Object