net.sf.jasperreports.charts.base

Class JRBaseHighLowDataset

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElementDataset

net.sf.jasperreports.engine.base.JRBaseChartDataset

net.sf.jasperreports.charts.base.JRBaseHighLowDataset

All Implemented Interfaces:

Serializable, Cloneable, JRHighLowDataset, JRChartDataset, JRCloneable, JRElementDataset

public class JRBaseHighLowDataset
extends JRBaseChartDataset
implements JRHighLowDataset

Author:

Ionut Nedelcu (ionutned@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected JRExpression	closeExpression
protected JRExpression	dateExpression
protected JRExpression	highExpression
protected JRExpression	lowExpression
protected JRExpression	openExpression
protected JRExpression	seriesExpression
protected JRExpression	volumeExpression

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

datasetRun, incrementGroup, incrementTypeValue, incrementWhenExpression, resetGroup, resetTypeValue

Fields inherited from interface net.sf.jasperreports.engine.JRChartDataset

CATEGORY_DATASET, GANTT_DATASET, HIGHLOW_DATASET, PIE_DATASET, TIMEPERIOD_DATASET, TIMESERIES_DATASET, VALUE_DATASET, XY_DATASET, XYZ_DATASET

Constructor Summary

Constructors

Constructor and Description
JRBaseHighLowDataset(JRChartDataset dataset)
JRBaseHighLowDataset(JRHighLowDataset dataset, JRBaseObjectFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
void	collectExpressions(JRExpressionCollector collector)
JRExpression	getCloseExpression()
byte	getDatasetType() Gets the dataset type.
JRExpression	getDateExpression()
JRExpression	getHighExpression()
JRHyperlink	getItemHyperlink() Returns the hyperlink specification for chart items.
JRExpression	getLowExpression()
JRExpression	getOpenExpression()
JRExpression	getSeriesExpression()
JRExpression	getVolumeExpression()
void	validate(JRVerifier verifier) Validates the dataset using a verifier.

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

getDatasetRun, getIncrementGroup, getIncrementTypeValue, getIncrementWhenExpression, getResetGroup, getResetTypeValue

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

getDatasetRun, getIncrementGroup, getIncrementTypeValue, getIncrementWhenExpression, getResetGroup, getResetTypeValue

Field Detail

seriesExpression

protected JRExpression seriesExpression

dateExpression

protected JRExpression dateExpression

highExpression

protected JRExpression highExpression

lowExpression

protected JRExpression lowExpression

openExpression

protected JRExpression openExpression

closeExpression

protected JRExpression closeExpression

volumeExpression

protected JRExpression volumeExpression

Constructor Detail

JRBaseHighLowDataset

public JRBaseHighLowDataset(JRChartDataset dataset)

JRBaseHighLowDataset

public JRBaseHighLowDataset(JRHighLowDataset dataset,
                    JRBaseObjectFactory factory)

Method Detail

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

Overrides:

collectExpressions in class JRBaseElementDataset

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

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

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseElementDataset