net.sf.jasperreports.engine.fill

Class JRFillSubreportReturnValue

java.lang.Object

net.sf.jasperreports.engine.fill.JRFillSubreportReturnValue

All Implemented Interfaces:

Cloneable, JRCloneable, JRSubreportReturnValue

public class JRFillSubreportReturnValue
extends Object
implements JRSubreportReturnValue

Implementation of JRSubreportReturnValue used by the filler.

Version:

$Id: JRFillSubreportReturnValue.java 5180 2012-03-29 13:23:12Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
protected JRBaseFiller	filler
protected JRIncrementer	incrementer
protected JRSubreportReturnValue	parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRFillSubreportReturnValue(JRSubreportReturnValue returnValue, JRFillObjectFactory factory, JRBaseFiller filler)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
CalculationEnum	getCalculationValue() Returns the calculation type.
JRIncrementer	getIncrementer() Gets the incrementer to be used for this copied value.
String	getIncrementerFactoryClassName() Returns the incrementer factory class name.
String	getSubreportVariable() Returns the name of the subreport variable whose value should be copied.
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

parent

protected final JRSubreportReturnValue parent

incrementer

protected JRIncrementer incrementer

filler

protected final JRBaseFiller filler

Constructor Detail

JRFillSubreportReturnValue

protected JRFillSubreportReturnValue(JRSubreportReturnValue returnValue,
                          JRFillObjectFactory factory,
                          JRBaseFiller filler)

Method Detail

getSubreportVariable

public String getSubreportVariable()

Description copied from interface: JRSubreportReturnValue

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.

getToVariable

public String getToVariable()

Description copied from interface: JRSubreportReturnValue

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

Specified by:

getToVariable in interface JRSubreportReturnValue

Returns:

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

getIncrementerFactoryClassName

public String getIncrementerFactoryClassName()

Description copied from interface: JRSubreportReturnValue

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 JRSubreportReturnValue

Returns:

the incrementer factory class name.

getCalculationValue

public CalculationEnum getCalculationValue()

Description copied from interface: JRSubreportReturnValue

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.

getIncrementer

public JRIncrementer getIncrementer()

Gets the incrementer to be used for this copied value.

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object