net.sf.jasperreports.engine

Class JRAbstractChartCustomizer

java.lang.Object

net.sf.jasperreports.engine.JRAbstractChartCustomizer

All Implemented Interfaces:

JRChartCustomizer, NamedChartCustomizer

public abstract class JRAbstractChartCustomizer
extends Object
implements NamedChartCustomizer

Abstract implementation of JRChartCustomizer that provides access to parameter, variable and field values.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected JRFillChart	chart
protected JRBaseFiller	filler

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

CUSTOMIZER_CLASS_PROPERTY_PREFIX, CUSTOMIZER_PROPERTY_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRAbstractChartCustomizer() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getBooleanProperty(String propertySuffix)
String	getCustomizerPropertyName(String propertySuffix)
Double	getDoubleProperty(String propertySuffix)
protected Object	getFieldValue(String fieldName) Returns the value of a report field.
protected Object	getFieldValue(String fieldName, boolean fromInputDataset) Returns the value of a report or input dataset field.
Float	getFloatProperty(String propertySuffix)
Integer	getIntegerProperty(String propertySuffix)
protected Object	getParameterValue(String parameterName) Returns the value of a report parameter.
protected Object	getParameterValue(String parameterName, boolean fromInputDataset) Returns the value of a report or input dataset parameter.
String	getProperty(String propertySuffix)
protected Object	getVariableValue(String variableName) Returns the value of a report variable.
protected Object	getVariableValue(String variableName, boolean fromInputDataset) Returns the value of a report or input dataset variable.
void	init(JRBaseFiller chartFiller, JRFillChart chart) Deprecated. Replaced by init(JRFillChart).
void	init(JRFillChart chart) Initializes the chart customizer.
void	setName(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

customize

Field Detail

chart

protected JRFillChart chart

filler

protected JRBaseFiller filler

Constructor Detail

JRAbstractChartCustomizer

protected JRAbstractChartCustomizer()

Default constructor.

Method Detail

init

public void init(JRBaseFiller chartFiller,
        JRFillChart chart)

Deprecated. Replaced by init(JRFillChart).

init

public void init(JRFillChart chart)

Initializes the chart customizer.

Parameters:

chart - the fill chart 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

setName

public void setName(String name)

Specified by:

setName in interface NamedChartCustomizer

getCustomizerPropertyName

public final String getCustomizerPropertyName(String propertySuffix)

getBooleanProperty

public final Boolean getBooleanProperty(String propertySuffix)

getProperty

public final String getProperty(String propertySuffix)

getIntegerProperty

public final Integer getIntegerProperty(String propertySuffix)

getFloatProperty

public final Float getFloatProperty(String propertySuffix)

getDoubleProperty

public final Double getDoubleProperty(String propertySuffix)