net.sf.dynamicreports.jasper.builder

Class JasperReportBuilder

java.lang.Object

net.sf.dynamicreports.report.builder.AbstractBuilder<T,DRReport>

net.sf.dynamicreports.report.builder.ReportBuilder<JasperReportBuilder>

net.sf.dynamicreports.jasper.builder.JasperReportBuilder

All Implemented Interfaces:

Serializable

public class JasperReportBuilder
extends ReportBuilder<JasperReportBuilder>

The most used report builder for creating reports. It allows constructing and customizing the whole report content. A report consists of bands, columns, subtotals, groups, and other parts. Each part is created and configured using a particular builder method and it's passed to the report builder instance.

Author:

Ricardo Mariaca

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder

builded

Constructor Summary

Constructors

Constructor and Description
JasperReportBuilder() Constructor for JasperReportBuilder.

Method Summary

Modifier and Type	Method and Description
JasperReportBuilder	export(AbstractJasperExporterBuilder<?,? extends AbstractJasperExporter> exporterBuilder) export.
Connection	getConnection() Getter for the field connection.
net.sf.jasperreports.engine.JRDataSource	getDataSource() Getter for the field dataSource.
Map<String,Object>	getJasperParameters() getJasperParameters.
JasperReportBuilder	print() print.
JasperReportBuilder	print(boolean withPrintDialog) print.
JasperReportBuilder	rebuild() rebuild.
JasperReportBuilder	setConnection(Connection connection) Setter for the field connection.
JasperReportBuilder	setDataSource(Collection<?> collection) Sets a data source object.
JasperReportBuilder	setDataSource(net.sf.jasperreports.engine.JRDataSource dataSource) Sets a data source object.
JasperReportBuilder	setDataSource(QueryBuilder query, Connection connection) Sets a database data source.
JasperReportBuilder	setDataSource(ResultSet resultSet) Sets a database data source.
JasperReportBuilder	setDataSource(String sql, Connection connection) Sets a database data source.
JasperReportBuilder	setParameter(String name, Object value)
JasperReportBuilder	setParameters(Map<String,Object> parameters)
JasperReportBuilder	setStartPageNumber(Integer startPageNumber) Setter for the field startPageNumber.
JasperReportBuilder	setTemplateDesign(File file) setTemplateDesign.
JasperReportBuilder	setTemplateDesign(InputStream inputStream) setTemplateDesign.
JasperReportBuilder	setTemplateDesign(net.sf.jasperreports.engine.design.JasperDesign jasperDesign) setTemplateDesign.
JasperReportBuilder	setTemplateDesign(String fileName) setTemplateDesign.
JasperReportBuilder	setTemplateDesign(URL jasperDesignUrl) setTemplateDesign.
JasperReportBuilder	setVirtualizer(net.sf.jasperreports.engine.JRVirtualizer virtualizer) Setter for the field virtualizer.
JasperReportBuilder	show() show.
JasperReportBuilder	show(boolean exitOnClose) show.
JasperReportBuilder	showJrXml() showJrXml.
JasperReportBuilder	toCsv(JasperCsvExporterBuilder csvExporterBuilder) toCsv.
JasperReportBuilder	toCsv(OutputStream outputStream) toCsv.
JasperReportBuilder	toDocx(JasperDocxExporterBuilder docxExporterBuilder) toDocx.
JasperReportBuilder	toDocx(OutputStream outputStream) toDocx.
JasperReportBuilder	toHtml(JasperHtmlExporterBuilder htmlExporterBuilder) toHtml.
JasperReportBuilder	toHtml(OutputStream outputStream) toHtml.
JasperReportBuilder	toImage(JasperImageExporterBuilder imageExporterBuilder) toImage.
JasperReportBuilder	toImage(OutputStream outputStream, ImageType imageType) toImage.
net.sf.jasperreports.engine.design.JasperDesign	toJasperDesign() toJasperDesign.
net.sf.jasperreports.engine.JasperPrint	toJasperPrint() toJasperPrint.
net.sf.jasperreports.engine.JasperReport	toJasperReport() toJasperReport.
JasperReportBuilder	toJrXml(OutputStream outputStream) toJrXml.
JasperReportBuilder	toOds(JasperOdsExporterBuilder odsExporterBuilder) toOds.
JasperReportBuilder	toOds(OutputStream outputStream) toOds.
JasperReportBuilder	toOdt(JasperOdtExporterBuilder odtExporterBuilder) toOdt.
JasperReportBuilder	toOdt(OutputStream outputStream) toOdt.
JasperReportBuilder	toPdf(JasperPdfExporterBuilder pdfExporterBuilder) toPdf.
JasperReportBuilder	toPdf(OutputStream outputStream) toPdf.
JasperReportBuilder	toPptx(JasperPptxExporterBuilder pptxExporterBuilder) toPptx.
JasperReportBuilder	toPptx(OutputStream outputStream) toPptx.
JasperReportBuilder	toRtf(JasperRtfExporterBuilder rtfExporterBuilder) toRtf.
JasperReportBuilder	toRtf(OutputStream outputStream) toRtf.
JasperReportBuilder	toText(JasperTextExporterBuilder textExporterBuilder) toText.
JasperReportBuilder	toText(OutputStream outputStream) toText.
JasperReportBuilder	toXls(JasperXlsExporterBuilder xlsExporterBuilder) toXls.
JasperReportBuilder	toXls(OutputStream outputStream) toXls.
JasperReportBuilder	toXlsx(JasperXlsxExporterBuilder xlsxExporterBuilder) toXlsx.
JasperReportBuilder	toXlsx(OutputStream outputStream) toXlsx.
JasperReportBuilder	toXml(JasperXmlExporterBuilder xmlExporterBuilder) toXml.
JasperReportBuilder	toXml(OutputStream outputStream) toXml.

Methods inherited from class net.sf.dynamicreports.report.builder.ReportBuilder

addBackground, addColumn, addColumnFooter, addColumnHeader, addDetail, addDetailFooter, addDetailHeader, addDetailRowHighlighter, addField, addField, addField, addGroup, addGroupFooter, addGroupHeader, addLastPageFooter, addNoData, addPageFooter, addPageHeader, addParameter, addParameter, addParameter, addProperty, addScriptlet, addSort, addSubtotalAtColumnFooter, addSubtotalAtColumnHeader, addSubtotalAtFirstGroupFooter, addSubtotalAtFirstGroupHeader, addSubtotalAtGroupFooter, addSubtotalAtGroupHeader, addSubtotalAtLastGroupFooter, addSubtotalAtLastGroupHeader, addSubtotalAtLastPageFooter, addSubtotalAtPageFooter, addSubtotalAtPageHeader, addSubtotalAtSummary, addSubtotalAtTitle, addSubtotalOfPercentageAtGroupFooter, addSubtotalOfPercentageAtGroupHeader, addSummary, addTemplateStyle, addTemplateStyle, addTitle, addVariable, background, columnFooter, columnGrid, columnGrid, columnGrid, columnHeader, columns, detail, detailFooter, detailHeader, detailRowHighlighters, fields, floatColumnFooter, getReport, groupBy, groupBy, groupFooter, groupHeader, highlightDetailEvenRows, highlightDetailOddRows, ignorePageWidth, ignorePagination, lastPageFooter, noData, pageFooter, pageHeader, parameters, scriptlets, setBackgroundBackgroundComponent, setBackgroundPrintWhenExpression, setBackgroundSplitType, setBackgroundStyle, setBarcodeStyle, setChartStyle, setColumnDirection, setColumnFooterBackgroundComponent, setColumnFooterPrintWhenExpression, setColumnFooterSplitType, setColumnFooterStyle, setColumnHeaderBackgroundComponent, setColumnHeaderPrintWhenExpression, setColumnHeaderSplitType, setColumnHeaderStyle, setColumnStyle, setColumnTitleStyle, setDefaultFont, setDetailBackgroundComponent, setDetailEvenRowStyle, setDetailFooterBackgroundComponent, setDetailFooterPrintWhenExpression, setDetailFooterSplitType, setDetailFooterStyle, setDetailHeaderBackgroundComponent, setDetailHeaderPrintWhenExpression, setDetailHeaderSplitType, setDetailHeaderStyle, setDetailOddRowStyle, setDetailPrintWhenExpression, setDetailSplitType, setDetailStyle, setFilterExpression, setFloatColumnFooter, setGroupFooterBackgroundComponent, setGroupFooterPrintWhenExpression, setGroupFooterSplitType, setGroupFooterStyle, setGroupHeaderBackgroundComponent, setGroupHeaderPrintWhenExpression, setGroupHeaderSplitType, setGroupHeaderStyle, setGroupStyle, setGroupTitleStyle, setHighlightDetailEvenRows, setHighlightDetailOddRows, setIgnorePageWidth, setIgnorePagination, setImageStyle, setLanguage, setLastPageFooterBackgroundComponent, setLastPageFooterPrintWhenExpression, setLastPageFooterSplitType, setLastPageFooterStyle, setLocale, setNoDataBackgroundComponent, setNoDataPrintWhenExpression, setNoDataSplitType, setNoDataStyle, setPageColumnSpace, setPageColumnsPerPage, setPageFooterBackgroundComponent, setPageFooterPrintWhenExpression, setPageFooterSplitType, setPageFooterStyle, setPageFormat, setPageFormat, setPageFormat, setPageHeaderBackgroundComponent, setPageHeaderPrintWhenExpression, setPageHeaderSplitType, setPageHeaderStyle, setPageMargin, setPrintOrder, setProperties, setQuery, setQuery, setQuery, setReportName, setResourceBundle, setResourceBundle, setShowColumnTitle, setShowColumnValues, setSubtotalStyle, setSummaryBackgroundComponent, setSummaryOnANewPage, setSummaryPrintWhenExpression, setSummarySplitType, setSummaryStyle, setSummaryWithPageHeaderAndFooter, setTableOfContents, setTableOfContents, setTableOfContents, setTemplate, setTextStyle, setTitleBackgroundComponent, setTitleOnANewPage, setTitlePrintWhenExpression, setTitleSplitType, setTitleStyle, setUseFieldNameAsDescription, setWhenNoDataType, setWhenResourceMissingType, sortBy, sortBy, subtotalsAtColumnFooter, subtotalsAtColumnHeader, subtotalsAtFirstGroupFooter, subtotalsAtFirstGroupHeader, subtotalsAtGroupFooter, subtotalsAtGroupHeader, subtotalsAtLastGroupFooter, subtotalsAtLastGroupHeader, subtotalsAtLastPageFooter, subtotalsAtPageFooter, subtotalsAtPageHeader, subtotalsAtSummary, subtotalsAtTitle, subtotalsOfPercentageAtGroupFooter, subtotalsOfPercentageAtGroupHeader, summary, summaryOnANewPage, summaryWithPageHeaderAndFooter, tableOfContents, tableOfContents, tableOfContents, templateStyles, templateStyles, title, titleOnANewPage, variables

Methods inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder

build, configure, getObject

Methods inherited from class java.lang.Object

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

Constructor Detail

JasperReportBuilder

public JasperReportBuilder()

Constructor for JasperReportBuilder.

Method Detail

setStartPageNumber

public JasperReportBuilder setStartPageNumber(Integer startPageNumber)
                                       throws DRException

Setter for the field startPageNumber.

Parameters:

startPageNumber - a Integer object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setDataSource

public JasperReportBuilder setDataSource(Collection<?> collection)

Sets a data source object. Creates a new JRBeanCollectionDataSource data source object.

Parameters:

collection - - the collection values

Returns:

a report builder

setDataSource

public JasperReportBuilder setDataSource(ResultSet resultSet)

Sets a database data source. In this type of data source, data are retrieved from a database.

Parameters:

resultSet - - the resultSet object

Returns:

a report builder

setDataSource

public JasperReportBuilder setDataSource(String sql,
                                         Connection connection)

Sets a database data source. In this type of data source, data are retrieved from a database.

Parameters:

sql - - the sql query

connection - - the database connection

Returns:

a report builder

setDataSource

public JasperReportBuilder setDataSource(QueryBuilder query,
                                         Connection connection)

Sets a database data source. In this type of data source, data are retrieved from a database.

Parameters:

query - - the query definition

connection - - the database connection

Returns:

a report builder

setTemplateDesign

