KickJava   Java API By Example, From Geeks To Geeks.

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


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 /**
32  * @author Teodor Danciu (teodord@users.sourceforge.net)
33  * @version $Id: JRSubreport.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
34  */
35 public interface JRSubreport extends JRElement
36 {
37
38
39     /**
40      * Indicates if the engine is loading the current subreport from cache.
41      * Implementations of this method rely on default values that depend on the type of the subreport expression
42      * if a value was not explicitly set of this flag.
43      * @return true if the subreport should be loaded from cache, false otherwise
44      */
45     public boolean isUsingCache();
46
47     /**
48      * Specifies if the engine should be loading the current subreport from cache. If set to true, the reporting engine
49      * will try to recognize previously loaded subreports using their specified source. For example, it will recognize
50      * a subreport if the subreport source is a file name that it has already loaded, or if it is the same URL.
51      * <p>
52      * For subreports that have expressions returning <tt>java.lang.String</tt> objects as the subreport source,
53      * representing file names, URLs or classpath resources, the default value for this flag is true.
54      *
55      * @deprecated use {@link #setUsingCache(Boolean) setUsingCache(Boolean)} instead.
56      */
57     public void setUsingCache(boolean isUsingCache);
58
59     /**
60      *
61      */
62     public JRExpression getParametersMapExpression();
63
64     /**
65      *
66      */
67     public JRSubreportParameter[] getParameters();
68
69     /**
70      *
71      */
72     public JRExpression getConnectionExpression();
73
74     /**
75      *
76      */
77     public JRExpression getDataSourceExpression();
78
79     /**
80      *
81      */
82     public JRExpression getExpression();
83     
84     /**
85      * Returns the list of subreport copied values.
86      *
87      * @return the list of subreport copied values.
88      */
89     public JRSubreportReturnValue[] getReturnValues();
90
91     
92
93     /**
94      * Indicates if the engine is loading the current subreport from cache.
95      * Implementations of this method return the actual value for the internal flag that was explicitly
96      * set on this subreport.
97      * @return Boolean.TRUE if the subreport should be loaded from cache, Boolean.FALSE otherwise
98      * or null in case the flag was never explicitly set on this subreport element
99      */
100     public Boolean JavaDoc isOwnUsingCache();
101     
102     
103     /**
104      * Specifies if the engine should be loading the current subreport from cache. If set to Boolean.TRUE, the reporting engine
105      * will try to recognize previously loaded subreports using their specified source. For example, it will recognize
106      * an subreport if the subreport source is a file name that it has already loaded, or if it is the same URL.
107      * <p>
108      * If set to null, the engine will rely on some default value which depends on the type of the subreport expression.
109      * The cache is turned on by default only for subreports that have <tt>java.lang.String</tt> objects in their expressions.
110      */
111     public void setUsingCache(Boolean JavaDoc isUsingCache);
112 }
113
Popular Tags