Package net.sf.jasperreports.charts.fill

Class JRFillHighLowDataset

java.lang.Object

net.sf.jasperreports.engine.fill.JRFillElementDataset

net.sf.jasperreports.charts.fill.JRFillChartDataset

net.sf.jasperreports.charts.fill.JRFillHighLowDataset

All Implemented Interfaces:

Cloneable, JRChartDataset, JRHighLowDataset, DatasetRunHolder, JRCloneable, JRElementDataset

public class JRFillHighLowDataset
extends JRFillChartDataset
implements JRHighLowDataset

Author:

Ionut Nedelcu (ionutned@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_CLOSE_VALUE
static final String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_DATE_VALUE
static final String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_HIGH_VALUE
static final String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_LOW_VALUE
static final String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_OPEN_VALUE
static final String	EXCEPTION_MESSAGE_KEY_SERIES_NULL_VOLUME_VALUE

Fields inherited from class net.sf.jasperreports.engine.fill.JRFillElementDataset

datasetRun, incrementGroup, parent, 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
JRFillHighLowDataset(JRHighLowDataset dataset, ChartsFillObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
void	collectExpressions(ChartsExpressionCollector collector)
void	collectExpressions(JRExpressionCollector collector)
protected void	customEvaluate(JRCalculator calculator)	Evaluates the expressions associated with the dataset.
protected void	customIncrement()	Increments the dataset by collecting the result of the expression evaluation.
protected void	customInitialize()	Initializes the element dataset.
protected void	evaluateSectionHyperlink(JRCalculator calculator)
JRExpression	getCloseExpression()
org.jfree.data.general.Dataset	getCustomDataset()
byte	getDatasetType()	Gets the dataset type.
JRExpression	getDateExpression()
JRExpression	getHighExpression()
JRHyperlink	getItemHyperlink()	Returns the hyperlink specification for chart items.
List<JRPrintHyperlink>	getItemHyperlinks()
Object	getLabelGenerator()
JRExpression	getLowExpression()
JRExpression	getOpenExpression()
JRExpression	getSeriesExpression()
JRExpression	getVolumeExpression()
boolean	hasItemHyperlink()
void	validate(ChartsVerifier verifier)	Validates the dataset using a verifier.

Methods inherited from class net.sf.jasperreports.charts.fill.JRFillChartDataset

getDataset

Methods inherited from class net.sf.jasperreports.engine.fill.JRFillElementDataset

clone, evaluate, evaluateDatasetRun, evaluateIncrementWhenExpression, getDatasetResetType, getDatasetRun, getFillDataset, getFiller, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getInputDataset, getLocale, getResetGroup, getTimeZone, increment, initialize, setBand

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

clone

Methods inherited from interface net.sf.jasperreports.engine.JRElementDataset

getDatasetResetType, getDatasetRun, getIncrementGroup, getIncrementType, getIncrementWhenExpression, getResetGroup

Field Details

EXCEPTION_MESSAGE_KEY_SERIES_NULL_CLOSE_VALUE

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_CLOSE_VALUE

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_SERIES_NULL_DATE_VALUE

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_DATE_VALUE

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_SERIES_NULL_HIGH_VALUE

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_HIGH_VALUE

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_SERIES_NULL_LOW_VALUE

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_LOW_VALUE

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_SERIES_NULL_OPEN_VALUE

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_OPEN_VALUE

See Also:

• Constant Field Values

EXCEPTION_MESSAGE_KEY_SERIES_NULL_VOLUME_VALUE

public static final String EXCEPTION_MESSAGE_KEY_SERIES_NULL_VOLUME_VALUE

See Also:

• Constant Field Values

Constructor Details

JRFillHighLowDataset

public JRFillHighLowDataset(JRHighLowDataset dataset,
 ChartsFillObjectFactory factory)

Method Details

customInitialize

protected void customInitialize()

Description copied from class: JRFillElementDataset

Initializes the element dataset.

The dataset is initialized before being used and after each time the dataset gets reset.

Specified by:

customInitialize in class JRFillElementDataset

See Also:

• JRFillElementDataset.getDatasetResetType()

customEvaluate

protected void customEvaluate(JRCalculator calculator)
                       throws JRExpressionEvalException

Description copied from class: JRFillElementDataset

Evaluates the expressions associated with the dataset.

Usually, the result of the evaluation would be preserved so that it is used in JRFillElementDataset.customIncrement()

Specified by:

customEvaluate in class JRFillElementDataset

Parameters:

calculator - used to evaluate expressions

Throws:

JRExpressionEvalException - any exception that occurs while evaluating expressions

evaluateSectionHyperlink

protected void evaluateSectionHyperlink(JRCalculator calculator)
                                 throws JRExpressionEvalException

Throws:

JRExpressionEvalException

customIncrement

protected void customIncrement()

Description copied from class: JRFillElementDataset

Increments the dataset by collecting the result of the expression evaluation.

Specified by:

customIncrement in class JRFillElementDataset

getCustomDataset

public org.jfree.data.general.Dataset getCustomDataset()

Specified by:

getCustomDataset in class JRFillChartDataset

getLabelGenerator

public Object getLabelGenerator()

Specified by:

getLabelGenerator in class JRFillChartDataset

getSeriesExpression

public JRExpression getSeriesExpression()

Specified by:

getSeriesExpression in interface JRHighLowDataset

Returns:

the expression of the series name. Currently only one series is supported inside a High-Low or Candlestick chart. This limitation is documented inside JFreeChart, the library used for the built-in chart support. However, this single series must be identified by a java.lang.Comparable value returned by this expression, and it must also be used as the series name in the chart's legend.

getDateExpression

public JRExpression getDateExpression()

Specified by:

getDateExpression in interface JRHighLowDataset

Returns:

the expression of the date to which the current (high, low, open, close, volume) item refers.

getHighExpression

public JRExpression getHighExpression()

Specified by:

getHighExpression in interface JRHighLowDataset

Returns:

a numeric expression that will be part of the data item added to the series when the dataset gets incremented.

getLowExpression

public JRExpression getLowExpression()

Specified by:

getLowExpression in interface JRHighLowDataset

Returns:

a numeric expression that will be part of the data item added to the series when the dataset gets incremented.

getOpenExpression

public JRExpression getOpenExpression()

Specified by:

getOpenExpression in interface JRHighLowDataset

Returns:

a numeric expression that will be part of the data item added to the series when the dataset gets incremented.

getCloseExpression

public JRExpression getCloseExpression()

Specified by:

getCloseExpression in interface JRHighLowDataset

Returns:

a numeric expression that will be part of the data item added to the series when the dataset gets incremented.

getVolumeExpression

public JRExpression getVolumeExpression()

Specified by:

getVolumeExpression in interface JRHighLowDataset

Returns:

a numeric expression representing the volume value to use for the current data item. It is used only for Candlestick charts.

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

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElementDataset

collectExpressions

public void collectExpressions(ChartsExpressionCollector collector)

Specified by:

collectExpressions in interface JRChartDataset

getItemHyperlink

public JRHyperlink getItemHyperlink()

Description copied from interface: JRHighLowDataset

Returns the hyperlink specification for chart items.

The hyperlink will be evaluated for every chart item and a image map will be created for the chart.

Specified by:

getItemHyperlink in interface JRHighLowDataset

Returns:

hyperlink specification for chart items

hasItemHyperlink

public boolean hasItemHyperlink()

getItemHyperlinks

public List<JRPrintHyperlink> getItemHyperlinks()

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