Package net.sf.jasperreports.components.charts

Class AbstractChartCustomizer

java.lang.Object
net.sf.jasperreports.components.charts.AbstractChartCustomizer
All Implemented Interfaces:
ChartCustomizer
public abstract class AbstractChartCustomizer extends Object implements ChartCustomizer
Abstract implementation of ChartCustomizer that provides access to parameter, variable and field values.
Author:
Sanda Zaharia (shertage@users.sourceforge.net)

  • Constructor Details

    • AbstractChartCustomizer

      protected AbstractChartCustomizer()
      Default constructor.

  • Method Details

    • init

      public void init(JRBaseFiller chartFiller, JRFillElementDataset dataset)
      Initializes the chart customizer.
      Parameters:
      chartFiller - the filler instance
      dataset - the fill dataset object

    • getParameterValue

      protected final Object getParameterValue(String parameterName)
      Returns the value of a report parameter.
      Parameters:
      parameterName - the parameter name
      Returns:
      the value of a report parameter

    • getParameterValue

      protected final Object getParameterValue(String parameterName, boolean fromInputDataset)
      Returns the value of a report or input dataset parameter.

      The input dataset differs from the report dataset when the chart uses a sub dataset as input.

      Parameters:
      parameterName - the parameter name
      fromInputDataset - whether the parameter belongs to the input dataset rather than the report.

      This is usefull only when the chart uses a sub dataset as input.

      Returns:
      the value of the parameter

    • getVariableValue

      protected final Object getVariableValue(String variableName)
      Returns the value of a report variable.
      Parameters:
      variableName - the variable name
      Returns:
      the value of a report variable

    • getVariableValue

      protected final Object getVariableValue(String variableName, boolean fromInputDataset)
      Returns the value of a report or input dataset variable.

      The input dataset differs from the report dataset when the chart uses a sub dataset as input.

      Parameters:
      variableName - the variable name
      fromInputDataset - whether the variable belongs to the input dataset rather than the report.

      This is usefull only when the chart uses a sub dataset as input.

      Returns:
      the value of the variable

    • getFieldValue

      protected final Object getFieldValue(String fieldName)
      Returns the value of a report field.
      Parameters:
      fieldName - the field name
      Returns:
      the value of a report field

    • getFieldValue

      protected final Object getFieldValue(String fieldName, boolean fromInputDataset)
      Returns the value of a report or input dataset field.

      The input dataset differs from the report dataset when the chart uses a sub dataset as input.

      Parameters:
      fieldName - the field name
      fromInputDataset - whether the field belongs to the input dataset rather than the report.

      This is usefull only when the chart uses a sub dataset as input.

      Returns:
      the value of the field

    • getFiller

      public JRBaseFiller getFiller()
      Returns:
      the filler

    • setFiller

      public void setFiller(JRBaseFiller filler)
      Parameters:
      filler - the filler to set

    • getChartDataset

      public JRFillElementDataset getChartDataset()
      Returns:
      the chartDataset

    • setChartDataset

      public void setChartDataset(JRFillElementDataset chartDataset)
      Parameters:
      chartDataset - the chartDataset to set