net.sf.jasperreports.parts.subreport.SubreportPartComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* 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.parts.subreport;
import net.sf.jasperreports.engine.JRCloneable;
import net.sf.jasperreports.engine.JRExpression;
import net.sf.jasperreports.engine.JRSubreportParameter;
import net.sf.jasperreports.engine.JRSubreportReturnValue;
import net.sf.jasperreports.engine.part.PartComponent;
/**
* Subreport part component interface.
*
* @author Teodor Danciu ([email protected])
*/
public interface SubreportPartComponent extends PartComponent, JRCloneable
{
/**
*
*/
public JRExpression getParametersMapExpression();
/**
*
*/
public JRSubreportParameter[] getParameters();
/**
* Returns the list of subreport copied values.
*
* @return the list of subreport copied values.
*/
public JRSubreportReturnValue[] getReturnValues();
/**
*
*/
public JRExpression getExpression();
/**
* Indicates if the engine is loading the current subreport from cache.
* Implementations of this method return the actual value for the internal flag that was explicitly
* set on this subreport.
* @return Boolean.TRUE if the subreport should be loaded from cache, Boolean.FALSE otherwise
* or null in case the flag was never explicitly set on this subreport element
*/
public Boolean getUsingCache();
/**
* Specifies if the engine should be loading the current subreport from cache. If set to Boolean.TRUE, the reporting engine
* will try to recognize previously loaded subreports using their specified source. For example, it will recognize
* an subreport if the subreport source is a file name that it has already loaded, or if it is the same URL.
*
* If set to null, the engine will rely on some default value which depends on the type of the subreport expression.
* The cache is turned on by default only for subreports that have java.lang.String objects in their expressions.
*/
public void setUsingCache(Boolean isUsingCache);
}