net.sf.jasperreports.engine.base

Class JRBaseSubreportReturnValue

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseSubreportReturnValue

All Implemented Interfaces:

Serializable, Cloneable, CommonReturnValue, JRCloneable, JRSubreportReturnValue, VariableReturnValue

Direct Known Subclasses:

JRDesignSubreportReturnValue

public class JRBaseSubreportReturnValue
extends Object
implements JRSubreportReturnValue, Serializable

Base implementation of JRSubreportReturnValue.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CalculationEnum	calculationValue The calculation type.
protected String	incrementerFactoryClassName The incrementer factory class name.
protected String	subreportVariable The name of the subreport variable to be copied.
protected String	toVariable The name of the master variable where the value should be copied.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRBaseSubreportReturnValue()
protected	JRBaseSubreportReturnValue(JRSubreportReturnValue returnValue, JRBaseObjectFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
CalculationEnum	getCalculation() Returns the calculation type.
CalculationEnum	getCalculationValue() Deprecated. Replaced by getCalculation().
String	getFromVariable() Returns the name of the variable whose value should be copied.
String	getIncrementerFactoryClassName() Returns the incrementer factory class name.
String	getSubreportVariable() Deprecated. Replaced by getFromVariable().
String	getToVariable() Returns the name of the master report variable where the value should be copied.

Methods inherited from class java.lang.Object

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

Field Detail

subreportVariable

protected String subreportVariable

The name of the subreport variable to be copied.

toVariable

protected String toVariable

The name of the master variable where the value should be copied.

calculationValue

protected CalculationEnum calculationValue

The calculation type.

incrementerFactoryClassName

protected String incrementerFactoryClassName

The incrementer factory class name.

Constructor Detail

JRBaseSubreportReturnValue

protected JRBaseSubreportReturnValue()

JRBaseSubreportReturnValue

protected JRBaseSubreportReturnValue(JRSubreportReturnValue returnValue,
                          JRBaseObjectFactory factory)

Method Detail

getSubreportVariable

public String getSubreportVariable()

Deprecated. Replaced by getFromVariable().

Returns the name of the subreport variable whose value should be copied.

Specified by:

getSubreportVariable in interface JRSubreportReturnValue

Returns:

the name of the subreport variable whose value should be copied.

getFromVariable

public String getFromVariable()

Returns the name of the variable whose value should be copied.

Specified by:

getFromVariable in interface VariableReturnValue

Returns:

the name of the variable whose value should be copied.

getToVariable

public String getToVariable()

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

Specified by:

getToVariable in interface CommonReturnValue

Returns:

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

getCalculationValue

public CalculationEnum getCalculationValue()

Deprecated. Replaced by 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:

getCalculationValue in interface JRSubreportReturnValue

Returns:

the calculation type.

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 interface CommonReturnValue

Returns:

the calculation type.

getIncrementerFactoryClassName

public 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 interface CommonReturnValue

Returns:

the incrementer factory class name.

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object