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
Implementation of
CommonReturnValue
used by the filler.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final CalculationEnum
static final String
protected final BaseReportFiller
protected JRIncrementer
protected final String
protected final String
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
JRFillCommonReturnValue
(CommonReturnValue returnValue, JRFillObjectFactory factory, BaseReportFiller filler) protected
JRFillCommonReturnValue
(JRFillCommonReturnValue fillReturnValue, JRFillCloneFactory factory) Cloning constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract JRFillCommonReturnValue
addDerivedReturnValue
(CommonReturnValue parentReturnValue, List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler) protected JRFillCommonReturnValue
addReturnValue
(JRFillCommonReturnValue returnValue, List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler) clone()
protected abstract CommonReturnValue
createDistinctCountHelperReturnValue
(CommonReturnValue returnValue) protected abstract CommonReturnValue
createHelperReturnValue
(CommonReturnValue returnValue, String nameSuffix, CalculationEnum calculation) Returns the calculation type.getIncrementer
(FillReturnValues.SourceContext sourceContext) Gets the incrementer to be used for this copied value.Returns the incrementer factory class name.Returns the name of the report variable where the value should be copied.boolean
void
setDerived
(boolean derived)
-
Field Details
-
EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND
- See Also:
-
toVariable
-
incrementerFactoryClassName
-
calculation
-
incrementer
-
filler
-
-
Constructor Details
-
JRFillCommonReturnValue
protected JRFillCommonReturnValue(CommonReturnValue returnValue, JRFillObjectFactory factory, BaseReportFiller filler) -
JRFillCommonReturnValue
protected JRFillCommonReturnValue(JRFillCommonReturnValue fillReturnValue, JRFillCloneFactory factory) Cloning constructor.- Parameters:
fillReturnValue
- the object to clonefactory
- the clone factory
-
-
Method Details
-
getToVariable
Description copied from interface:CommonReturnValue
Returns the name of the report variable where the value should be copied.- Specified by:
getToVariable
in interfaceCommonReturnValue
- Returns:
- the name of the report variable where the value should be copied.
-
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 interfaceCommonReturnValue
- Returns:
- the incrementer factory class name.
-
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 interfaceCommonReturnValue
- Returns:
- the calculation type.
-
getIncrementer
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
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classObject
-