| DataFactory | Creates a tablemodel on request. | code | html |
| DataRow | The datarow is used to access the current row in the TableModel, Expressions and
Functions using a generic interface. |
code | html |
| ImageContainer | A image container stores all layout information to process images in a report. | code | html |
| LocalImageContainer | The LocalImageContainer makes the image available as 'java.awt.Image' instance. | code | html |
| MetaTableModel | A extension of the classic table-model. | code | html |
| PageDefinition | A logical page definition for a report. | code | html |
| ReportDefinition | A report definition. | code | html |
| ReportElement | Todo: Document Me | code | html |
| ReportEnvironment | Provides a simplified interface to access information about the processing environment in a simple way. | code | html |
| ReportPreProcessor | Todo: Document Me | code | html |
| ResourceBundleFactory | A resource bundle factory defines the locale for a report and is used to create resourcebundles. | code | html |
| RootLevelBand | A RootLevelBand is directly connected with a report definition or a group. | code | html |
| URLImageContainer | An image container, that references a remote image. | code | html |
| AbstractReportDefinition | The AbstractReportDefinition serves as base-implementation for both the SubReport and the global JFreeReport instance. | code | html |
| AbstractRootLevelBand | The root-level band is the container that is processed by a report-state. | code | html |
| CrosstabGroupBody | This group-body signals the begin of a crosstab-section. | code | html |
| Group | A report group. | code | html |
| GroupBody | This class only has two valid sub-classes and exists purely to limit the applicable composition options in the group-class. | code | html |
| Section | A section is a small-scale band that allows to access the child elements but does not define how childs get added or organized in the section. | code | html |
| Anchor | An anchor is a possible target for external hyperlinks. | code | html |
| AnchorElement | The anchor element creates targets for hyperlinks. | code | html |
| AttributeNames | A constant collection holding default attribute names. | code | html |
| AttributeNames.Core | code | html | |
| AttributeNames.Excel | code | html | |
| AttributeNames.Html | code | html | |
| AttributeNames.Internal | code | html | |
| AttributeNames.Pdf | code | html | |
| AttributeNames.Swing | code | html | |
| AttributeNames.Wizard | code | html | |
| AttributeNames.Xml | code | html | |
| Band | A report band is a collection of other elements and bands, similiar to an AWT-Container. | code | html |
| Boot | An utility class to safely boot and initialize the JFreeReport library. | code | html |
| CompoundDataFactory | The compound data factory is a collection of data-factories. | code | html |
| CustomPageDefinition | A page definition, that consists of one or many pages. | code | html |
| DefaultImageReference | An DefaultImageReference encapsulates the source of an image together with a java.awt.Image. |
code | html |
| DefaultLogModule | The module definition for the System.out-Logging. | code | html |
| DefaultReportEnvironment | Todo: Document Me | code | html |
| DefaultReportPreProcessor | An empty implementation that returns the report unchanged. | code | html |
| DefaultResourceBundleFactory | A default implementation of the ResourceBundleFactory, that creates resource bundles using the specified locale. | code | html |
| DetailsFooter | A details footer is printed between the last itemband and the first group-footer. | code | html |
| DetailsHeader | A details header is printed between the last group-header and the first detail band. | code | html |
| DrawableContainer | Wrapper for the drawable object, assigns content bounds and clipping bounds to the drawable. | code | html |
| DrawableElement | The element that returns a drawable object. | code | html |
| Element | Base class for all report elements (displays items that can appear within a report band). | code | html |
| Element.InternalElementStyleSheet | An private implementation of a stylesheet. | code | html |
| Element.InternalElementStyleSheetCarrier | A helper class to preserve a recoverable reference to the elements stylesheet. | code | html |
| ElementAlignment | Represents the alignment of an element. | code | html |
| EmptyReportException | The EmptyReportException is thrown, it the report processing generated no content. | code | html |
| GroupDataBody | Todo: Document Me | code | html |
| GroupFooter | A band that appears at the end of each instance of a group. | code | html |
| GroupHeader | A report band that appears at the beginning of each instance of a group. | code | html |
| GroupList | The group list is used to store groups in a ordered way. | code | html |
| ImageElement | Used to draw images. | code | html |
| ImageReference | An image reference encapsulates the source of an image together with a
java.awt.Image. |
code | html |
| InvalidReportStateException | An exception that can be thrown during report processing, if an error occurs. | code | html |
| ItemBand | A report band that displays a row of data items. | code | html |
| JFreeReport | A JFreeReport instance is used as report template to define the visual layout of a report and to collect all data sources for the reporting. | code | html |
| JFreeReportBoot | An utility class to safely boot and initialize the Pentaho-Reporting library. | code | html |
| JFreeReportBoot.UserConfigWrapper | A wrappper around the user supplied global configuration. | code | html |
| JFreeReportCoreModule | The CoreModule is used to represent the base classes of JFreeReport in a PackageManager-compatible way. | code | html |
| JFreeReportInfo | Details about the JFreeReport project. | code | html |
| MetaAttributeNames | Todo: Document Me | code | html |
| MetaAttributeNames.Core | code | html | |
| MetaAttributeNames.Database | code | html | |
| MetaAttributeNames.Expressions | code | html | |
| MetaAttributeNames.Formatting | code | html | |
| MetaAttributeNames.Numeric | code | html | |
| MetaAttributeNames.Parameters | code | html | |
| MetaAttributeNames.Style | code | html | |
| NoDataBand | The No-Data-Band is printed if the current report has no data in its main data-table. | code | html |
| PageFooter | A report band that appears at the bottom of every page. | code | html |
| PageHeader | A report band used to print information at the top of every page in the report. | code | html |
| ParameterDataRow | A static data row that reads its values from a report properties collection. | code | html |
| ParameterMapping | A parameter mapping defines an aliasing rule for incoming and outgoing sub-report parameters. | code | html |
| RelationalGroup | A group that accepts fields. | code | html |
| ReportAttributeMap | A attribute map that keeps track of changes. | code | html |
| ReportBuilderHints | The report builder hints can be used to store extra information for an JFreeReport instance. | code | html |
| ReportBuilderHints.ParserHintKey | The parser hint key is a compound key to combine a string key name with an arbitary target object. | code | html |
| ReportDataFactoryException | A report data factory exception is thrown whenever querying a datasource failed for some reason. | code | html |
| ReportEventException | The ReportEventException is thrown, if there were unrecoverable exceptions during the report processing. | code | html |
| ReportFooter | A report band that appears as the very last band on the report. | code | html |
| ReportHeader | A report band that is printed once only at the beginning of the report. | code | html |
| ReportInitialisationException | An exception that is thrown when a report fails to initialise. | code | html |
| ReportInterruptedException | This exception is thrown when the current thread received the Interrupt-signal while the report is beeing processed. | code | html |
| ReportParameterValidationException | Todo: Document Me | code | html |
| ReportProcessingException | An exception that can be thrown during report processing, if an error occurs. | code | html |
| ShapeElement | Used to draw shapes (typically lines and boxes) on a report band. | code | html |
| SimplePageDefinition | A simple page definition defines a logical page, for which all physical pages have the same size. | code | html |
| SubGroupBody | A group body that contains a sub-group. The body itself can contain styles and attributes. | code | html |
| SubReport | A subreport element. | code | html |
| TableDataFactory | The TableDataFactory provides keyed access to predefined tablemodels. | code | html |
| TextElement | The base class for all elements that display text in a report band. | code | html |
| Watermark | A report band used to print information at the background of every page in the report. | code | html |
| Watermark.WatermarkDefaultStyleSheet | A default style sheet for shape elements. This defined a default stroke for all shapes. | code | html |
Some rules when working with the report definition objects:
A group is a set of database rows, where the contents of the group fields are equal for all rows.
Lets look at the following table:
| Car | Color | Price |
|---|---|---|
| Toyota | blue | 10.000 |
| Toyota | blue | 20.000 |
| Toyota | red | 15.000 |
| Lexus | blue | 25.000 |
| Lexus | yellow | 15.000 |
| BMW | yellow | 40.000 |
| BMW | blue | 35.000 |
| BMW | green | 5.000 |
Groups are always defined on sorted tables. A group is defined by selecting one or more rows, which should form the group. A group instance will contain all rows from the beginning of the group until one of the group fields changes.
Lets select the row car for our group:
Selecting that row as group argument will result in 3 group instances. The first group instance will contain the first 3 rows (as the contents of these rows are equal).
The next instance will contain all rows of the "Lexus" car and the last group contains all rows from the "BMW" rows.
If a group is defined by more than one field, then the group will end, if one of the group member fields changes.
Lets define a group which consists of "Car" and "Color".
The first instance of the group will contain the first 2 rows (Toyota,blue). Then the value in the column "Color" changes, so a new group instance is started. This new group contains a single row, as the column "Car" in the next row will contain a different value.
The next two group instances are "Lexus, blue" and "Lexus, yellow", both group instances contain 1 row, as the color changes after 1 row.
The next row starts a new group, as the column "Car" contains a different value (BWM instead of Lexus). It doesn't matter, that the color is still equal, to end a group instance, it is sufficient that one column value changed.