Package net.sf.jasperreports.engine.base
Class JRBaseSubreportReturnValue
- java.lang.Object
-
- net.sf.jasperreports.engine.base.JRBaseSubreportReturnValue
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,CommonReturnValue
,JRCloneable
,JRSubreportReturnValue
,VariableReturnValue
- Direct Known Subclasses:
JRDesignSubreportReturnValue
public class JRBaseSubreportReturnValue extends java.lang.Object implements JRSubreportReturnValue, java.io.Serializable
Base implementation ofJRSubreportReturnValue
.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected CalculationEnum
calculationValue
The calculation type.protected java.lang.String
incrementerFactoryClassName
The incrementer factory class name.protected java.lang.String
subreportVariable
The name of the subreport variable to be copied.protected java.lang.String
toVariable
The name of the master variable where the value should be copied.
-
Constructor Summary
Constructors Modifier Constructor Description protected
JRBaseSubreportReturnValue()
protected
JRBaseSubreportReturnValue(JRSubreportReturnValue returnValue, JRBaseObjectFactory factory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CalculationEnum
getCalculation()
Returns the calculation type.java.lang.String
getFromVariable()
Returns the name of the variable whose value should be copied.java.lang.String
getIncrementerFactoryClassName()
Returns the incrementer factory class name.java.lang.String
getToVariable()
Returns the name of the master report variable where the value should be copied.
-
-
-
Field Detail
-
subreportVariable
protected java.lang.String subreportVariable
The name of the subreport variable to be copied.
-
toVariable
protected java.lang.String toVariable
The name of the master variable where the value should be copied.
-
calculationValue
protected CalculationEnum calculationValue
The calculation type.
-
incrementerFactoryClassName
protected java.lang.String incrementerFactoryClassName
The incrementer factory class name.
-
-
Constructor Detail
-
JRBaseSubreportReturnValue
protected JRBaseSubreportReturnValue()
-
JRBaseSubreportReturnValue
protected JRBaseSubreportReturnValue(JRSubreportReturnValue returnValue, JRBaseObjectFactory factory)
-
-
Method Detail
-
getFromVariable
public java.lang.String getFromVariable()
Returns the name of the variable whose value should be copied.- Specified by:
getFromVariable
in interfaceVariableReturnValue
- Returns:
- the name of the variable whose value should be copied.
-
getToVariable
public java.lang.String getToVariable()
Returns the name of the master report variable where the value should be copied.- Specified by:
getToVariable
in interfaceCommonReturnValue
- Returns:
- the name of the master report variable where the value should be copied.
-
getCalculation
public CalculationEnum getCalculation()
Returns the calculation type.When copying the value from the subreport, 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.
-
getIncrementerFactoryClassName
public java.lang.String getIncrementerFactoryClassName()
Returns the incrementer factory class name.The factory will be used to increment the value of the master report variable with the value from the subreport.
- Specified by:
getIncrementerFactoryClassName
in interfaceCommonReturnValue
- Returns:
- the incrementer factory class name.
-
clone
public java.lang.Object clone()
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classjava.lang.Object
-
-