org.pentaho.reporting.engine.classic.core
Interface ReportDefinition

All Superinterfaces:

Cloneable, ReportElement, Serializable

All Known Implementing Classes:

AbstractReportDefinition, MasterReport, ReportDefinitionImpl, SubReport

public interface ReportDefinition
extends ReportElement

A report definition. This the working copy of the JFreeReport object. During the report processing not all properties of the original JFreeReport object will be availble.

Author:

Thomas Morgner.

Method Summary

DetailsFooter	getDetailsFooter() Returns the details header band.
DetailsHeader	getDetailsHeader() Returns the details header band.
Group	getGroup(int count) Returns the group at the specified index or null, if there is no such group.
int	getGroupCount() Returns the number of groups in this report.
ItemBand	getItemBand() Returns the item band.
NoDataBand	getNoDataBand() Returns the "no-data" band, which is displayed if there is no data available.
PageDefinition	getPageDefinition() Returns the page definition assigned to the report definition.
PageFooter	getPageFooter() Returns the page footer.
PageHeader	getPageHeader() Returns the page header.
ReportProperties	getProperties() Deprecated. This method will be removed. Report-Properties are only valid for master-reports, not for any of the subreports. The concept of report-properties has been replaced by real parameter values.
String	getQuery() Returns the query name that should be used when processing the report.
int	getQueryLimit()
int	getQueryTimeout()
ReportFooter	getReportFooter() Returns the report footer.
ReportHeader	getReportHeader() Returns the report header.
Group	getRootGroup() Returns the list of groups for the report.
StyleSheetCollection	getStyleSheetCollection() Returns the stylesheet collection of this report definition.
Watermark	getWatermark() Returns the watermark band.

Methods inherited from interface org.pentaho.reporting.engine.classic.core.ReportElement

getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getId, getMetaData, getName, getObjectID, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, setAttribute, setAttributeExpression, setStyleExpression

Method Detail

getQuery

String getQuery()

Returns the query name that should be used when processing the report.

Returns:

the query string.

getQueryLimit

int getQueryLimit()

getQueryTimeout

int getQueryTimeout()

getRootGroup

Group getRootGroup()

Returns the list of groups for the report.

Returns:

The list of groups.

getReportHeader

ReportHeader getReportHeader()

Returns the report header.

Returns:

The report header.

getReportFooter

ReportFooter getReportFooter()

Returns the report footer.

Returns:

The report footer.

getPageHeader

PageHeader getPageHeader()

Returns the page header.

Returns:

The page header.

getPageFooter

PageFooter getPageFooter()

Returns the page footer.

Returns:

The page footer.

getDetailsHeader

DetailsHeader getDetailsHeader()

Returns the details header band.

Returns:

The details header band.

getDetailsFooter

DetailsFooter getDetailsFooter()

Returns the details header band.

Returns:

The details header band.

getItemBand

ItemBand getItemBand()

Returns the item band.

Returns:

The item band.

getWatermark

Watermark getWatermark()

Returns the watermark band.

Returns:

The watermark band.

getNoDataBand

NoDataBand getNoDataBand()

Returns the "no-data" band, which is displayed if there is no data available.

Returns:

The no-data band.

getProperties

ReportProperties getProperties()

Deprecated. This method will be removed. Report-Properties are only valid for master-reports, not for any of the subreports. The concept of report-properties has been replaced by real parameter values.

Returns the report properties.

Returns:

The report properties.

getGroupCount

int getGroupCount()

Returns the number of groups in this report.

Every report has at least one group defined.

Returns:

the group count.

getGroup

Group getGroup(int count)

Returns the group at the specified index or null, if there is no such group.

Parameters:

count - the group index.

Returns:

the requested group.

Throws:

IllegalArgumentException - if the count is negative.

IndexOutOfBoundsException - if the count is greater than the number of defined groups.

getStyleSheetCollection

StyleSheetCollection getStyleSheetCollection()

Returns the stylesheet collection of this report definition. The stylesheet collection is fixed for the report definition and all elements of the report. When a band or group is added to the report it will get registered with this stylesheet collection and cannot be used in an different report.

Returns:

the stylesheet collection of the report, never null.

getPageDefinition

PageDefinition getPageDefinition()

Returns the page definition assigned to the report definition. The page definition defines the report area and how the report is subdivided by the child pages.

Returns:

the page definition.