net.sf.jasperreports.engine
Interface JRSubreport

All Superinterfaces:
JRChild, JRElement
All Known Implementing Classes:
JRBaseSubreport, JRDesignSubreport, JRFillSubreport

public interface JRSubreport
extends JRElement

Version:
$Id: JRSubreport.java,v 1.9 2005/08/22 11:35:14 lucianc Exp $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Field Summary
 
Fields inherited from interface net.sf.jasperreports.engine.JRElement
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
 
Method Summary
 JRExpression getConnectionExpression()
           
 JRExpression getDataSourceExpression()
           
 JRExpression getExpression()
           
 JRSubreportParameter[] getParameters()
           
 JRExpression getParametersMapExpression()
           
 JRSubreportReturnValue[] getReturnValues()
          Returns the list of subreport copied values.
 java.lang.Boolean isOwnUsingCache()
          Indicates if the engine is loading the current subreport from cache.
 boolean isUsingCache()
          Indicates if the engine is loading the current subreport from cache.
 void setUsingCache(boolean isUsingCache)
          Deprecated. use setUsingCache(Boolean) instead.
 void setUsingCache(java.lang.Boolean isUsingCache)
          Specifies if the engine should be loading the current subreport from cache.
 
Methods inherited from interface net.sf.jasperreports.engine.JRElement
collectExpressions, getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from interface net.sf.jasperreports.engine.JRChild
getCopy, writeXml
 

Method Detail

isUsingCache

public boolean isUsingCache()
Indicates if the engine is loading the current subreport from cache. Implementations of this method rely on default values that depend on the type of the subreport expression if a value was not explicitly set of this flag.

Returns:
true if the subreport should be loaded from cache, false otherwise

setUsingCache

public void setUsingCache(boolean isUsingCache)
Deprecated. use setUsingCache(Boolean) instead.

Specifies if the engine should be loading the current subreport from cache. If set to true, the reporting engine will try to recognize previously loaded subreports using their specified source. For example, it will recognize a subreport if the subreport source is a file name that it has already loaded, or if it is the same URL.

For subreports that have expressions returning java.lang.String objects as the subreport source, representing file names, URLs or classpath resources, the default value for this flag is true.


getParametersMapExpression

public JRExpression getParametersMapExpression()

getParameters

public JRSubreportParameter[] getParameters()

getConnectionExpression

public JRExpression getConnectionExpression()

getDataSourceExpression

public JRExpression getDataSourceExpression()

getExpression

public JRExpression getExpression()

getReturnValues

public JRSubreportReturnValue[] getReturnValues()
Returns the list of subreport copied values.

Returns:
the list of subreport copied values.

isOwnUsingCache

public java.lang.Boolean isOwnUsingCache()
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

public void setUsingCache(java.lang.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.



© 2001-2005 JasperSoft Corporation www.jaspersoft.com