Package net.sf.jasperreports.engine.base

Class BaseCommonReturnValue

java.lang.Object

net.sf.jasperreports.engine.base.BaseCommonReturnValue

All Implemented Interfaces:

Serializable, Cloneable, CommonReturnValue, JRCloneable

Direct Known Subclasses:

BaseExpressionReturnValue, BaseReturnValue, DesignCommonReturnValue

public class BaseCommonReturnValue
extends Object
implements CommonReturnValue, Serializable

Base implementation of CommonReturnValue.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseCommonReturnValue()
protected	BaseCommonReturnValue(CommonReturnValue returnValue, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
Object	clone()
CalculationEnum	getCalculation()	Returns the calculation type.
String	getIncrementerFactoryClassName()	Returns the incrementer factory class name.
String	getToVariable()	Returns the name of the 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 Details

toVariable

protected String toVariable

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

calculation

protected CalculationEnum calculation

The calculation type.

incrementerFactoryClassName

protected String incrementerFactoryClassName

The incrementer factory class name.

Constructor Details

BaseCommonReturnValue

protected BaseCommonReturnValue()

BaseCommonReturnValue

protected BaseCommonReturnValue(CommonReturnValue returnValue,
 JRBaseObjectFactory factory)

Method Details

getToVariable

public String getToVariable()

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.

getCalculation

public CalculationEnum getCalculation()

Returns the calculation type.

When copying the returned value, 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 report variable with the returned value.

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