Package net.sf.jasperreports.charts.base
Class JRBaseValueDataset
- java.lang.Object
-
- net.sf.jasperreports.engine.base.JRBaseElementDataset
-
- net.sf.jasperreports.charts.base.JRBaseChartDataset
-
- net.sf.jasperreports.charts.base.JRBaseValueDataset
-
- All Implemented Interfaces:
Serializable
,Cloneable
,JRChartDataset
,JRValueDataset
,DatasetRunHolder
,JRCloneable
,JRElementDataset
public class JRBaseValueDataset extends JRBaseChartDataset implements JRValueDataset
An immutable version of a dataset that generates 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 protected JRExpression
valueExpression
The expression that returns the single value contained in this dataset.-
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 JRBaseValueDataset(JRChartDataset dataset)
Construct a new dataset that is a copy of an existing one.JRBaseValueDataset(JRValueDataset dataset, ChartsBaseObjectFactory factory)
Constructs a new dataset that is a copy of an existing one, and register all of the new dataset's expressions with the specified factory.
-
Method Summary
All Methods Instance Methods Concrete Methods 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()
Gets the dataset type.JRExpression
getValueExpression()
Returns 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.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
-
valueExpression
protected JRExpression valueExpression
The expression that returns the single value contained in this dataset.
-
-
Constructor Detail
-
JRBaseValueDataset
public JRBaseValueDataset(JRChartDataset dataset)
Construct a new dataset that is a copy of an existing one.- Parameters:
dataset
- the dataset to copy
-
JRBaseValueDataset
public JRBaseValueDataset(JRValueDataset dataset, ChartsBaseObjectFactory factory)
Constructs a new dataset that is a copy of an existing one, and register all of the new dataset's expressions with the specified factory.- Parameters:
dataset
- the datast to copyfactory
- the factory to register the new dataset's expressions with
-
-
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 interfaceJRValueDataset
- Returns:
- the expression that indicates the value held by this dataset
-
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 interfaceJRChartDataset
-
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 interfaceJRElementDataset
- Overrides:
collectExpressions
in classJRBaseElementDataset
- Parameters:
collector
- the expression collector to use
-
collectExpressions
public void collectExpressions(ChartsExpressionCollector collector)
- Specified by:
collectExpressions
in interfaceJRChartDataset
-
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 interfaceJRChartDataset
- Parameters:
verifier
- the verifier to use for validation
-
clone
public Object clone()
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classJRBaseElementDataset
-
-