net.sf.jasperreports.engine
Interface JRSubreportReturnValue

All Known Implementing Classes:
JRBaseSubreportReturnValue, JRFillSubreportReturnValue

public interface JRSubreportReturnValue

A value copied from a subreport into a variable of the master report.

Version:
$Id: JRSubreportReturnValue.java,v 1.1 2005/07/20 16:08:54 lucianc Exp $
Author:
Lucian Chirita (lucianc@users.sourceforge.net)

Method Summary
 byte getCalculation()
          Returns the calculation type.
 java.lang.String getIncrementerFactoryClassName()
          Returns the incrementer factory class name.
 java.lang.String getSubreportVariable()
          Returns the name of the subreport variable whose value should be copied.
 java.lang.String getToVariable()
          Returns the name of the master report variable where the value should be copied.
 

Method Detail

getSubreportVariable

public java.lang.String getSubreportVariable()
Returns the name of the subreport variable whose value should be copied.

Returns:
the name of the subreport 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.

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

getCalculation

public byte 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.

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.

Returns:
the incrementer factory class name.


© 2001-2005 JasperSoft Corporation www.jaspersoft.com