JasperReports Ultimate Guide - Sample Reference - Schema Reference - Configuration Reference - API (Javadoc)
|
|
|
|
JasperReports - Crosstabs Sample (version 4.6.0) | |
|
|
|
Main Features in This Sample | |
| Crosstabs |
| Datasets |
|
|
|||||
top | ||||||
|
||||||
Crosstabs | Documented by | |||||
|
||||||
| Description / Goal |
| How to use the built-in crosstab element to display aggregated data. | |||
| Since |
| 1.1.0 | |||
|
||||||
|
Crosstabs Overview
Crosstabs are very helpful tools used to aggregate data into 2-dimensional grids. Like other data aggregating elements (charts, for instance), they are organized as regular report elements, but with a complex structure and granularity. Crosstabs can be used with any level of data (nominal, ordinal, interval, or ratio), and usually display the summarized data, contained in report variables, in the form of a dynamic table. Variables are used to display aggregate data such as sums, counts, average values. Crosstabs are also interesting due to their flexible layout capabilities. When a crosstab does not fit on a page, then either a column or row break occurs, and the crosstab splits into several pieces. Depending on the remaining available space, the crosstab could continue on the same page, or it could overflow onto a new page. A crosstab element is characterized by the following attributes:
name and class attributes and
by the <parameterValueExpression> tag.
One can declare crosstab parameters either one by one in the crosstab element, or grouping them in a parameters map referenced by the <parametersMapExpression> tag.
Crosstab Datasets Like charts, crosstabs can handle by themselves collections of data. They can access data either in the report main dataset, or they can handle their own subdataset. All subdataset information required by the crosstab element is contained in the <crosstabDataset> child element. To faster
perform calculations on data it is recommended that data come already sorted within dataset, according
to the row and column groups. If this is not the case, then the crosstab internal engine should be
instructed to sort data during the aggregation process. One can do this using the isDataPreSorted
dataset attribute. If no <crosstabDataset> is declared, then the crosstab is using the
main dataset. More on datasets can be found further in the datasets section.
Data Grouping in Crosstab The crosstab calculation engine aggregates data by iterating through the associated dataset records. In order to aggregate data, one need to group them first. In a crosstab rows and columns are based on specific group items, called buckets . A bucket definition should contain:
Any number of row groups can be declared within a crosstab. The first row group will enclose the second one, the second one will enclose the third one, and so on. A row group is characterized by the following attributes:
Any number of column groups can be declared within a crosstab. Like row groups, outer column groups are enclosing inner column groups, in the same order as they were declared. A column group is characterized by the following attributes:
A measure is a result of aggregate data calculation. Its value is typically displayed in the crosstab cells. A crosstab measure behaves just like a report variable and is completely characterized by:
ROW_COUNT and COLUMN_COUNT one can generate alternate colors for rows or columns
in a crosstab, using conditional styles:
<style name="RowStyle" isDefault="false" mode="Opaque"> <conditionalStyle> <conditionExpression><![CDATA[new Boolean($V{ROW_COUNT}.intValue() % 2 == 0)]] ></conditionExpression> <style backcolor="#E0E0E0"/> </conditionalStyle> </style>or: <style name="ColumnStyle" isDefault="false" mode="Opaque"> <conditionalStyle> <conditionExpression><![CDATA[new Boolean($V{COLUMN_COUNT}.intValue() % 2 == 0)]] ></conditionExpression> <style backcolor="#E0E0E0"/> </conditionalStyle> </style>Crosstab Cells A crosstab cell is a rectangular report element that can contain any kind of other report element, except subreports, charts, and crosstabs. Usually, crosstab cells can be either detail cells (when its both row/column correspond to a bucket value), or total cells (when at least the row or column corresponds to a group total value). Depending on their position within the crosstab, or on their special meaning, crosstab cell types are described below:
This sample contains 4 JRXML files illustrating various crosstab properties and usability.
Running the sample requires the Apache Ant library. Make sure that ant is already installed on your system (version 1.5 or later).
In a command prompt/terminal window set the current folder to demo/hsqldb within the JasperReports source project and run the > ant runServer command.
It will start the HSQLDB server shipped with the JasperReports distribution package. Let this terminal running the HSQLDB server.
Open a new command prompt/terminal window and set the current folder to demo/samples/crosstabs within the JasperReports source project and run the > ant test view command.
It will generate all supported document types for the four sample reports and save them in the demo/samples/crosstabs/build/reports directory.
Then the ShipmentsReport will open in the JasperReports internal viewer. |
|||||
|
||||||
top | ||||||
|
||||||
Datasets | Documented by Sanda Zaharia | |||||
|
||||||
| Description / Goal |
| How to make use of subdatasets for chart elements and crosstab elements. | |||
| Since |
| 1.1.0 | |||
| Other Samples |
|
|
|||
|
||||||
|
Report Datasets
A dataset is an entity that intermediates data source and subreport characteristics. Datasets allow the engine to iterate through some virtual records, just as data sources do, but they also enable calculations and data grouping during this iteration using variables and groups. A dataset declaration, containing parameters, fields, variables, and groups, is similar to subreport declarations, but datasets are not related to any visual content. There are no sections or layout information at the dataset level. The report data source, along with the parameters, fields, variables, and groups declared at the report level, represent a special dataset declaration, implicitely used in every report template, the so-called main dataset. One can consider the main dataset responsible for iterating through the report data source records, calculating variables, filtering out records, and estimating group breaks during the report-filling process. Subdatasets and Dataset Runs User-defined datasets are declared as <subDataset/> elements. To completely
characterize a subdataset
one needs to set:
Anytime a dataset is referenced by another report element, a dataset run is instantiated. A dataset run supplies additional information about either the appropriate data source to be iterated, or the database connection string. It comes also with its own parameters and/or parameters map. Dataset runs are similar to subreports in the way parameters and the data source/connection are passed in: <element name="datasetRun"> <annotation> <documentation>Subdataset instantiation information for a chart/crosstab dataset.</documentation> </annotation> <complexType> <sequence> <element ref="jr:parametersMapExpression" minOccurs="0" maxOccurs="1"/> <element ref="jr:datasetParameter" minOccurs="0" maxOccurs="unbounded"/> <choice minOccurs="0" maxOccurs="1"> <element ref="jr:connectionExpression"/> <element ref="jr:dataSourceExpression"/> </choice> </sequence> <attribute name="subDataset" type="string" use="required"> <annotation> <documentation>The name of the <elem>subdataset</elem> to instantiate.</documentation> </annotation> </attribute> </complexType> </element>The subDataset attribute is mandatory and contains the name of the subdataset to be used during the
chart or crosstab filling process. If no dataset run is specified for a chart or crosstab, the main dataset of
the report is used by default.
|
|||||
|
|
© 2001- Jaspersoft Corporation www.jaspersoft.com |