Package net.sf.jasperreports.charts.design

Class JRDesignPieDataset

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

All Implemented Interfaces:

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

public class JRDesignPieDataset
extends JRDesignChartDataset
implements JRPieDataset

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRExpression	otherKeyExpression
protected JRExpression	otherLabelExpression
static final String	PROPERTY_KEY_EXPRESSION
static final String	PROPERTY_LABEL_EXPRESSION
static final String	PROPERTY_MAX_COUNT
static final String	PROPERTY_MIN_PERCENTAGE
static final String	PROPERTY_OTHER_KEY_EXPRESSION
static final String	PROPERTY_OTHER_LABEL_EXPRESSION
static final String	PROPERTY_OTHER_SECTION_HYPERLINK
static final String	PROPERTY_PIE_SERIES
static final String	PROPERTY_SECTION_HYPERLINK
static final String	PROPERTY_VALUE_EXPRESSION

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

Fields inherited from interface net.sf.jasperreports.charts.JRPieDataset

PROPERTY_IGNORE_DUPLICATED_KEY

Constructor Summary

Constructors

Constructor	Description
JRDesignPieDataset(JRChartDataset dataset)

Method Summary

Modifier and Type	Method	Description
void	addPieSeries(int index, JRPieSeries pieSeries)
void	addPieSeries(JRPieSeries pieSeries)
Object	clone()
void	collectExpressions(ChartsExpressionCollector collector)
void	collectExpressions(JRExpressionCollector collector)
byte	getDatasetType()	Gets the dataset type.
Integer	getMaxCount()
Float	getMinPercentage()
JRExpression	getOtherKeyExpression()
JRExpression	getOtherLabelExpression()
JRHyperlink	getOtherSectionHyperlink()	Returns the hyperlink specification for the special Other chart section, if present.
JRPieSeries[]	getSeries()
List<JRPieSeries>	getSeriesList()
JRPieSeries	removePieSeries(JRPieSeries pieSeries)
void	setKeyExpression(JRExpression keyExpression)	This is a convenient way to set key expression in the first series.
void	setLabelExpression(JRExpression labelExpression)	This is a convenient way to set label expression in the first series.
void	setMaxCount(Integer maxCount)
void	setMinPercentage(Float minPercentage)
void	setOtherKeyExpression(JRExpression otherKeyExpression)
void	setOtherLabelExpression(JRExpression otherLabelExpression)
void	setOtherSectionHyperlink(JRHyperlink otherSectionHyperlink)
void	setSectionHyperlink(JRHyperlink sectionHyperlink)	This is a convenient way to set the section hyperlink in the first series.
void	setValueExpression(JRExpression valueExpression)	This is a convenient way to set value expression in the first series.
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 Details

PROPERTY_MIN_PERCENTAGE

public static final String PROPERTY_MIN_PERCENTAGE

See Also:

• Constant Field Values

PROPERTY_MAX_COUNT

public static final String PROPERTY_MAX_COUNT

See Also:

• Constant Field Values

PROPERTY_PIE_SERIES

public static final String PROPERTY_PIE_SERIES

See Also:

• Constant Field Values

PROPERTY_KEY_EXPRESSION

public static final String PROPERTY_KEY_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_VALUE_EXPRESSION

public static final String PROPERTY_VALUE_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_LABEL_EXPRESSION

public static final String PROPERTY_LABEL_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_SECTION_HYPERLINK

public static final String PROPERTY_SECTION_HYPERLINK

See Also:

• Constant Field Values

PROPERTY_OTHER_KEY_EXPRESSION

public static final String PROPERTY_OTHER_KEY_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_OTHER_LABEL_EXPRESSION

public static final String PROPERTY_OTHER_LABEL_EXPRESSION

See Also:

• Constant Field Values

PROPERTY_OTHER_SECTION_HYPERLINK

public static final String PROPERTY_OTHER_SECTION_HYPERLINK

See Also:

• Constant Field Values

otherKeyExpression

protected JRExpression otherKeyExpression

otherLabelExpression

protected JRExpression otherLabelExpression

Constructor Details

JRDesignPieDataset

public JRDesignPieDataset(JRChartDataset dataset)

Method Details

getMinPercentage

public Float getMinPercentage()

Specified by:

getMinPercentage in interface JRPieDataset

setMinPercentage

public void setMinPercentage(Float minPercentage)

Specified by:

setMinPercentage in interface JRPieDataset

getMaxCount

public Integer getMaxCount()

Specified by:

getMaxCount in interface JRPieDataset

setMaxCount

public void setMaxCount(Integer maxCount)

Specified by:

setMaxCount in interface JRPieDataset

getSeries

public JRPieSeries[] getSeries()

Specified by:

getSeries in interface JRPieDataset

Returns:

an array of JRPieSeries objects representing the series for the Pie chart

See Also:

• JRPieSeries

getSeriesList

public List<JRPieSeries> getSeriesList()

addPieSeries

public void addPieSeries(JRPieSeries pieSeries)

addPieSeries

public void addPieSeries(int index,
 JRPieSeries pieSeries)

removePieSeries

public JRPieSeries removePieSeries(JRPieSeries pieSeries)

setKeyExpression

public void setKeyExpression(JRExpression keyExpression)

This is a convenient way to set key expression in the first series. It is used by the JRXML parser when there is a single series in the pie dataset.

setValueExpression

public void setValueExpression(JRExpression valueExpression)

This is a convenient way to set value expression in the first series. It is used by the JRXML parser when there is a single series in the pie dataset.

setLabelExpression

public void setLabelExpression(JRExpression labelExpression)

This is a convenient way to set label expression in the first series. It is used by the JRXML parser when there is a single series in the pie dataset.

setSectionHyperlink

public void setSectionHyperlink(JRHyperlink sectionHyperlink)

This is a convenient way to set the section hyperlink in the first series. It is used by the JRXML parser when there is a single series in the pie dataset.

getOtherKeyExpression

public JRExpression getOtherKeyExpression()

Specified by:

getOtherKeyExpression in interface JRPieDataset

setOtherKeyExpression

public void setOtherKeyExpression(JRExpression otherKeyExpression)

getOtherLabelExpression

public JRExpression getOtherLabelExpression()

Specified by:

getOtherLabelExpression in interface JRPieDataset

setOtherLabelExpression

public void setOtherLabelExpression(JRExpression otherLabelExpression)

getOtherSectionHyperlink

public JRHyperlink getOtherSectionHyperlink()

Description copied from interface: JRPieDataset

Returns the hyperlink specification for the special Other chart section, if present.

Specified by:

getOtherSectionHyperlink in interface JRPieDataset

Returns:

hyperlink specification for the Other chart section

setOtherSectionHyperlink

public void setOtherSectionHyperlink(JRHyperlink otherSectionHyperlink)

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 interface JRChartDataset

Overrides:

getDatasetType in class JRDesignChartDataset

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElementDataset

Overrides:

collectExpressions in class JRBaseElementDataset

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