Package net.sf.jasperreports.charts.design

Class JRDesignValueDataset

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElementDataset

net.sf.jasperreports.engine.design.JRDesignElementDataset

net.sf.jasperreports.charts.design.JRDesignChartDataset

net.sf.jasperreports.charts.design.JRDesignValueDataset

All Implemented Interfaces:

Serializable, Cloneable, JRChartDataset, JRValueDataset, DatasetRunHolder, JRChangeEventsSupport, JRCloneable, JRElementDataset

public class JRDesignValueDataset
extends JRDesignChartDataset
implements JRValueDataset

A data set that contains a single value. A value dataset is suitable for using with charts that show a single value against a potential range, such as meter chart or a thermometer chart.

Author:

Barry Klawans (bklawans@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_VALUE_EXPRESSION
protected JRExpression	valueExpression	The expression that returns the single value contained in this dataset.

Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElementDataset

PROPERTY_DATASET_RESET_TYPE, PROPERTY_DATASET_RUN, PROPERTY_INCREMENT_GROUP, PROPERTY_INCREMENT_TYPE, PROPERTY_INCREMENT_WHEN_EXPRESSION, PROPERTY_RESET_GROUP, PROPERTY_RESET_TYPE

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElementDataset

datasetResetType, datasetRun, incrementGroup, incrementType, incrementWhenExpression, 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
JRDesignValueDataset(JRChartDataset dataset)	Construct a new dataset that is a copy of an existing one.

Method Summary

Modifier and Type	Method	Description
Object	clone()
void	collectExpressions(ChartsExpressionCollector collector)
void	collectExpressions(JRExpressionCollector collector)	Adds all the expression used by this plot with the specified collector.
byte	getDatasetType()	Returns the type of this dataset.
JRExpression	getValueExpression()	Returns the expression that indicates the value held by this dataset.
void	setValueExpression(JRExpression valueExpression)	Sets the expression that indicates the value held by this dataset.
void	validate(ChartsVerifier verifier)	Validates the dataset using a verifier.

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElementDataset

getEventSupport, setDatasetRun, setIncrementGroup, setIncrementType, setIncrementWhenExpression, setResetGroup, setResetType

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElementDataset

getDatasetResetType, getDatasetRun, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getResetGroup

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.JRElementDataset

getDatasetResetType, getDatasetRun, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getResetGroup

Field Detail

PROPERTY_VALUE_EXPRESSION

public static final String PROPERTY_VALUE_EXPRESSION

See Also:

Constant Field Values

valueExpression

protected JRExpression valueExpression

The expression that returns the single value contained in this dataset.

Constructor Detail

JRDesignValueDataset

public JRDesignValueDataset(JRChartDataset dataset)

Construct a new dataset that is a copy of an existing one.

Parameters:

dataset - the dataset to copy

Method Detail

getValueExpression

public JRExpression getValueExpression()

Description copied from interface: JRValueDataset

Returns the expression that indicates the value held by this dataset.

Specified by:

getValueExpression in interface JRValueDataset

Returns:

the expression that indicates the value held by this dataset

setValueExpression

public void setValueExpression(JRExpression valueExpression)

Sets the expression that indicates the value held by this dataset.

Parameters:

valueExpression - the expression that returns the value held by this dataset

getDatasetType

public byte getDatasetType()

Returns the type of this dataset.

Specified by:

getDatasetType in interface JRChartDataset

Overrides:

getDatasetType in class JRDesignChartDataset

Returns:

the type of this dataset - always VALUE_DATASET

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Adds all the expression used by this plot with the specified collector. All collected expression that are also registered with a factory will be included with the report is compiled.

Specified by:

collectExpressions in interface JRElementDataset

Overrides:

collectExpressions in class JRBaseElementDataset

Parameters:

collector - the expression collector to use

collectExpressions

public void collectExpressions(ChartsExpressionCollector collector)

Specified by:

collectExpressions in interface JRChartDataset

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

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRDesignElementDataset