Package net.sf.dynamicreports.report.builder

Class DynamicReports

java.lang.Object

net.sf.dynamicreports.report.builder.DynamicReports

public class DynamicReports
extends Object

DynamicReports class.

Author:

Ricardo Mariaca

Field Summary

Fields

Modifier and Type	Field	Description
static final BarcodeBuilders	bcode	A set of methods of creating barcodes.
static final ChartBuilders	cht	A set of methods of creating and customizing charts.
static final ComponentBuilders	cmp	A set of methods of creating components.
static final ConditionBuilders	cnd	A set of build in condition expressions.
static final ColumnBuilders	col	A set of methods of creating report columns. It is used to display data in a multi-column layout.
static final CrosstabBuilders	ctab	A set of methods of creating and customizing crosstabs.
static final ExpressionBuilders	exp	A set of build in expressions. Expressions are used to define various calculations, conditions, text field content, specific report groups, etc.
static final ExporterBuilders	export	A set of methods of creating exporters.
static final GridBuilders	grid	A set of methods of customizing columns layout.
static final GroupBuilders	grp	A set of methods of creating report groups.
static final SubtotalBuilders	sbt	A set of methods of creating column subtotals.
static final StyleBuilders	stl	A set of methods of creating and customizing styles.
static final DataTypeBuilders	type	A set of build in data types.

Constructor Summary

Constructors

Constructor	Description
DynamicReports()

Method Summary

Modifier and Type	Method	Description
static SortBuilder	asc(String fieldName, Class<?> valueClass)	asc.
static SortBuilder	asc(TextColumnBuilder<?> column)	asc.
static SortBuilder	asc(FieldBuilder<?> field)	asc.
static SortBuilder	asc(VariableBuilder<?> variable)	asc.
static SortBuilder	asc(DRIExpression<?> expression)	asc.
static int	cm(Number value)	cm.
static JasperConcatenatedReportBuilder	concatenatedReport()	Creates a new concatenated report builder.
static JasperConcatenatedReportBuilder	concatenatedReport(JasperReportHandler jasperReportHandler)	Creates a new concatenated report builder.
static DatasetBuilder	dataset()	dataset.
static SortBuilder	desc(String fieldName, Class<?> valueClass)	desc.
static SortBuilder	desc(TextColumnBuilder<?> column)	desc.
static SortBuilder	desc(FieldBuilder<?> field)	desc.
static SortBuilder	desc(VariableBuilder<?> variable)	desc.
static SortBuilder	desc(DRIExpression<?> expression)	desc.
static <T> FieldBuilder<T>	field(String name, Class valueClass)	field.
static <T> FieldBuilder<T>	field(String name, DRIDataType dataType)	field.
static HyperLinkBuilder	hyperLink()	hyperLink.
static HyperLinkBuilder	hyperLink(String link)	hyperLink.
static HyperLinkBuilder	hyperLink(DRIExpression<String> linkExpression)	hyperLink.
static int	inch(Number value)	inch.
static MarginBuilder	margin()	margin.
static MarginBuilder	margin(int margin)	margin.
static int	mm(Number value)	mm.
static <T> ParameterBuilder<T>	parameter(String name, Class<T> valueClass)	parameter.
static <T> ParameterBuilder<T>	parameter(String name, T value)	parameter.
static QueryBuilder	query(String text, String language)	query.
static JasperReportBuilder	report()	Creates a new report builder.
static TableOfContentsCustomizerBuilder	tableOfContentsCustomizer()	tableOfContentsCustomizer.
static TableOfContentsHeadingBuilder	tableOfContentsHeading()	tableOfContentsHeading.
static TableOfContentsHeadingBuilder	tableOfContentsHeading(String label)	tableOfContentsHeading.
static ReportTemplateBuilder	template()	template.
static <T> VariableBuilder<T>	variable(String fieldName, Class<?> valueClass, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(String name, String fieldName, Class<?> valueClass, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(String name, ValueColumnBuilder<?,?> column, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(String name, FieldBuilder<T> field, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(String name, DRIExpression<?> expression, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(ValueColumnBuilder<?,?> column, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(FieldBuilder<T> field, Calculation calculation)	variable.
static <T> VariableBuilder<T>	variable(DRIExpression<?> expression, Calculation calculation)	variable.

Methods inherited from class java.lang.Object

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

Field Details

col

public static final ColumnBuilders col

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

grid

public static final GridBuilders grid

A set of methods of customizing columns layout.

grp

public static final GroupBuilders grp

A set of methods of creating report groups.

sbt

public static final SubtotalBuilders sbt

A set of methods of creating column subtotals.

stl

public static final StyleBuilders stl

A set of methods of creating and customizing styles.

cmp

public static final ComponentBuilders cmp

A set of methods of creating components.

exp

public static final ExpressionBuilders exp

A set of build in expressions.
Expressions are used to define various calculations, conditions, text field content, specific report groups, etc.

cnd

public static final ConditionBuilders cnd

A set of build in condition expressions.

type

public static final DataTypeBuilders type

A set of build in data types.

cht

public static final ChartBuilders cht

A set of methods of creating and customizing charts.

export

public static final ExporterBuilders export

A set of methods of creating exporters.

bcode

public static final BarcodeBuilders bcode

A set of methods of creating barcodes.

ctab

public static final CrosstabBuilders ctab

A set of methods of creating and customizing crosstabs.

Constructor Details

DynamicReports

public DynamicReports()

Method Details

report

public static JasperReportBuilder report()

Creates a new report builder. The most used report builder for creating reports. It allows constructing and customizing the whole report content.

Returns:

a report builder

concatenatedReport

public static JasperConcatenatedReportBuilder concatenatedReport()

Creates a new concatenated report builder. This report builder allows concatenating several separated reports into one single document.

Returns:

a report builder

concatenatedReport

public static JasperConcatenatedReportBuilder concatenatedReport(JasperReportHandler jasperReportHandler)

Creates a new concatenated report builder. This report builder allows concatenating several separated reports into one single document.

Parameters:

jasperReportHandler - a JasperReportHandler object.

Returns:

a report builder

field

public static <T> FieldBuilder<T> field(String name,
 Class valueClass)

field.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

valueClass - a Class object.

Returns:

a FieldBuilder object.

field

public static <T> FieldBuilder<T> field(String name,
 DRIDataType dataType)

field.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

dataType - a DRIDataType object.

Returns:

a FieldBuilder object.

variable

public static <T> VariableBuilder<T> variable(ValueColumnBuilder<?,?> column,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

column - a ValueColumnBuilder object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(String name,
 ValueColumnBuilder<?,?> column,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

column - a ValueColumnBuilder object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(FieldBuilder<T> field,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

field - a FieldBuilder object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(String name,
 FieldBuilder<T> field,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

field - a FieldBuilder object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(String fieldName,
 Class<?> valueClass,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

fieldName - a String object.

valueClass - a Class object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(String name,
 String fieldName,
 Class<?> valueClass,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

fieldName - a String object.

valueClass - a Class object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(DRIExpression<?> expression,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

expression - a DRIExpression object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

variable

public static <T> VariableBuilder<T> variable(String name,
 DRIExpression<?> expression,
 Calculation calculation)

variable.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

expression - a DRIExpression object.

calculation - a Calculation object.

Returns:

a VariableBuilder object.

asc

public static SortBuilder asc(TextColumnBuilder<?> column)

asc.

Parameters:

column - a TextColumnBuilder object.

Returns:

a SortBuilder object.

asc

public static SortBuilder asc(FieldBuilder<?> field)

asc.

Parameters:

field - a FieldBuilder object.

Returns:

a SortBuilder object.

asc

public static SortBuilder asc(String fieldName,
 Class<?> valueClass)

asc.

Parameters:

fieldName - a String object.

valueClass - a Class object.

Returns:

a SortBuilder object.

asc

public static SortBuilder asc(VariableBuilder<?> variable)

asc.

Parameters:

variable - a VariableBuilder object.

Returns:

a SortBuilder object.

asc

public static SortBuilder asc(DRIExpression<?> expression)

asc.

Parameters:

expression - a DRIExpression object.

Returns:

a SortBuilder object.

desc

public static SortBuilder desc(TextColumnBuilder<?> column)

desc.

Parameters:

column - a TextColumnBuilder object.

Returns:

a SortBuilder object.

desc

public static SortBuilder desc(FieldBuilder<?> field)

desc.

Parameters:

field - a FieldBuilder object.

Returns:

a SortBuilder object.

desc

public static SortBuilder desc(String fieldName,
 Class<?> valueClass)

desc.

Parameters:

fieldName - a String object.

valueClass - a Class object.

Returns:

a SortBuilder object.

desc

public static SortBuilder desc(VariableBuilder<?> variable)

desc.

Parameters:

variable - a VariableBuilder object.

Returns:

a SortBuilder object.

desc

public static SortBuilder desc(DRIExpression<?> expression)

desc.

Parameters:

expression - a DRIExpression object.

Returns:

a SortBuilder object.

hyperLink

public static HyperLinkBuilder hyperLink()

hyperLink.

Returns:

a HyperLinkBuilder object.

hyperLink

public static HyperLinkBuilder hyperLink(String link)

hyperLink.

Parameters:

link - a String object.

Returns:

a HyperLinkBuilder object.

hyperLink

public static HyperLinkBuilder hyperLink(DRIExpression<String> linkExpression)

hyperLink.

Parameters:

linkExpression - a DRIExpression object.

Returns:

a HyperLinkBuilder object.

margin

public static MarginBuilder margin()

margin.

Returns:

a MarginBuilder object.

margin

public static MarginBuilder margin(int margin)

margin.

Parameters:

margin - a int.

Returns:

a MarginBuilder object.

parameter

public static <T> ParameterBuilder<T> parameter(String name,
 T value)

parameter.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

value - a T object.

Returns:

a ParameterBuilder object.

parameter

public static <T> ParameterBuilder<T> parameter(String name,
 Class<T> valueClass)

parameter.

Type Parameters:

T - a T object.

Parameters:

name - a String object.

valueClass - a Class object.

Returns:

a ParameterBuilder object.

query

public static QueryBuilder query(String text,
 String language)

query.

Parameters:

text - a String object.

language - a String object.

Returns:

a QueryBuilder object.

cm

public static int cm(Number value)

cm.

Parameters:

value - a Number object.

Returns:

a int.

inch

public static int inch(Number value)

inch.

Parameters:

value - a Number object.

Returns:

a int.

mm

public static int mm(Number value)

mm.

Parameters:

value - a Number object.

Returns:

a int.

template

public static ReportTemplateBuilder template()

template.

Returns:

a ReportTemplateBuilder object.

tableOfContentsCustomizer

public static TableOfContentsCustomizerBuilder tableOfContentsCustomizer()

tableOfContentsCustomizer.

Returns:

a TableOfContentsCustomizerBuilder object.

tableOfContentsHeading

public static TableOfContentsHeadingBuilder tableOfContentsHeading()

tableOfContentsHeading.

Returns:

a TableOfContentsHeadingBuilder object.

tableOfContentsHeading

public static TableOfContentsHeadingBuilder tableOfContentsHeading(String label)

tableOfContentsHeading.

Parameters:

label - a String object.

Returns:

a TableOfContentsHeadingBuilder object.

dataset

public static DatasetBuilder dataset()

dataset.

Returns:

a DatasetBuilder object.