Package net.sf.jasperreports.engine.base

Class JRBaseReport

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseReport

All Implemented Interfaces:

Serializable, JRChangeEventsSupport, JRDefaultStyleProvider, JRIdentifiable, JRPropertiesHolder, JRReport

Direct Known Subclasses:

JasperDesign, JasperReport

public class JRBaseReport
extends Object
implements JRReport, Serializable, JRChangeEventsSupport

Base class that implements the JRReport interface.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• JRReport
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRBand	background
protected int	bottomMargin
protected Integer	columnCount
protected RunDirectionEnum	columnDirection
protected JRBand	columnFooter
protected JRBand	columnHeader
protected int	columnSpacing
protected int	columnWidth
protected JRDataset[]	datasets	Sub datasets of the report.
protected JRStyle	defaultStyle
protected JRSection	detailSection
protected String	formatFactoryClass
protected boolean	ignorePagination
protected Set<String>	importsSet
protected boolean	isFloatColumnFooter
protected boolean	isSummaryNewPage
protected boolean	isSummaryWithPageHeaderAndFooter
protected boolean	isTitleNewPage
protected String	language
protected JRBand	lastPageFooter
protected int	leftMargin
protected JRDataset	mainDataset	The main dataset of the report.
protected String	name
protected JRBand	noData
protected OrientationEnum	orientation
protected JRBand	pageFooter
protected JRBand	pageHeader
protected int	pageHeight
protected int	pageWidth
protected PrintOrderEnum	printOrder
static final String	PROPERTY_SECTION_TYPE
static final String	PROPERTY_WHEN_NO_DATA_TYPE
protected int	rightMargin
protected SectionTypeEnum	sectionType
protected StyleResolver	styleResolver
protected JRStyle[]	styles
protected JRBand	summary
protected JRReportTemplate[]	templates	Report templates.
protected JRBand	title
protected int	topMargin
protected WhenNoDataTypeEnum	whenNoDataType

Fields inherited from interface net.sf.jasperreports.engine.JRReport

CONFIG_PROPERTY_WHEN_NO_DATA_TYPE, LANGUAGE_GROOVY, LANGUAGE_JAVA

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRBaseReport()
	JRBaseReport(JRReport report)
	JRBaseReport(JRReport report, JRBaseObjectFactory factory)	Constructs a copy of a report.
	JRBaseReport(JRReport report, JRExpressionCollector expressionCollector)

Method Summary

Modifier and Type	Method	Description
protected void	copyTemplates(JRReport report, JRBaseObjectFactory factory)
JRBand[]	getAllBands()
JRBand	getBackground()
int	getBottomMargin()
Integer	getColumnCount()	Gets the number of columns on each page
RunDirectionEnum	getColumnDirection()	Specifies whether columns will be filled from left to right or from right to left.
JRBand	getColumnFooter()
JRBand	getColumnHeader()
int	getColumnSpacing()	Specifies the space between columns on the same page.
int	getColumnWidth()
JRDataset[]	getDatasets()	Returns the datasets of this report.
JRStyle	getDefaultStyle()	Returns a default style.
JRSection	getDetailSection()
JRPropertyChangeSupport	getEventSupport()	Returns the property change support object for this instance.
JRField[]	getFields()	Gets an array of report fields.
String	getFormatFactoryClass()	Gets the name of the class implementing the FormatFactory interface to use with this report.
JRGroup[]	getGroups()
String[]	getImports()	Gets an array of imports (needed if report expression require additional classes in order to compile).
String	getLanguage()	Gets the report language.
JRBand	getLastPageFooter()
int	getLeftMargin()
JRDataset	getMainDataset()	Returns the main report dataset.
String	getName()	Gets the report name.
JRBand	getNoData()
OrientationEnum	getOrientation()	Specifies whether document pages will be rendered in a portrait or landscape layout.
JRBand	getPageFooter()
JRBand	getPageHeader()
int	getPageHeight()
int	getPageWidth()
JRParameter[]	getParameters()	Gets an array of report parameters (including built-in ones).
JRPropertiesHolder	getParentProperties()	Returns the parent properties holder, whose properties are used as defaults for this object.
PrintOrderEnum	getPrintOrder()	Specifies whether columns will be filled horizontally or vertically.
JRPropertiesMap	getPropertiesMap()	Returns this object's properties map.
String	getProperty(String propName)	Gets a property value
DatasetPropertyExpression[]	getPropertyExpressions()	Returns the list of dynamic/expression-based properties for this report.
String[]	getPropertyNames()	Gets an array of report properties names.
JRQuery	getQuery()
String	getResourceBundle()	Gets the base name of the report associated resource bundle.
int	getRightMargin()
String	getScriptletClass()
JRScriptlet[]	getScriptlets()	Gets an array of report scriptlets (excluding the scriptletClass one).
SectionTypeEnum	getSectionType()	Specifies whether report sections are made of bands or of parts.
JRSortField[]	getSortFields()	Gets an array of sort report fields.
StyleResolver	getStyleResolver()	Returns a style resolver.
JRStyle[]	getStyles()	Gets an array of report styles.
JRBand	getSummary()
JRReportTemplate[]	getTemplates()	Returns the list of report templates.
JRBand	getTitle()
int	getTopMargin()
UUID	getUUID()
JRVariable[]	getVariables()	Gets an array of report variables.
WhenNoDataTypeEnum	getWhenNoDataType()	Specifies the report behavior in case of empty datasources.
WhenResourceMissingTypeEnum	getWhenResourceMissingType()	Returns the resource missing handling type.
boolean	hasProperties()	Checks whether the object has any properties.
boolean	isFloatColumnFooter()	Specifies if the column footer section will be printed at the bottom of the column or if it will immediately follow the last detail or group footer printed on the current column.
boolean	isIgnorePagination()	Decides whether to use pagination when filling the report.
boolean	isSummaryNewPage()	Specifies if the summary section will be printed on a separate last page.
boolean	isSummaryWithPageHeaderAndFooter()	Specifies if the summary section will be accompanied by the page header and footer.
boolean	isTitleNewPage()	Specifies if the title section will be printed on a separate initial page.
void	removeProperty(String propName)
void	setJasperReportsContext(JasperReportsContext jasperReportsContext)
void	setProperty(String propName, String value)
void	setSectionType(SectionTypeEnum sectionType)
void	setWhenNoDataType(WhenNoDataTypeEnum whenNoDataType)	Sets the report behavior in case of empty datasources.
void	setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)	Sets the resource missing handling type.

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_WHEN_NO_DATA_TYPE

public static final String PROPERTY_WHEN_NO_DATA_TYPE

See Also:

• Constant Field Values

PROPERTY_SECTION_TYPE

public static final String PROPERTY_SECTION_TYPE

See Also:

• Constant Field Values

name

protected String name

language

protected String language

columnCount

protected Integer columnCount

printOrder

protected PrintOrderEnum printOrder

columnDirection

protected RunDirectionEnum columnDirection

pageWidth

protected int pageWidth

pageHeight

protected int pageHeight

orientation

protected OrientationEnum orientation

whenNoDataType

protected WhenNoDataTypeEnum whenNoDataType

sectionType

protected SectionTypeEnum sectionType

columnWidth

protected int columnWidth

columnSpacing

protected int columnSpacing

leftMargin

protected int leftMargin

rightMargin

protected int rightMargin

topMargin

protected int topMargin

bottomMargin

protected int bottomMargin

isTitleNewPage

protected boolean isTitleNewPage

isSummaryNewPage

protected boolean isSummaryNewPage

isSummaryWithPageHeaderAndFooter

protected boolean isSummaryWithPageHeaderAndFooter

isFloatColumnFooter

protected boolean isFloatColumnFooter

ignorePagination

protected boolean ignorePagination

formatFactoryClass

protected String formatFactoryClass

importsSet

protected Set<String> importsSet

templates

protected JRReportTemplate[] templates

Report templates.

defaultStyle

protected JRStyle defaultStyle

styles

protected JRStyle[] styles

styleResolver

protected transient StyleResolver styleResolver

mainDataset

protected JRDataset mainDataset

The main dataset of the report.

datasets

protected JRDataset[] datasets

Sub datasets of the report.

background

protected JRBand background

title

protected JRBand title

pageHeader

protected JRBand pageHeader

columnHeader

protected JRBand columnHeader

detailSection

protected JRSection detailSection

columnFooter

protected JRBand columnFooter

pageFooter

protected JRBand pageFooter

lastPageFooter

protected JRBand lastPageFooter

summary

protected JRBand summary

noData

protected JRBand noData

Constructor Details

JRBaseReport

protected JRBaseReport()

JRBaseReport

public JRBaseReport(JRReport report,
 JRExpressionCollector expressionCollector)

JRBaseReport

public JRBaseReport(JRReport report,
 JRBaseObjectFactory factory)

Constructs a copy of a report.

JRBaseReport

public JRBaseReport(JRReport report)

Method Details

copyTemplates

protected void copyTemplates(JRReport report,
 JRBaseObjectFactory factory)

setJasperReportsContext

public void setJasperReportsContext(JasperReportsContext jasperReportsContext)

getName

public String getName()

Description copied from interface: JRReport

Gets the report name.

Specified by:

getName in interface JRReport

getLanguage

public String getLanguage()

Description copied from interface: JRReport

Gets the report language. Should be Java or Groovy.

Specified by:

getLanguage in interface JRReport

getColumnCount

public Integer getColumnCount()

Description copied from interface: JRReport

Gets the number of columns on each page

Specified by:

getColumnCount in interface JRReport

getPrintOrder

public PrintOrderEnum getPrintOrder()

Description copied from interface: JRReport

Specifies whether columns will be filled horizontally or vertically.

Specified by:

getPrintOrder in interface JRReport

Returns:

a value representing one of the print order constants in PrintOrderEnum

getColumnDirection

public RunDirectionEnum getColumnDirection()

Description copied from interface: JRReport

Specifies whether columns will be filled from left to right or from right to left.

Specified by:

getColumnDirection in interface JRReport

Returns:

a value representing one of the column direction constants in RunDirectionEnum

getPageWidth

public int getPageWidth()

Specified by:

getPageWidth in interface JRReport

getPageHeight

public int getPageHeight()

Specified by:

getPageHeight in interface JRReport

getOrientation

public OrientationEnum getOrientation()

Description copied from interface: JRReport

Specifies whether document pages will be rendered in a portrait or landscape layout.

Specified by:

getOrientation in interface JRReport

Returns:

a value representing one of the orientation constants in OrientationEnum

getWhenNoDataType

public WhenNoDataTypeEnum getWhenNoDataType()

Description copied from interface: JRReport

Specifies the report behavior in case of empty datasources.

Specified by:

getWhenNoDataType in interface JRReport

setWhenNoDataType

public void setWhenNoDataType(WhenNoDataTypeEnum whenNoDataType)

Description copied from interface: JRReport

Sets the report behavior in case of empty datasources.

Specified by:

setWhenNoDataType in interface JRReport

getSectionType

public SectionTypeEnum getSectionType()

Description copied from interface: JRReport

Specifies whether report sections are made of bands or of parts.

Specified by:

getSectionType in interface JRReport

Returns:

a value representing one of the section type constants in SectionTypeEnum

setSectionType

public void setSectionType(SectionTypeEnum sectionType)

getColumnWidth

public int getColumnWidth()

Specified by:

getColumnWidth in interface JRReport

getColumnSpacing

public int getColumnSpacing()

Description copied from interface: JRReport

Specifies the space between columns on the same page.

Specified by:

getColumnSpacing in interface JRReport

getLeftMargin

public int getLeftMargin()

Specified by:

getLeftMargin in interface JRReport

getRightMargin

public int getRightMargin()

Specified by:

getRightMargin in interface JRReport

getTopMargin

public int getTopMargin()

Specified by:

getTopMargin in interface JRReport

getBottomMargin

public int getBottomMargin()

Specified by:

getBottomMargin in interface JRReport

isTitleNewPage

public boolean isTitleNewPage()

Description copied from interface: JRReport

Specifies if the title section will be printed on a separate initial page.

Specified by:

isTitleNewPage in interface JRReport

isSummaryNewPage

public boolean isSummaryNewPage()

Description copied from interface: JRReport

Specifies if the summary section will be printed on a separate last page.

Specified by:

isSummaryNewPage in interface JRReport

isSummaryWithPageHeaderAndFooter

public boolean isSummaryWithPageHeaderAndFooter()

Description copied from interface: JRReport

Specifies if the summary section will be accompanied by the page header and footer.

Specified by:

isSummaryWithPageHeaderAndFooter in interface JRReport

isFloatColumnFooter

public boolean isFloatColumnFooter()

Description copied from interface: JRReport

Specifies if the column footer section will be printed at the bottom of the column or if it will immediately follow the last detail or group footer printed on the current column.

Specified by:

isFloatColumnFooter in interface JRReport

getScriptletClass

public String getScriptletClass()

Specified by:

getScriptletClass in interface JRReport

getFormatFactoryClass

public String getFormatFactoryClass()

Description copied from interface: JRReport

Gets the name of the class implementing the FormatFactory interface to use with this report.

Specified by:

getFormatFactoryClass in interface JRReport

getResourceBundle

public String getResourceBundle()

Description copied from interface: JRReport

Gets the base name of the report associated resource bundle.

Specified by:

getResourceBundle in interface JRReport

getPropertyNames

public String[] getPropertyNames()

Description copied from interface: JRReport

Gets an array of report properties names.

Specified by:

getPropertyNames in interface JRReport

getProperty

public String getProperty(String propName)

Description copied from interface: JRReport

Gets a property value

Specified by:

getProperty in interface JRReport

Parameters:

propName - the property name

setProperty

public void setProperty(String propName,
 String value)

Specified by:

setProperty in interface JRReport

removeProperty

public void removeProperty(String propName)

Specified by:

removeProperty in interface JRReport

getPropertyExpressions

public DatasetPropertyExpression[] getPropertyExpressions()

Description copied from interface: JRReport

Returns the list of dynamic/expression-based properties for this report.

Specified by:

getPropertyExpressions in interface JRReport

Returns:

an array containing the expression-based properties of this report

getImports

public String[] getImports()

Description copied from interface: JRReport

Gets an array of imports (needed if report expression require additional classes in order to compile).

Specified by:

getImports in interface JRReport

getDefaultStyle

public JRStyle getDefaultStyle()

Description copied from interface: JRDefaultStyleProvider

Returns a default style.

Specified by:

getDefaultStyle in interface JRDefaultStyleProvider

getStyles

public JRStyle[] getStyles()

Description copied from interface: JRReport

Gets an array of report styles.

Specified by:

getStyles in interface JRReport

getStyleResolver

public StyleResolver getStyleResolver()

Description copied from interface: JRDefaultStyleProvider

Returns a style resolver.

Specified by:

getStyleResolver in interface JRDefaultStyleProvider

getScriptlets

public JRScriptlet[] getScriptlets()

Gets an array of report scriptlets (excluding the scriptletClass one).

Specified by:

getScriptlets in interface JRReport

getParameters

public JRParameter[] getParameters()

Gets an array of report parameters (including built-in ones).

Specified by:

getParameters in interface JRReport

getQuery

public JRQuery getQuery()

Specified by:

getQuery in interface JRReport

getFields

public JRField[] getFields()

Gets an array of report fields.

Specified by:

getFields in interface JRReport

getSortFields

public JRSortField[] getSortFields()

Gets an array of sort report fields.

Specified by:

getSortFields in interface JRReport

getVariables

public JRVariable[] getVariables()

Gets an array of report variables.

Specified by:

getVariables in interface JRReport

getGroups

public JRGroup[] getGroups()

Specified by:

getGroups in interface JRReport

getBackground

public JRBand getBackground()

Specified by:

getBackground in interface JRReport

getTitle

public JRBand getTitle()

Specified by:

getTitle in interface JRReport

getPageHeader

public JRBand getPageHeader()

Specified by:

getPageHeader in interface JRReport

getColumnHeader

public JRBand getColumnHeader()

Specified by:

getColumnHeader in interface JRReport

getDetailSection

public JRSection getDetailSection()

Specified by:

getDetailSection in interface JRReport

getColumnFooter

public JRBand getColumnFooter()

Specified by:

getColumnFooter in interface JRReport

getPageFooter

public JRBand getPageFooter()

Specified by:

getPageFooter in interface JRReport

getLastPageFooter

public JRBand getLastPageFooter()

Specified by:

getLastPageFooter in interface JRReport

getSummary

public JRBand getSummary()

Specified by:

getSummary in interface JRReport

getWhenResourceMissingType

public WhenResourceMissingTypeEnum getWhenResourceMissingType()

Description copied from interface: JRReport

Returns the resource missing handling type.

Specified by:

getWhenResourceMissingType in interface JRReport

setWhenResourceMissingType

public void setWhenResourceMissingType(WhenResourceMissingTypeEnum whenResourceMissingType)

Description copied from interface: JRReport

Sets the resource missing handling type.

Specified by:

setWhenResourceMissingType in interface JRReport

Parameters:

whenResourceMissingType - the resource missing handling type

getMainDataset

public JRDataset getMainDataset()

Description copied from interface: JRReport

Returns the main report dataset.

The main report dataset consists of all parameters, fields, variables and groups of the report.

Specified by:

getMainDataset in interface JRReport

Returns:

the main report dataset

getDatasets

public JRDataset[] getDatasets()

Description copied from interface: JRReport

Returns the datasets of this report.

Specified by:

getDatasets in interface JRReport

Returns:

the datasets of this report

isIgnorePagination

public boolean isIgnorePagination()

Description copied from interface: JRReport

Decides whether to use pagination when filling the report.

If set to true the report will be generated on one long page.

The design attribute can be overridden at fill time by the IS_IGNORE_PAGINATION parameter.

Specified by:

isIgnorePagination in interface JRReport

Returns:

whether to use pagination when filling the report

hasProperties

public boolean hasProperties()

Description copied from interface: JRPropertiesHolder

Checks whether the object has any properties.

Specified by:

hasProperties in interface JRPropertiesHolder

Returns:

whether the object has any properties

getPropertiesMap

public JRPropertiesMap getPropertiesMap()

Description copied from interface: JRPropertiesHolder

Returns this object's properties map.

Specified by:

getPropertiesMap in interface JRPropertiesHolder

Returns:

this object's properties map

getParentProperties

public JRPropertiesHolder getParentProperties()

Description copied from interface: JRPropertiesHolder

Returns the parent properties holder, whose properties are used as defaults for this object.

Specified by:

getParentProperties in interface JRPropertiesHolder

Returns:

the parent properties holder, or null if no parent

getTemplates

public JRReportTemplate[] getTemplates()

Description copied from interface: JRReport

Returns the list of report templates.

A report template is an expression which resolves at runtime to a template. Templates include styles which can be used in the report.

The order in which the templates are included in the report is important:

• A style's parent must appear before the style itself.
• A style overrides styles with the same name that are placed before it. Also, report styles override templates styles with the same name.

Specified by:

getTemplates in interface JRReport

Returns:

the list of report templates, or null if none

See Also:

• JRTemplate
• JRParameter.REPORT_TEMPLATES

getNoData

public JRBand getNoData()

Specified by:

getNoData in interface JRReport

Returns:

the noData

getAllBands

public JRBand[] getAllBands()

getUUID

public UUID getUUID()

Specified by:

getUUID in interface JRIdentifiable

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance