Package net.sf.jasperreports.engine.fill

Class JRFillCommonReturnValue

java.lang.Object

net.sf.jasperreports.engine.fill.JRFillCommonReturnValue

All Implemented Interfaces:

Cloneable, CommonReturnValue, JRCloneable

Direct Known Subclasses:

JRFillExpressionReturnValue, JRFillVariableReturnValue

public abstract class JRFillCommonReturnValue
extends Object
implements CommonReturnValue

Implementation of CommonReturnValue used by the filler.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
protected CalculationEnum	calculation
static String	EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND
protected BaseReportFiller	filler
protected JRIncrementer	incrementer
protected String	incrementerFactoryClassName
protected String	toVariable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRFillCommonReturnValue(CommonReturnValue returnValue, JRFillObjectFactory factory, BaseReportFiller filler)
protected	JRFillCommonReturnValue(JRFillCommonReturnValue fillReturnValue, JRFillCloneFactory factory)	Cloning constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract JRFillCommonReturnValue	addDerivedReturnValue(CommonReturnValue parentReturnValue, List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler)
protected JRFillCommonReturnValue	addReturnValue(JRFillCommonReturnValue returnValue, List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler)
Object	clone()
protected abstract CommonReturnValue	createDistinctCountHelperReturnValue(CommonReturnValue returnValue)
protected abstract CommonReturnValue	createHelperReturnValue(CommonReturnValue returnValue, String nameSuffix, CalculationEnum calculation)
CalculationEnum	getCalculation()	Returns the calculation type.
JRIncrementer	getIncrementer(FillReturnValues.SourceContext sourceContext)	Gets the incrementer to be used for this copied value.
String	getIncrementerFactoryClassName()	Returns the incrementer factory class name.
String	getToVariable()	Returns the name of the report variable where the value should be copied.
boolean	isDerived()
void	setDerived(boolean derived)

Methods inherited from class java.lang.Object

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

Field Detail

EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND

public static final String EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND

See Also:

Constant Field Values

toVariable

protected final String toVariable

incrementerFactoryClassName

protected final String incrementerFactoryClassName

calculation

protected final CalculationEnum calculation

incrementer

protected JRIncrementer incrementer

filler

protected final BaseReportFiller filler

Constructor Detail

JRFillCommonReturnValue

protected JRFillCommonReturnValue(CommonReturnValue returnValue,
                                  JRFillObjectFactory factory,
                                  BaseReportFiller filler)

JRFillCommonReturnValue

protected JRFillCommonReturnValue(JRFillCommonReturnValue fillReturnValue,
                                  JRFillCloneFactory factory)

Cloning constructor.

Parameters:

fillReturnValue - the object to clone

factory - the clone factory

Method Detail

getToVariable

public String getToVariable()

Description copied from interface: CommonReturnValue

Returns the name of the report variable where the value should be copied.

Specified by:

getToVariable in interface CommonReturnValue

Returns:

the name of the report variable where the value should be copied.

getIncrementerFactoryClassName

public String getIncrementerFactoryClassName()

Description copied from interface: CommonReturnValue

Returns the incrementer factory class name.

The factory will be used to increment the value of the report variable with the returned value.

Specified by:

getIncrementerFactoryClassName in interface CommonReturnValue

Returns:

the incrementer factory class name.

getCalculation

public CalculationEnum getCalculation()

Description copied from interface: CommonReturnValue

Returns the calculation type.

When copying the value from, a formula can be applied such that sum, maximum, average and so on can be computed.

Specified by:

getCalculation in interface CommonReturnValue

Returns:

the calculation type.

getIncrementer

public JRIncrementer getIncrementer(FillReturnValues.SourceContext sourceContext)

Gets the incrementer to be used for this copied value.

isDerived

public boolean isDerived()

setDerived

public void setDerived(boolean derived)

addReturnValue

protected JRFillCommonReturnValue addReturnValue(JRFillCommonReturnValue returnValue,
                                                 List<JRFillCommonReturnValue> returnValueList,
                                                 JRFillObjectFactory factory,
                                                 BaseReportFiller filler)

addDerivedReturnValue

protected abstract JRFillCommonReturnValue addDerivedReturnValue(CommonReturnValue parentReturnValue,
                                                                 List<JRFillCommonReturnValue> returnValueList,
                                                                 JRFillObjectFactory factory,
                                                                 BaseReportFiller filler)

createHelperReturnValue

protected abstract CommonReturnValue createHelperReturnValue(CommonReturnValue returnValue,
                                                             String nameSuffix,
                                                             CalculationEnum calculation)

createDistinctCountHelperReturnValue

protected abstract CommonReturnValue createDistinctCountHelperReturnValue(CommonReturnValue returnValue)

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object