net.sf.reportengine.config

Interface GroupColumn

All Known Implementing Classes:

AbstractGroupColumn, DefaultGroupColumn, SecondProcessGroupColumn

public interface GroupColumn

Group column for flat and pivot tables. Group columns are helpful when one needs to group rows in order to show sub totals for each group or just a better display of the data. A correct group configuration consists of:

1. adding a group column to the table
2. and setting a GroupCalculator (like SUM, AVG, MIN, MAX etc.) to at least one of the data columns of the table

Note: there's no limit to the number of data columns that can have GroupCalculators Let’s see an example with my monthly expenses. For the input:

  August      food    500$ 
  August      gas     300$ 
  September   food    567$ 
  September   gas     154$ 
  September   fun     200$ 
 

If we declare the first column as a group column and we add a Sum calculator to the last data column then ReportEngine will make sure to display the totals at each change in the values of the first column:

  August      food    500$ 
  August      gas     300$ 
  Total August        800$
  September   food    567$ 
  September   gas     154$ 
  September   fun     200$ 
  Total September     921$
  Grand Total         1721$
 

Other settings available for the group columns are:

1. setting the priority of this group column (useful when more group columns are set to the table)
2. setting the header of the column
3. setting the format of the displayed values
4. setting the horizontal and the vertical alignment
5. displaying the duplicated values

Usage: After building it, a group column should be set to the table as in the example below:

      FlatTable table = new FlatTableBuilder()
          ...
          .addGroupColumn( ... group column here ...)
          ...
          .addDataColumn( ... data column here ... )
          .addDataColumn(... data column here ... )
          ...
          .build(); 
  

Since:

0.4

Author:

dragos balan (dragos dot balan at gmail dot com)

Method Summary

Modifier and Type	Method and Description
String	getFormattedValue(Object object) returns the formatted value for the given object according to the formatting rules of this grouping column
int	getGroupingLevel() getter for the priority of this column The grouping levels start with 0 (the most important), 1, 2, 3 ..
String	getHeader() this appears in the final report as the title/header of the column
HorizAlign	getHorizAlign() returns the horizontal alignment of the values of this column
SortType	getSortType() whether you want to sort this ascending or descending
Object	getValue(NewRowEvent newRowEvent) getter for the current value on this column
VertAlign	getVertAlign() returns the vertical alignment of the values of this column
boolean	showDuplicates() whether or not this group column should display duplicate group values.

Method Detail

getHeader

String getHeader()

this appears in the final report as the title/header of the column

Returns:

the header of this column

getGroupingLevel

int getGroupingLevel()

getter for the priority of this column The grouping levels start with 0 (the most important), 1, 2, 3 ..

Returns:

an integer representing the priority of this group column

getValue

Object getValue(NewRowEvent newRowEvent)

getter for the current value on this column

Parameters:

newRowEvent - the new row event

Returns:

the value of this column

getFormattedValue

String getFormattedValue(Object object)

returns the formatted value for the given object according to the formatting rules of this grouping column

Parameters:

object - an unformatted value

getHorizAlign

HorizAlign getHorizAlign()

returns the horizontal alignment of the values of this column

getVertAlign

VertAlign getVertAlign()

returns the vertical alignment of the values of this column

Returns:

the vertical alignment for this column

showDuplicates

boolean showDuplicates()

whether or not this group column should display duplicate group values. Usually there are many group values displayed one after the other

Europe	South	100
Europe	North	207
Europe	East	103
Europe	West	120

This method controls whether the duplicated Europe value should be displayed multiple times or not:

Europe	South	100
	North	207
	East	103
	West	120
Asia	South	300
	North	267
	East	564
	West	122

Returns:

getSortType

SortType getSortType()

whether you want to sort this ascending or descending

Returns: