net.sf.jasperreports.parts.subreport

Interface SubreportPartComponent

All Superinterfaces:

Cloneable, JRCloneable, PartComponent

All Known Implementing Classes:

StandardSubreportPartComponent

public interface SubreportPartComponent
extends PartComponent, JRCloneable

Subreport part component interface.

Version:

$Id: ListComponent.java 5877 2013-01-07 19:51:14Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Method Summary

Methods

Modifier and Type	Method and Description
JRExpression	getExpression()
JRSubreportParameter[]	getParameters()
JRExpression	getParametersMapExpression()
JRSubreportReturnValue[]	getReturnValues() Returns the list of subreport copied values.
Boolean	getUsingCache() Indicates if the engine is loading the current subreport from cache.
void	setUsingCache(Boolean isUsingCache) Specifies if the engine should be loading the current subreport from cache.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Method Detail

getParametersMapExpression

JRExpression getParametersMapExpression()

getParameters

JRSubreportParameter[] getParameters()

getReturnValues

JRSubreportReturnValue[] getReturnValues()

Returns the list of subreport copied values.

Returns:

the list of subreport copied values.

getExpression

JRExpression getExpression()

getUsingCache

Boolean getUsingCache()

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.

Returns:

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

setUsingCache

void setUsingCache(Boolean isUsingCache)

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.