net.sf.jasperreports.engine.base

Class BaseReturnValue

java.lang.Object

net.sf.jasperreports.engine.base.BaseReturnValue

All Implemented Interfaces:

Serializable, Cloneable, JRCloneable, ReturnValue

Direct Known Subclasses:

DesignReturnValue

public class BaseReturnValue
extends Object
implements ReturnValue, Serializable

Base implementation of JRReturnValue.

Version:

$Id: BaseReturnValue.java 5878 2013-01-07 20:23:13Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CalculationEnum	calculation The calculation type.
protected String	fromVariable The name of the variable to be copied.
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 and Description
protected	BaseReturnValue()
protected	BaseReturnValue(ReturnValue returnValue, JRBaseObjectFactory factory)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
CalculationEnum	getCalculation() Returns the calculation type.
String	getFromVariable() Returns the name of the variable whose value should be copied.
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 Detail

fromVariable

protected String fromVariable

The name of the variable to be copied.

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 Detail

BaseReturnValue

protected BaseReturnValue()

BaseReturnValue

protected BaseReturnValue(ReturnValue returnValue,
               JRBaseObjectFactory factory)

Method Detail

getFromVariable

public String getFromVariable()

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

Specified by:

getFromVariable in interface ReturnValue

Returns:

the name of the variable whose value should be copied.

getToVariable

public String getToVariable()

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

Specified by:

getToVariable in interface ReturnValue

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 ReturnValue

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 ReturnValue

Returns:

the incrementer factory class name.

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object