net.sf.jasperreports.charts.design
Class JRDesignValueDataset

java.lang.Object
  extended by net.sf.jasperreports.engine.base.JRBaseElementDataset
      extended by net.sf.jasperreports.engine.design.JRDesignElementDataset
          extended by net.sf.jasperreports.engine.design.JRDesignChartDataset
              extended by net.sf.jasperreports.charts.design.JRDesignValueDataset
All Implemented Interfaces:
java.io.Serializable, JRValueDataset, JRChartDataset, 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.

Version:
$Id: JRDesignValueDataset.java 1386 2006-09-06 00:33:02 +0300 (Wed, 06 Sep 2006) bklawans $
Author:
Barry Klawans (bklawans@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  JRExpression valueExpression
          The expression that returns the single value contained in this dataset.
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElementDataset
datasetRun, incrementGroup, incrementType, incrementWhenExpression, resetGroup, resetType
 
Fields inherited from interface net.sf.jasperreports.engine.JRChartDataset
CATEGORY_DATASET, HIGHLOW_DATASET, PIE_DATASET, TIMEPERIOD_DATASET, TIMESERIES_DATASET, VALUE_DATASET, XY_DATASET, XYZ_DATASET
 
Constructor Summary
JRDesignValueDataset(JRChartDataset dataset)
          Construct a new dataset that is a copy of an existing one.
 
Method Summary
 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(JRVerifier verifier)
          Validates the dataset using a verifier.
 
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElementDataset
setDatasetRun, setIncrementGroup, setIncrementType, setIncrementWhenExpression, setResetGroup, setResetType
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElementDataset
getDatasetRun, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getResetGroup, getResetType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.jasperreports.engine.JRElementDataset
getDatasetRun, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getResetGroup, getResetType
 

Field Detail

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 JRChartDataset.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
Parameters:
collector - the expression collector to use

validate

public void validate(JRVerifier 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


© 2001-2006 JasperSoft Corporation www.jaspersoft.com