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: import net.sf.jasperreports.engine.xml.JRXmlTemplateLoader;
31:
32: /**
33: * A template included in a report.
34: * <p/>
35: * A template inclusion in a report consits of an expression that should
36: * resolved at runtime to a {@link JRTemplate JRTemplate} instance.
37: *
38: * @author Lucian Chirita (lucianc@users.sourceforge.net)
39: * @version $Id: JRReportTemplate.java 1759 2007-06-20 16:47:34Z lucianc $
40: * @see JRReport#getTemplates()
41: */
42: public interface JRReportTemplate {
43:
44: /**
45: * Returns the template source expression.
46: * <p/>
47: * The expression type should be (compatible with) one of <code>java.lang.String</code>,
48: * <code>java.io.File</code>, <code>java.net.URL</code>, <code>java.io.InputStream</code>
49: * (in which cases the template is loaded via {@link JRXmlTemplateLoader}) or
50: * <code>net.sf.jasperreports.engine.JRTemplate</code> .
51: *
52: * @return the template source expression
53: */
54: JRExpression getSourceExpression();
55:
56: }
|