net.sf.reportengine.config

Class AbstractGroupColumn

java.lang.Object

net.sf.reportengine.config.AbstractGroupColumn

All Implemented Interfaces:

GroupColumn

Direct Known Subclasses:

DefaultGroupColumn

public abstract class AbstractGroupColumn
extends Object
implements GroupColumn

Since:

0.4

Author:

dragos balan (dragos dot balan at gmail dot com)

Constructor Summary

Constructors

Constructor and Description
AbstractGroupColumn(String header, int groupingLevel, String valuesFormatter, HorizAlign horizAlign, boolean showDuplicates)
AbstractGroupColumn(String header, int groupingLevel, String valuesFormatter, HorizAlign horizAlign, VertAlign vertAlign, boolean showDuplicates)
AbstractGroupColumn(String header, int groupingLevel, String valuesFormatter, HorizAlign horizAlign, VertAlign vertAlign, boolean showDuplicates, SortType sortType)

Method Summary

Modifier and Type	Method and Description
String	getFormattedValue(Object value) 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
String	getValuesFormatter()
VertAlign	getVertAlign() returns the vertical alignment of the values of this column
void	setGroupingLevel(int groupingLevel)
void	setHeader(String header)
void	setHorizAlign(HorizAlign horizAlign)
void	setShowDuplicates(boolean flag)
void	setSortType(SortType sortType)
void	setValuesFormatter(String formatter) setter for the formatter of this column's values
void	setVertAlign(VertAlign vertAlign)
boolean	showDuplicates() whether or not this group column should display duplicate group values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.reportengine.config.GroupColumn

getValue

Constructor Detail

AbstractGroupColumn

public AbstractGroupColumn(String header,
                           int groupingLevel,
                           String valuesFormatter,
                           HorizAlign horizAlign,
                           boolean showDuplicates)

Parameters:

header -

groupingLevel -

valuesFormatter -

horizAlign -

showDuplicates -

AbstractGroupColumn

public AbstractGroupColumn(String header,
                           int groupingLevel,
                           String valuesFormatter,
                           HorizAlign horizAlign,
                           VertAlign vertAlign,
                           boolean showDuplicates)

Parameters:

header -

groupingLevel -

valuesFormatter -

horizAlign -

vertAlign -

showDuplicates -

AbstractGroupColumn

public AbstractGroupColumn(String header,
                           int groupingLevel,
                           String valuesFormatter,
                           HorizAlign horizAlign,
                           VertAlign vertAlign,
                           boolean showDuplicates,
                           SortType sortType)

Parameters:

header -

groupingLevel -

valuesFormatter -

horizAlign -

vertAlign -

showDuplicates -

sortType -

Method Detail

getGroupingLevel

public int getGroupingLevel()

Description copied from interface: GroupColumn

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

Specified by:

getGroupingLevel in interface GroupColumn

Returns:

an integer representing the priority of this group column

setGroupingLevel

public void setGroupingLevel(int groupingLevel)

Parameters:

groupingLevel -

getHeader

public String getHeader()

Description copied from interface: GroupColumn

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

Specified by:

getHeader in interface GroupColumn

Returns:

the header of this column

setHeader

public void setHeader(String header)

Parameters:

header -

getFormattedValue

public String getFormattedValue(Object value)

Description copied from interface: GroupColumn

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

Specified by:

getFormattedValue in interface GroupColumn

Parameters:

value - an unformatted value

getValuesFormatter

public String getValuesFormatter()

Returns:

the formatter of this column's values

setValuesFormatter

public void setValuesFormatter(String formatter)

setter for the formatter of this column's values

Parameters:

formatter - the formatter of the values

getHorizAlign

public HorizAlign getHorizAlign()

Description copied from interface: GroupColumn

returns the horizontal alignment of the values of this column

Specified by:

getHorizAlign in interface GroupColumn

Returns:

the horizontal alignment

setHorizAlign

public void setHorizAlign(HorizAlign horizAlign)

Parameters:

horizAlign - the horizAlign to set

getVertAlign

public VertAlign getVertAlign()

Description copied from interface: GroupColumn

returns the vertical alignment of the values of this column

Specified by:

getVertAlign in interface GroupColumn

Returns:

the vertical alignment

setVertAlign

public void setVertAlign(VertAlign vertAlign)

Parameters:

vertAlign - the vertical alignment

showDuplicates

public boolean showDuplicates()

Description copied from interface: GroupColumn

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

Specified by:

showDuplicates in interface GroupColumn

Returns:

setShowDuplicates

public void setShowDuplicates(boolean flag)

Parameters:

flag -

getSortType

public SortType getSortType()

Description copied from interface: GroupColumn

whether you want to sort this ascending or descending

Specified by:

getSortType in interface GroupColumn

Returns:

setSortType

public void setSortType(SortType sortType)

Parameters:

sortType -