net.sf.reportengine.config

Class AbstractDataColumn

java.lang.Object

net.sf.reportengine.config.AbstractDataColumn

All Implemented Interfaces:

DataColumn

Direct Known Subclasses:

DefaultDataColumn

public abstract class AbstractDataColumn
extends Object
implements DataColumn

Author:

dragos balan

Field Summary

Fields inherited from interface net.sf.reportengine.config.DataColumn

NO_SORTING

Constructor Summary

Constructors

Constructor and Description
AbstractDataColumn(String header)
AbstractDataColumn(String header, GroupCalculator calculator)
AbstractDataColumn(String header, GroupCalculator calculator, String valuesFormatter)
AbstractDataColumn(String header, GroupCalculator calculator, String valuesFormatter, HorizAlign horizAlign)
AbstractDataColumn(String header, GroupCalculator calculator, String valuesFormatter, HorizAlign horizAlign, int sortLevel)
AbstractDataColumn(String header, GroupCalculator calculator, String valuesFormatter, HorizAlign horizAlign, VertAlign vertAlign, int sortLevel)
AbstractDataColumn(String header, GroupCalculator calculator, String valuesFormatter, HorizAlign horizAlign, VertAlign vertAlign, int sortLevel, SortType sortType)
AbstractDataColumn(String header, GroupCalculator calculator, String valuesFormatter, String totalsFormatter, HorizAlign horizAlign, VertAlign vertAlign, int sortLevel, SortType sortType)

Method Summary

Modifier and Type	Method and Description
GroupCalculator	getCalculator() getter for this column's calculator (if any)
String	getFormattedTotal(Object totalValue) returns the formatted value of the total as it will be displayed in the report
String	getFormattedValue(Object value) returns the formatted value ready to be displayed in the report
String	getHeader() getter for the column header
HorizAlign	getHorizAlign() returns the horizontal alignment of the values of this column
int	getSortLevel() getter for the sorting priority
SortType	getSortType() Asc or Desc
String	getTotalsFormatter() getter for formatter of the totals
String	getValuesFormatter() getter for the formater of this column's values
VertAlign	getVertAlign() returns the vertical alignment of the values of this column
void	setCalculator(GroupCalculator calculator)
void	setHeader(String header) setter for the header of the column
void	setHorizAlign(HorizAlign horizAlign)
void	setSortLevel(int sortLevel) setter for the sorting priority of the column
void	setSortType(SortType sortType) setter for the type of sorting (asc or desc)
void	setTotalsFormatter(String formatter) sets a formatter for totals displayed on this column.
void	setValuesFormatter(String formatter) sets a valuesFormatter for this column.
void	setVertAlign(VertAlign vertAlign)

Methods inherited from class java.lang.Object

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

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

getValue

Constructor Detail

AbstractDataColumn

public AbstractDataColumn(String header)

Parameters:

header -

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator)

Parameters:

header -

calculator -

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator,
                          String valuesFormatter)

Parameters:

header -

calculator -

valuesFormatter -

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator,
                          String valuesFormatter,
                          HorizAlign horizAlign)

Parameters:

header -

calculator -

valuesFormatter -

horizAlign -

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator,
                          String valuesFormatter,
                          HorizAlign horizAlign,
                          int sortLevel)

Parameters:

header -

calculator -

valuesFormatter -

horizAlign -

sortLevel -

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator,
                          String valuesFormatter,
                          HorizAlign horizAlign,
                          VertAlign vertAlign,
                          int sortLevel)

Parameters:

header - the header of this column

calculator - the calculator

valuesFormatter - the valuesFormatter

horizAlign - the horizontal alignment

vertAlign - the vertical alignment

sortLevel - the sorting level

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator,
                          String valuesFormatter,
                          HorizAlign horizAlign,
                          VertAlign vertAlign,
                          int sortLevel,
                          SortType sortType)

Parameters:

header - the header of this column

calculator - the calculator

valuesFormatter - the valuesFormatter

horizAlign - the horizontal alignment

vertAlign - the vertical alignment

sortLevel - the sorting level

sortType - the sorting type (asc, desc)

AbstractDataColumn

public AbstractDataColumn(String header,
                          GroupCalculator calculator,
                          String valuesFormatter,
                          String totalsFormatter,
                          HorizAlign horizAlign,
                          VertAlign vertAlign,
                          int sortLevel,
                          SortType sortType)

Parameters:

header - the header of this column

calculator - the calculator

valuesFormatter - the valuesFormatter

totalsFormatter - the valuesFormatter

horizAlign - the horizontal alignment

vertAlign - the vertical alignment

sortLevel - the sorting level

sortType - the sorting type (asc, desc)

Method Detail

getHeader

public String getHeader()

getter for the column header

Specified by:

getHeader in interface DataColumn

Returns:

the header of the report column

setHeader

public void setHeader(String header)

setter for the header of the column

Parameters:

header -

getFormattedValue

public String getFormattedValue(Object value)

Description copied from interface: DataColumn

returns the formatted value ready to be displayed in the report

Specified by:

getFormattedValue in interface DataColumn

Parameters:

value - the unformatted value

Returns:

the formatted value

getFormattedTotal

public String getFormattedTotal(Object totalValue)

Description copied from interface: DataColumn

returns the formatted value of the total as it will be displayed in the report

Specified by:

getFormattedTotal in interface DataColumn

Returns:

the formatted total as a string

getCalculator

public GroupCalculator getCalculator()

getter for this column's calculator (if any)

Specified by:

getCalculator in interface DataColumn

Returns:

the group calculator

setCalculator

public void setCalculator(GroupCalculator calculator)

Parameters:

calculator -

setValuesFormatter

public void setValuesFormatter(String formatter)

sets a valuesFormatter for this column. All values of this column will be formatted using this valuesFormatter when the report engine calls getFormattedValue(Object)

Parameters:

formatter - the formatter of the values

getValuesFormatter

public String getValuesFormatter()

getter for the formater of this column's values

Returns:

the formatter

setTotalsFormatter

public void setTotalsFormatter(String formatter)

sets a formatter for totals displayed on this column. All values of this column will be formatted when the report engine calls getFormattedTotal(Object)

Parameters:

formatter - the formatter of this column's values

getTotalsFormatter

public String getTotalsFormatter()

getter for formatter of the totals

Returns:

the formatter of the total values

getHorizAlign

public HorizAlign getHorizAlign()

Description copied from interface: DataColumn

returns the horizontal alignment of the values of this column

Specified by:

getHorizAlign in interface DataColumn

Returns:

the horizontal alignment of this column

setHorizAlign

public void setHorizAlign(HorizAlign horizAlign)

Parameters:

horizAlign - the horizAlign to set

getVertAlign

public VertAlign getVertAlign()

Description copied from interface: DataColumn

returns the vertical alignment of the values of this column

Specified by:

getVertAlign in interface DataColumn

Returns:

the vertical alignment

setVertAlign

public void setVertAlign(VertAlign vertAlign)

Parameters:

vertAlign - the vertical alignment

getSortLevel

public int getSortLevel()

getter for the sorting priority

Specified by:

getSortLevel in interface DataColumn

Returns:

the sorting priority

setSortLevel

public void setSortLevel(int sortLevel)

setter for the sorting priority of the column

Parameters:

sortLevel -

setSortType

public void setSortType(SortType sortType)

setter for the type of sorting (asc or desc)

Parameters:

sortType - the type of sorting

getSortType

public SortType getSortType()

Asc or Desc

Specified by:

getSortType in interface DataColumn

Returns:

the sort type for this column