net.sf.dynamicreports.report.builder.column

Class ColumnBuilders

java.lang.Object

net.sf.dynamicreports.report.builder.column.ColumnBuilders

public class ColumnBuilders
extends Object

A set of methods of creating report columns.
It is used to display data in a multi-column layout.

Author:

Ricardo Mariaca

Constructor Summary

Constructors

Constructor and Description
ColumnBuilders()

Method Summary

Modifier and Type	Method and Description
BooleanColumnBuilder	booleanColumn(DRIExpression<Boolean> expression) Creates a new boolean column. It shows a boolean value either as a text or as an image.
BooleanColumnBuilder	booleanColumn(FieldBuilder<Boolean> field) Creates a new boolean column. It shows a boolean value either as a text or as an image.
BooleanColumnBuilder	booleanColumn(String fieldName) Creates a new boolean column. It shows a boolean value either as a text or as an image.
BooleanColumnBuilder	booleanColumn(String title, DRIExpression<Boolean> expression) Creates a new boolean column. It shows a boolean value either as a text or as an image.
BooleanColumnBuilder	booleanColumn(String title, FieldBuilder<Boolean> field) Creates a new boolean column. It shows a boolean value either as a text or as an image.
BooleanColumnBuilder	booleanColumn(String title, String fieldName) Creates a new boolean column. It shows a boolean value either as a text or as an image.
<T> TextColumnBuilder<T>	column(DRIExpression<T> expression) Creates a new expression column. The column values are defined in an expression.
<T> TextColumnBuilder<T>	column(FieldBuilder<T> field) Creates a new column. It is used to show values from the data source.
<T> TextColumnBuilder<T>	column(String fieldName, Class<T> valueClass) Creates a new column. It is used to show values from the data source.
<T> TextColumnBuilder<T>	column(String fieldName, DRIDataType<? super T,T> dataType) Creates a new column. It is used to show values from the data source.
<T> TextColumnBuilder<T>	column(String title, DRIExpression<T> expression) Creates a new expression column. The column values are defined in an expression.
<T> TextColumnBuilder<T>	column(String title, FieldBuilder<T> field) Creates a new column. It is used to show values from the data source.
<T> TextColumnBuilder<T>	column(String title, String fieldName, Class<T> valueClass) Creates a new column. It is used to show values from the data source.
<T> TextColumnBuilder<T>	column(String title, String fieldName, DRIDataType<? super T,T> dataType) Creates a new column. It is used to show values from the data source.
TextColumnBuilder<Integer>	columnRowNumberColumn() Creates a new row number column. It displays row numbers, the row number is reset on each new column.
TextColumnBuilder<Integer>	columnRowNumberColumn(String title) Creates a new row number column. It displays row numbers, the row number is reset on each new column.
ComponentColumnBuilder	componentColumn(ComponentBuilder<?,?> component) Creates a new component column. It is used to display custom components (e.g.
ComponentColumnBuilder	componentColumn(String title, ComponentBuilder<?,?> component) Creates a new component column. It is used to display custom components (e.g.
TextColumnBuilder<String>	emptyColumn() Creates a new empty column.
TextColumnBuilder<String>	emptyColumn(boolean showTitle, boolean showDetailRows) Creates a new empty column.
TextColumnBuilder<Integer>	pageRowNumberColumn() Creates a new row number column. It displays row numbers, the row number is reset on each new page.
TextColumnBuilder<Integer>	pageRowNumberColumn(String title) Creates a new row number column. It displays row numbers, the row number is reset on each new page.
PercentageColumnBuilder	percentageColumn(FieldBuilder<? extends Number> field) Creates a new percentage column. It calculates percentage values from field values.
PercentageColumnBuilder	percentageColumn(String fieldName, Class<? extends Number> valueClass) Creates a new percentage column. It calculates percentage values from field values.
PercentageColumnBuilder	percentageColumn(String title, FieldBuilder<? extends Number> field) Creates a new percentage column. It calculates percentage values from field values.
PercentageColumnBuilder	percentageColumn(String title, String fieldName, Class<? extends Number> valueClass) Creates a new percentage column. It calculates percentage values from field values.
PercentageColumnBuilder	percentageColumn(String title, ValueColumnBuilder<?,? extends Number> column) Creates a new percentage column. It calculates percentage values from column values.
PercentageColumnBuilder	percentageColumn(ValueColumnBuilder<?,? extends Number> column) Creates a new percentage column. It calculates percentage values from column values.
TextColumnBuilder<Integer>	reportRowNumberColumn() Creates a new row number column. It displays row numbers.
TextColumnBuilder<Integer>	reportRowNumberColumn(String title) Creates a new row number column. It displays row numbers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnBuilders

public ColumnBuilders()

Method Detail

column

public <T> TextColumnBuilder<T> column(String fieldName,
                                       Class<T> valueClass)

Creates a new column.
It is used to show values from the data source.

Type Parameters:

T - a T object.

Parameters:

fieldName - the name of the field

valueClass - the field value class

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(String title,
                                       String fieldName,
                                       Class<T> valueClass)

Creates a new column.
It is used to show values from the data source.

Type Parameters:

T - a T object.

Parameters:

title - the column title

fieldName - the name of the field

valueClass - the field value class

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(String fieldName,
                                       DRIDataType<? super T,T> dataType)

Creates a new column.
It is used to show values from the data source.

Type Parameters:

T - a T object.

Parameters:

fieldName - the name of the field

dataType - the field data type

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(String title,
                                       String fieldName,
                                       DRIDataType<? super T,T> dataType)

Creates a new column.
It is used to show values from the data source.

Type Parameters:

T - a T object.

Parameters:

title - the column title

fieldName - the name of the field

dataType - the field data type

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(FieldBuilder<T> field)

Creates a new column.
It is used to show values from the data source.

Type Parameters:

T - a T object.

Parameters:

field - the field definition

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(String title,
                                       FieldBuilder<T> field)

Creates a new column.
It is used to show values from the data source.

Type Parameters:

T - a T object.

Parameters:

title - the column title

field - the field definition

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(DRIExpression<T> expression)

Creates a new expression column.
The column values are defined in an expression.

Type Parameters:

T - a T object.

Parameters:

expression - the value expression

Returns:

a column builder

column

public <T> TextColumnBuilder<T> column(String title,
                                       DRIExpression<T> expression)

Creates a new expression column.
The column values are defined in an expression.

Type Parameters:

T - a T object.

Parameters:

title - the column title

expression - the value expression

Returns:

a column builder

percentageColumn

public PercentageColumnBuilder percentageColumn(ValueColumnBuilder<?,? extends Number> column)

Creates a new percentage column.
It calculates percentage values from column values.

Parameters:

column - the column definition

Returns:

a column builder

percentageColumn

public PercentageColumnBuilder percentageColumn(String title,
                                                ValueColumnBuilder<?,? extends Number> column)

Creates a new percentage column.
It calculates percentage values from column values.

Parameters:

title - the column title

column - the column definition

Returns:

a column builder

percentageColumn

public PercentageColumnBuilder percentageColumn(String fieldName,
                                                Class<? extends Number> valueClass)

Creates a new percentage column.
It calculates percentage values from field values.

Parameters:

fieldName - the name of the field

valueClass - the field value class

Returns:

a column builder

percentageColumn

public PercentageColumnBuilder percentageColumn(String title,
                                                String fieldName,
                                                Class<? extends Number> valueClass)

Creates a new percentage column.
It calculates percentage values from field values.

Parameters:

title - the column title

fieldName - the name of the field

valueClass - the field value class

Returns:

a column builder

percentageColumn

public PercentageColumnBuilder percentageColumn(FieldBuilder<? extends Number> field)

Creates a new percentage column.
It calculates percentage values from field values.

Parameters:

field - the field definition

Returns:

a column builder

percentageColumn

public PercentageColumnBuilder percentageColumn(String title,
                                                FieldBuilder<? extends Number> field)

Creates a new percentage column.
It calculates percentage values from field values.

Parameters:

title - the column title

field - the field definition

Returns:

a column builder

columnRowNumberColumn

public TextColumnBuilder<Integer> columnRowNumberColumn()

Creates a new row number column.
It displays row numbers, the row number is reset on each new column.

Returns:

a column builder

columnRowNumberColumn

public TextColumnBuilder<Integer> columnRowNumberColumn(String title)

Creates a new row number column.
It displays row numbers, the row number is reset on each new column.

Parameters:

title - the column title

Returns:

a column builder

pageRowNumberColumn

public TextColumnBuilder<Integer> pageRowNumberColumn()

Creates a new row number column.
It displays row numbers, the row number is reset on each new page.

Returns:

a column builder

pageRowNumberColumn

public TextColumnBuilder<Integer> pageRowNumberColumn(String title)

Creates a new row number column.
It displays row numbers, the row number is reset on each new page.

Parameters:

title - the column title

Returns:

a column builder

reportRowNumberColumn

public TextColumnBuilder<Integer> reportRowNumberColumn()

Creates a new row number column.
It displays row numbers.

Returns:

a column builder

reportRowNumberColumn

public TextColumnBuilder<Integer> reportRowNumberColumn(String title)

Creates a new row number column.
It displays row numbers.

Parameters:

title - the column title

Returns:

a column builder

componentColumn

public ComponentColumnBuilder componentColumn(ComponentBuilder<?,?> component)

Creates a new component column.
It is used to display custom components (e.g. images or complex content) in columns.

Parameters:

component - the component definition

Returns:

a column builder

componentColumn

public ComponentColumnBuilder componentColumn(String title,
                                              ComponentBuilder<?,?> component)

Creates a new component column.
It is used to display custom components (e.g. images or complex content) in columns.

Parameters:

title - the column title

component - the component definition

Returns:

a column builder

booleanColumn

public BooleanColumnBuilder booleanColumn(String fieldName)

Creates a new boolean column.
It shows a boolean value either as a text or as an image.

Parameters:

fieldName - the name of the field

Returns:

a column builder

booleanColumn

public BooleanColumnBuilder booleanColumn(String title,
                                          String fieldName)

Creates a new boolean column.
It shows a boolean value either as a text or as an image.

Parameters:

title - the column title

fieldName - the name of the field

Returns:

a column builder

booleanColumn

public BooleanColumnBuilder booleanColumn(FieldBuilder<Boolean> field)

Creates a new boolean column.
It shows a boolean value either as a text or as an image.

Parameters:

field - the field definition

Returns:

a column builder

booleanColumn

public BooleanColumnBuilder booleanColumn(String title,
                                          FieldBuilder<Boolean> field)

Creates a new boolean column.
It shows a boolean value either as a text or as an image.

Parameters:

title - the column title

field - the field definition

Returns:

a column builder

booleanColumn

public BooleanColumnBuilder booleanColumn(DRIExpression<Boolean> expression)

Creates a new boolean column.
It shows a boolean value either as a text or as an image.

Parameters:

expression - the boolean value expression

Returns:

a column builder

booleanColumn

public BooleanColumnBuilder booleanColumn(String title,
                                          DRIExpression<Boolean> expression)

Creates a new boolean column.
It shows a boolean value either as a text or as an image.

Parameters:

title - the column title

expression - the boolean value expression

Returns:

a column builder

emptyColumn

public TextColumnBuilder<String> emptyColumn()

Creates a new empty column.

Returns:

a column builder

emptyColumn

public TextColumnBuilder<String> emptyColumn(boolean showTitle,
                                             boolean showDetailRows)

Creates a new empty column.

Parameters:

showTitle - show column title

showDetailRows - show detail rows

Returns:

a column builder