Package net.sf.jasperreports.charts.design

Class JRDesignHighLowDataset

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.JRDesignHighLowDataset
All Implemented Interfaces:
Serializable, Cloneable, JRChartDataset, JRHighLowDataset, DatasetRunHolder, JRChangeEventsSupport, JRCloneable, JRElementDataset
public class JRDesignHighLowDataset extends JRDesignChartDataset implements JRHighLowDataset
Author:
Ionut Nedelcu (ionutned@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

    • JRDesignHighLowDataset

      public JRDesignHighLowDataset(JRChartDataset dataset)

  • Method Details

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

    • setSeriesExpression

      public void setSeriesExpression(JRExpression seriesExpression)

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

    • setDateExpression

      public void setDateExpression(JRExpression dateExpression)

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

    • setHighExpression

      public void setHighExpression(JRExpression highExpression)

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

    • setLowExpression

      public void setLowExpression(JRExpression lowExpression)

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

    • setOpenExpression

      public void setOpenExpression(JRExpression openExpression)

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

    • setCloseExpression

      public void setCloseExpression(JRExpression closeExpression)

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

    • setVolumeExpression

      public void setVolumeExpression(JRExpression volumeExpression)

    • 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

    • 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

    • setItemHyperlink

      public void setItemHyperlink(JRHyperlink itemHyperlink)
      Sets the hyperlink specification for chart items.
      Parameters:
      itemHyperlink - the hyperlink specification
      See Also:

    • 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