net.sf.reportengine.config

Class DefaultDataColumn

java.lang.Object

net.sf.reportengine.config.AbstractDataColumn

net.sf.reportengine.config.DefaultDataColumn

All Implemented Interfaces:

DataColumn

public class DefaultDataColumn
extends AbstractDataColumn

This is the basic implementation for a data column.

The functionality is based on an inputColumnIndex, so this column takes all its values from an input column (inputColumnIndex).

Example:
For the input:

a1	b1	c1
a2	b2	c2
a3	b3	c3

I. a default column having inputColumnIndex=0 will display

a1

a2

a3

II. for inputColumnIndex=2 this column will display

c1

c2

c3

Please keep in mind that inputColumnIndex is a zero based index.
The other attributes of this column are : 1. header 2. valuesFormatter 3. horizontal alignment 4. calculator

Since:

0.4

Author:

dragos balan (dragos dot balan at gmail dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultDataColumn.Builder

Field Summary

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

NO_SORTING

Constructor Summary

Constructors

Constructor and Description
DefaultDataColumn() default constructor.
DefaultDataColumn(int inputColumnIndex)
DefaultDataColumn(String header, int inputColumnIndex)
DefaultDataColumn(String header, int inputColumnIndex, GroupCalculator calculator)
DefaultDataColumn(String header, int inputColumnIndex, GroupCalculator calculator, String formatter)
DefaultDataColumn(String header, int inputColumnIndex, GroupCalculator calculator, String formatter, HorizAlign horizAlign)
DefaultDataColumn(String header, int inputColumnIndex, GroupCalculator calculator, String formatter, HorizAlign horizAlign, int sortLevel)
DefaultDataColumn(String header, int inputColumnIndex, GroupCalculator calculator, String formatter, HorizAlign horizAlign, VertAlign vertAlign, int sortLevel, SortType sortType)

Method Summary

Modifier and Type	Method and Description
int	getInputColumnIndex() returns the index of the original (input) column displayed on this column
Object	getValue(NewRowEvent newRowEvent) retrieves the value for this column.
void	setInputColumnIndex(int inputColumnIndex) sets the index of the original (input) column to be displayed on this column
String	toString()

Methods inherited from class net.sf.reportengine.config.AbstractDataColumn

getCalculator, getFormattedTotal, getFormattedValue, getHeader, getHorizAlign, getSortLevel, getSortType, getTotalsFormatter, getValuesFormatter, getVertAlign, setCalculator, setHeader, setHorizAlign, setSortLevel, setSortType, setTotalsFormatter, setValuesFormatter, setVertAlign

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDataColumn

public DefaultDataColumn()

default constructor. Assumes inputColumn=0 no calculator header=Column 0 no valuesFormatter

DefaultDataColumn

public DefaultDataColumn(int inputColumnIndex)

Parameters:

inputColumnIndex -

DefaultDataColumn

public DefaultDataColumn(String header,
                         int inputColumnIndex)

Parameters:

header -

inputColumnIndex -

DefaultDataColumn

public DefaultDataColumn(String header,
                         int inputColumnIndex,
                         GroupCalculator calculator)

Parameters:

header -

inputColumnIndex -

calculatorsFactory -

DefaultDataColumn

public DefaultDataColumn(String header,
                         int inputColumnIndex,
                         GroupCalculator calculator,
                         String formatter)

Parameters:

header -

inputColumnIndex -

calculator -

valuesFormatter -

DefaultDataColumn

public DefaultDataColumn(String header,
                         int inputColumnIndex,
                         GroupCalculator calculator,
                         String formatter,
                         HorizAlign horizAlign)

Parameters:

header -

inputColumnIndex -

calculator -

valuesFormatter -

horizAlign - horizontal alignment

DefaultDataColumn

public DefaultDataColumn(String header,
                         int inputColumnIndex,
                         GroupCalculator calculator,
                         String formatter,
                         HorizAlign horizAlign,
                         int sortLevel)

Parameters:

header -

inputColumnIndex -

calculator -

valuesFormatter -

horizAlign - horizontal alignment

sortLevel -

DefaultDataColumn

public DefaultDataColumn(String header,
                         int inputColumnIndex,
                         GroupCalculator calculator,
                         String formatter,
                         HorizAlign horizAlign,
                         VertAlign vertAlign,
                         int sortLevel,
                         SortType sortType)

Parameters:

header -

inputColumnIndex -

calculator -

valuesFormatter -

horizAlign - the horizontal alignment

vertAlign - the vertical alignment

sortLevel -

sortType -

Method Detail

getValue

public Object getValue(NewRowEvent newRowEvent)

Description copied from interface: DataColumn

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

getInputColumnIndex

public int getInputColumnIndex()

returns the index of the original (input) column displayed on this column

Returns:

the input column index

setInputColumnIndex

public void setInputColumnIndex(int inputColumnIndex)

sets the index of the original (input) column to be displayed on this column

Parameters:

inputColumnIndex -

toString

public String toString()

Overrides:

toString in class Object