net.sf.reportengine.config

Interface DataColumn

All Known Implementing Classes:

AbstractDataColumn, DefaultDataColumn, SecondProcessDataColumn, SecondProcessDataColumnFromOriginalDataColumn, SecondProcessTotalColumn

public interface DataColumn

Data column for flat and pivot tables. Data columns are normal report columns used for displaying data and totals. The configurations supported by a data column are:

1. header
2. values to be displayed
3. group calculator (if totals of any kind are needed )
4. data formatter
5. horizontal/vertical alignment of text
6. sorting

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

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

Since:

0.4

Author:

dragos balan (dragos dot balan at gmail dot com)

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_SORTING no sorting flag

Method Summary

Modifier and Type	Method and Description
GroupCalculator	getCalculator() returns the calculator (if any) to be used on this column
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() returns the header of the column.
HorizAlign	getHorizAlign() returns the horizontal alignment of the values of this column
int	getSortLevel() The sorting priority of this column
SortType	getSortType() getter for the sort type (asc or desc)
Object	getValue(NewRowEvent newRowEvent) retrieves the value for this column.
VertAlign	getVertAlign() returns the vertical alignment of the values of this column

Field Detail

NO_SORTING

static final int NO_SORTING

no sorting flag

See Also:

Constant Field Values

Method Detail

getHeader

String getHeader()

returns the header of the column. The header will be displayed in the final report as the header of this column and it shouldn't be confused with the column name in case the report input is an SQL query

Returns:

the header of the report column

getFormattedValue

String getFormattedValue(Object value)

returns the formatted value ready to be displayed in the report

Parameters:

value - the unformatted value

Returns:

the formatted value

getFormattedTotal

String getFormattedTotal(Object totalValue)

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

Parameters:

totalValue -

Returns:

the formatted total as a string

getValue

Object getValue(NewRowEvent newRowEvent)

retrieves the value for this column. This is the most important method as it retrieves the data for the row-column combination.

Parameters:

newRowEvent - the event containing the new row of data as an array

Returns:

the computed value for this column

getCalculator

GroupCalculator getCalculator()

returns the calculator (if any) to be used on this column

Returns:

the group calculator

getHorizAlign

HorizAlign getHorizAlign()

returns the horizontal alignment of the values of this column

Returns:

the horizontal alignment of this column

getVertAlign

VertAlign getVertAlign()

returns the vertical alignment of the values of this column

Returns:

the vertical alignment

getSortLevel

int getSortLevel()

The sorting priority of this column

Returns:

the sorting priority

getSortType

SortType getSortType()

getter for the sort type (asc or desc)

Returns:

the sort type