public JasperReportBuilder setTemplateDesign(InputStream inputStream)
                                      throws DRException

setTemplateDesign.

Parameters:

inputStream - a InputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setTemplateDesign

public JasperReportBuilder setTemplateDesign(File file)
                                      throws DRException

setTemplateDesign.

Parameters:

file - a File object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setTemplateDesign

public JasperReportBuilder setTemplateDesign(String fileName)
                                      throws DRException

setTemplateDesign.

Parameters:

fileName - a String object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setTemplateDesign

public JasperReportBuilder setTemplateDesign(net.sf.jasperreports.engine.design.JasperDesign jasperDesign)
                                      throws DRException

setTemplateDesign.

Parameters:

jasperDesign - a JasperDesign object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setTemplateDesign

public JasperReportBuilder setTemplateDesign(URL jasperDesignUrl)
                                      throws DRException

setTemplateDesign.

Parameters:

jasperDesignUrl - a URL object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setParameter

public JasperReportBuilder setParameter(String name,
                                        Object value)

Overrides:

setParameter in class ReportBuilder<JasperReportBuilder>

setParameters

public JasperReportBuilder setParameters(Map<String,Object> parameters)

Overrides:

setParameters in class ReportBuilder<JasperReportBuilder>

rebuild

public JasperReportBuilder rebuild()
                            throws DRException

rebuild.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toJasperDesign

public net.sf.jasperreports.engine.design.JasperDesign toJasperDesign()
                                                               throws DRException

toJasperDesign.

Returns:

a JasperDesign object.

Throws:

DRException - if any.

toJasperReport

public net.sf.jasperreports.engine.JasperReport toJasperReport()
                                                        throws DRException

toJasperReport.

Returns:

a JasperReport object.

Throws:

DRException - if any.

getJasperParameters

public Map<String,Object> getJasperParameters()
                                       throws DRException

getJasperParameters.

Returns:

a Map object.

Throws:

DRException - if any.

toJasperPrint

public net.sf.jasperreports.engine.JasperPrint toJasperPrint()
                                                      throws DRException

toJasperPrint.

Returns:

a JasperPrint object.

Throws:

DRException - if any.

show

public JasperReportBuilder show()
                         throws DRException

show.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

show

public JasperReportBuilder show(boolean exitOnClose)
                         throws DRException

show.

Parameters:

exitOnClose - a boolean.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

showJrXml

public JasperReportBuilder showJrXml()
                              throws DRException

showJrXml.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toJrXml

public JasperReportBuilder toJrXml(OutputStream outputStream)
                            throws DRException

toJrXml.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

print

public JasperReportBuilder print()
                          throws DRException

print.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

print

public JasperReportBuilder print(boolean withPrintDialog)
                          throws DRException

print.

Parameters:

withPrintDialog - a boolean.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

setVirtualizer

public JasperReportBuilder setVirtualizer(net.sf.jasperreports.engine.JRVirtualizer virtualizer)

Setter for the field virtualizer.

Parameters:

virtualizer - a JRVirtualizer object.

Returns:

a JasperReportBuilder object.

toImage

public JasperReportBuilder toImage(OutputStream outputStream,
                                   ImageType imageType)
                            throws DRException

toImage.

Parameters:

outputStream - a OutputStream object.

imageType - a ImageType object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toImage

public JasperReportBuilder toImage(JasperImageExporterBuilder imageExporterBuilder)
                            throws DRException

toImage.

Parameters:

imageExporterBuilder - a JasperImageExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toCsv

public JasperReportBuilder toCsv(OutputStream outputStream)
                          throws DRException

toCsv.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toCsv

public JasperReportBuilder toCsv(JasperCsvExporterBuilder csvExporterBuilder)
                          throws DRException

toCsv.

Parameters:

csvExporterBuilder - a JasperCsvExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toDocx

public JasperReportBuilder toDocx(OutputStream outputStream)
                           throws DRException

toDocx.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toDocx

public JasperReportBuilder toDocx(JasperDocxExporterBuilder docxExporterBuilder)
                           throws DRException

toDocx.

Parameters:

docxExporterBuilder - a JasperDocxExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toHtml

public JasperReportBuilder toHtml(OutputStream outputStream)
                           throws DRException

toHtml.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toHtml

public JasperReportBuilder toHtml(JasperHtmlExporterBuilder htmlExporterBuilder)
                           throws DRException

toHtml.

Parameters:

htmlExporterBuilder - a JasperHtmlExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toOds

public JasperReportBuilder toOds(OutputStream outputStream)
                          throws DRException

toOds.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toOds

public JasperReportBuilder toOds(JasperOdsExporterBuilder odsExporterBuilder)
                          throws DRException

toOds.

Parameters:

odsExporterBuilder - a JasperOdsExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toOdt

public JasperReportBuilder toOdt(OutputStream outputStream)
                          throws DRException

toOdt.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toOdt

public JasperReportBuilder toOdt(JasperOdtExporterBuilder odtExporterBuilder)
                          throws DRException

toOdt.

Parameters:

odtExporterBuilder - a JasperOdtExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toPdf

public JasperReportBuilder toPdf(OutputStream outputStream)
                          throws DRException

toPdf.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toPdf

public JasperReportBuilder toPdf(JasperPdfExporterBuilder pdfExporterBuilder)
                          throws DRException

toPdf.

Parameters:

pdfExporterBuilder - a JasperPdfExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toRtf

public JasperReportBuilder toRtf(OutputStream outputStream)
                          throws DRException

toRtf.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toRtf

public JasperReportBuilder toRtf(JasperRtfExporterBuilder rtfExporterBuilder)
                          throws DRException

toRtf.

Parameters:

rtfExporterBuilder - a JasperRtfExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toText

public JasperReportBuilder toText(OutputStream outputStream)
                           throws DRException

toText.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toText

public JasperReportBuilder toText(JasperTextExporterBuilder textExporterBuilder)
                           throws DRException

toText.

Parameters:

textExporterBuilder - a JasperTextExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toXls

public JasperReportBuilder toXls(OutputStream outputStream)
                          throws DRException

toXls.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toXls

public JasperReportBuilder toXls(JasperXlsExporterBuilder xlsExporterBuilder)
                          throws DRException

toXls.

Parameters:

xlsExporterBuilder - a JasperXlsExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toXlsx

public JasperReportBuilder toXlsx(OutputStream outputStream)
                           throws DRException

toXlsx.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toXlsx

public JasperReportBuilder toXlsx(JasperXlsxExporterBuilder xlsxExporterBuilder)
                           throws DRException

toXlsx.

Parameters:

xlsxExporterBuilder - a JasperXlsxExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toXml

public JasperReportBuilder toXml(OutputStream outputStream)
                          throws DRException

toXml.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toXml

public JasperReportBuilder toXml(JasperXmlExporterBuilder xmlExporterBuilder)
                          throws DRException

toXml.

Parameters:

xmlExporterBuilder - a JasperXmlExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toPptx

public JasperReportBuilder toPptx(OutputStream outputStream)
                           throws DRException

toPptx.

Parameters:

outputStream - a OutputStream object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

toPptx

public JasperReportBuilder toPptx(JasperPptxExporterBuilder pptxExporterBuilder)
                           throws DRException

toPptx.

Parameters:

pptxExporterBuilder - a JasperPptxExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

export

public JasperReportBuilder export(AbstractJasperExporterBuilder<?,? extends AbstractJasperExporter> exporterBuilder)
                           throws DRException

export.

Parameters:

exporterBuilder - a AbstractJasperExporterBuilder object.

Returns:

a JasperReportBuilder object.

Throws:

DRException - if any.

getConnection

public Connection getConnection()

Getter for the field connection.

Returns:

a Connection object.

setConnection

public JasperReportBuilder setConnection(Connection connection)

Setter for the field connection.

Parameters:

connection - a Connection object.

Returns:

a JasperReportBuilder object.

getDataSource

public net.sf.jasperreports.engine.JRDataSource getDataSource()

Getter for the field dataSource.

Returns:

a JRDataSource object.

setDataSource

public JasperReportBuilder setDataSource(net.sf.jasperreports.engine.JRDataSource dataSource)

Sets a data source object.

Parameters:

dataSource - - the JRDataSource object

Returns:

a report builder