net.sf.jasperreports.engine.base
Class JRBaseSubreport

java.lang.Object
  net.sf.jasperreports.engine.base.JRBaseElement
      net.sf.jasperreports.engine.base.JRBaseSubreport

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, JRChangeEventsSupport, JRChild, JRCloneable, JRCommonElement, JRElement, JRPropertiesHolder, JRStyleContainer, JRSubreport, JRVisitable

public class JRBaseSubreport
extends JRBaseElement
implements JRSubreport

Version:

$Id: JRBaseSubreport.java 2000 2007-12-05 14:07:13Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

protected JRExpression	connectionExpression
protected JRExpression	dataSourceExpression
protected JRExpression	expression
protected java.lang.Boolean	isUsingCache
protected JRSubreportParameter[]	parameters
protected JRExpression	parametersMapExpression
static java.lang.String	PROPERTY_USING_CACHE
protected JRSubreportReturnValue[]	returnValues Values to be copied from the subreport into the master report.

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchType, width, x, y

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

Constructor Summary

protected

JRBaseSubreport(JRSubreport subreport, JRBaseObjectFactory factory)

Method Summary

java.lang.Object	clone()
void	collectExpressions(JRExpressionCollector collector)
JRExpression	getConnectionExpression()
JRExpression	getDataSourceExpression()
JRExpression	getExpression()
byte	getMode() Returns the element transparency mode.
JRSubreportParameter[]	getParameters()
JRExpression	getParametersMapExpression()
JRSubreportReturnValue[]	getReturnValues() Returns the list of values to be copied from the subreport into the master.
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. Replaced by setUsingCache(Boolean).
void	setUsingCache(java.lang.Boolean isUsingCache) Specifies if the engine should be loading the current subreport from cache.
void	visit(JRVisitor visitor)

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement

clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchType, getStyle, getStyleNameReference, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getElementGroup, getHeight, getKey, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

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

clone

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

getBackcolor, getForecolor, getOwnBackcolor, getOwnForecolor, getOwnMode

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

getDefaultStyleProvider, getStyle, getStyleNameReference

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

getParentProperties, getPropertiesMap, hasProperties

Field Detail

PROPERTY_USING_CACHE

public static final java.lang.String PROPERTY_USING_CACHE

See Also:

Constant Field Values

isUsingCache

protected java.lang.Boolean isUsingCache

parametersMapExpression

protected JRExpression parametersMapExpression

parameters

protected JRSubreportParameter[] parameters

connectionExpression

protected JRExpression connectionExpression

dataSourceExpression

protected JRExpression dataSourceExpression

expression

protected JRExpression expression

returnValues

protected JRSubreportReturnValue[] returnValues

Values to be copied from the subreport into the master report.

Constructor Detail

JRBaseSubreport

protected JRBaseSubreport(JRSubreport subreport,
                          JRBaseObjectFactory factory)

Method Detail

getMode

public byte getMode()

Description copied from interface: JRCommonElement

Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.

Specified by:

getMode in interface JRCommonElement

Overrides:

getMode in class JRBaseElement

Returns:

MODE_OPAQUE or MODE_TRANSPARENT

isUsingCache

public boolean isUsingCache()

Description copied from interface: JRSubreport

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.

Specified by:

isUsingCache in interface JRSubreport

Returns:

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

setUsingCache

public void setUsingCache(boolean isUsingCache)

Deprecated. Replaced by setUsingCache(Boolean).

Description copied from interface: JRSubreport

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.

Specified by:

setUsingCache in interface JRSubreport

getParametersMapExpression

public JRExpression getParametersMapExpression()

Specified by:

getParametersMapExpression in interface JRSubreport

getParameters

public JRSubreportParameter[] getParameters()

Specified by:

getParameters in interface JRSubreport

getConnectionExpression

public JRExpression getConnectionExpression()

Specified by:

getConnectionExpression in interface JRSubreport

getDataSourceExpression

public JRExpression getDataSourceExpression()

Specified by:

getDataSourceExpression in interface JRSubreport

getExpression

public JRExpression getExpression()

Specified by:

getExpression in interface JRSubreport

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable

getReturnValues

public JRSubreportReturnValue[] getReturnValues()

Returns the list of values to be copied from the subreport into the master.

Specified by:

getReturnValues in interface JRSubreport

Returns:

the list of values to be copied from the subreport into the master.

isOwnUsingCache

public java.lang.Boolean isOwnUsingCache()

Description copied from interface: JRSubreport

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.

Specified by:

isOwnUsingCache in interface JRSubreport

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)

Description copied from interface: JRSubreport

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.

Specified by:

setUsingCache in interface JRSubreport

clone

public java.lang.Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseElement