01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * This library is free software; you can redistribute it and/or
10: * modify it under the terms of the GNU Lesser General Public
11: * License as published by the Free Software Foundation; either
12: * version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17: * Lesser General Public License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22: *
23: * JasperSoft Corporation
24: * 303 Second Street, Suite 450 North
25: * San Francisco, CA 94107
26: * http://www.jaspersoft.com
27: */
28: package net.sf.jasperreports.engine;
29:
30: /**
31: * A value copied from a subreport into a variable of the master report.
32: *
33: * @author Lucian Chirita (lucianc@users.sourceforge.net)
34: * @version $Id: JRSubreportReturnValue.java 1229 2006-04-19 10:27:35Z teodord $
35: */
36: public interface JRSubreportReturnValue {
37:
38: /**
39: * Returns the name of the subreport variable whose value should be copied.
40: *
41: * @return the name of the subreport variable whose value should be copied.
42: */
43: public String getSubreportVariable();
44:
45: /**
46: * Returns the name of the master report variable where the value should be copied.
47: *
48: * @return the name of the master report variable where the value should be copied.
49: */
50: public String getToVariable();
51:
52: /**
53: * Returns the calculation type.
54: * <p>
55: * When copying the value from the subreport, a formula can be applied such that sum,
56: * maximum, average and so on can be computed.
57: *
58: * @return the calculation type.
59: */
60: public byte getCalculation();
61:
62: /**
63: * Returns the incrementer factory class name.
64: * <p>
65: * The factory will be used to increment the value of the master report variable
66: * with the value from the subreport.
67: *
68: * @return the incrementer factory class name.
69: */
70: public String getIncrementerFactoryClassName();
71: }
|