KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > JRSubreportReturnValue


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * 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 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
35  */
36 public interface JRSubreportReturnValue
37 {
38
39     /**
40      * Returns the name of the subreport variable whose value should be copied.
41      *
42      * @return the name of the subreport variable whose value should be copied.
43      */
44     public String JavaDoc getSubreportVariable();
45
46     /**
47      * Returns the name of the master report variable where the value should be copied.
48      *
49      * @return the name of the master report variable where the value should be copied.
50      */
51     public String JavaDoc getToVariable();
52
53     /**
54      * Returns the calculation type.
55      * <p>
56      * When copying the value from the subreport, a formula can be applied such that sum,
57      * maximum, average and so on can be computed.
58      *
59      * @return the calculation type.
60      */
61     public byte getCalculation();
62     
63     /**
64      * Returns the incrementer factory class name.
65      * <p>
66      * The factory will be used to increment the value of the master report variable
67      * with the value from the subreport.
68      *
69      * @return the incrementer factory class name.
70      */
71     public String JavaDoc getIncrementerFactoryClassName();
72 }
73
Popular Tags