net.sf.jasperreports.engine.JRReportTemplate Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.engine;
import net.sf.jasperreports.engine.xml.JRXmlTemplateLoader;
/**
* A template included in a report.
*
* A template inclusion in a report consits of an expression that should be
* resolved at runtime to a {@link JRTemplate JRTemplate} instance.
*
* @author Lucian Chirita ([email protected])
* @see JRReport#getTemplates()
*/
public interface JRReportTemplate
{
/**
* Returns the template source expression.
*
* The expression type should be (compatible with) one of java.lang.String
,
* java.io.File
, java.net.URL
, java.io.InputStream
* (in which cases the template is loaded via {@link JRXmlTemplateLoader}) or
* {@link net.sf.jasperreports.engine.JRTemplate} .
*
* @return the template source expression
*/
JRExpression getSourceExpression();
}