Package net.sf.jasperreports.engine.fill
Class JRFillCommonReturnValue
- java.lang.Object
-
- net.sf.jasperreports.engine.fill.JRFillCommonReturnValue
-
- All Implemented Interfaces:
java.lang.Cloneable
,CommonReturnValue
,JRCloneable
- Direct Known Subclasses:
JRFillExpressionReturnValue
,JRFillVariableReturnValue
public abstract class JRFillCommonReturnValue extends java.lang.Object implements CommonReturnValue
Implementation ofCommonReturnValue
used by the filler.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description protected CalculationEnum
calculation
static java.lang.String
EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND
protected BaseReportFiller
filler
protected JRIncrementer
incrementer
protected java.lang.String
incrementerFactoryClassName
protected java.lang.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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract JRFillCommonReturnValue
addDerivedReturnValue(CommonReturnValue parentReturnValue, java.util.List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler)
protected JRFillCommonReturnValue
addReturnValue(JRFillCommonReturnValue returnValue, java.util.List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler)
java.lang.Object
clone()
protected abstract CommonReturnValue
createDistinctCountHelperReturnValue(CommonReturnValue returnValue)
protected abstract CommonReturnValue
createHelperReturnValue(CommonReturnValue returnValue, java.lang.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.java.lang.String
getIncrementerFactoryClassName()
Returns the incrementer factory class name.java.lang.String
getToVariable()
Returns the name of the report variable where the value should be copied.boolean
isDerived()
void
setDerived(boolean derived)
-
-
-
Field Detail
-
EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND
public static final java.lang.String EXCEPTION_MESSAGE_KEY_INCREMENTER_CLASS_NOT_FOUND
- See Also:
- Constant Field Values
-
toVariable
protected final java.lang.String toVariable
-
incrementerFactoryClassName
protected final java.lang.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 clonefactory
- the clone factory
-
-
Method Detail
-
getToVariable
public java.lang.String 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
public java.lang.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 interfaceCommonReturnValue
- 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 interfaceCommonReturnValue
- 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, java.util.List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler)
-
addDerivedReturnValue
protected abstract JRFillCommonReturnValue addDerivedReturnValue(CommonReturnValue parentReturnValue, java.util.List<JRFillCommonReturnValue> returnValueList, JRFillObjectFactory factory, BaseReportFiller filler)
-
createHelperReturnValue
protected abstract CommonReturnValue createHelperReturnValue(CommonReturnValue returnValue, java.lang.String nameSuffix, CalculationEnum calculation)
-
createDistinctCountHelperReturnValue
protected abstract CommonReturnValue createDistinctCountHelperReturnValue(CommonReturnValue returnValue)
-
clone
public java.lang.Object clone()
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classjava.lang.Object
-
-