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
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:
-
Field Summary
Fields inherited from class net.sf.dynamicreports.report.builder.AbstractBuilder
builded
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionexport
(AbstractJasperExporterBuilder<?, ? extends AbstractJasperExporter> exporterBuilder) export.Getter for the fieldconnection
.net.sf.jasperreports.engine.JRDataSource
Getter for the fielddataSource
.getJasperParameters.print()
print.print
(boolean withPrintDialog) print.rebuild()
rebuild.setConnection
(Connection connection) Setter for the fieldconnection
.setDataSource
(String sql, Connection connection) Sets a database data source.setDataSource
(ResultSet resultSet) Sets a database data source.setDataSource
(Collection<?> collection) Sets a data source object.setDataSource
(QueryBuilder query, Connection connection) Sets a database data source.setDataSource
(net.sf.jasperreports.engine.JRDataSource dataSource) Sets a data source object.setParameter
(String name, Object value) setParameters
(Map<String, Object> parameters) setStartPageNumber
(Integer startPageNumber) Setter for the fieldstartPageNumber
.setTemplateDesign
(File file) setTemplateDesign.setTemplateDesign
(InputStream inputStream) setTemplateDesign.setTemplateDesign
(String fileName) setTemplateDesign.setTemplateDesign
(URL jasperDesignUrl) setTemplateDesign.setTemplateDesign
(net.sf.jasperreports.engine.design.JasperDesign jasperDesign) setTemplateDesign.setVirtualizer
(net.sf.jasperreports.engine.JRVirtualizer virtualizer) Setter for the fieldvirtualizer
.show()
show.show
(boolean exitOnClose) show.showJrXml.toCsv
(OutputStream outputStream) toCsv.toCsv
(JasperCsvExporterBuilder csvExporterBuilder) toCsv.toDocx
(OutputStream outputStream) toDocx.toDocx
(JasperDocxExporterBuilder docxExporterBuilder) toDocx.toHtml
(OutputStream outputStream) toHtml.toHtml
(JasperHtmlExporterBuilder htmlExporterBuilder) toHtml.toImage
(OutputStream outputStream, ImageType imageType) toImage.toImage
(JasperImageExporterBuilder imageExporterBuilder) toImage.net.sf.jasperreports.engine.design.JasperDesign
toJasperDesign.net.sf.jasperreports.engine.JasperPrint
toJasperPrint.net.sf.jasperreports.engine.JasperReport
toJasperReport.toJrXml
(OutputStream outputStream) toJrXml.toJson
(OutputStream outputStream) toJson.toJson
(JasperJsonExporterBuilder jsonExporterBuilder) toJson.toOds
(OutputStream outputStream) toOds.toOds
(JasperOdsExporterBuilder odsExporterBuilder) toOds.toOdt
(OutputStream outputStream) toOdt.toOdt
(JasperOdtExporterBuilder odtExporterBuilder) toOdt.toPdf
(OutputStream outputStream) toPdf.toPdf
(JasperPdfExporterBuilder pdfExporterBuilder) toPdf.toPptx
(OutputStream outputStream) toPptx.toPptx
(JasperPptxExporterBuilder pptxExporterBuilder) toPptx.toRtf
(OutputStream outputStream) toRtf.toRtf
(JasperRtfExporterBuilder rtfExporterBuilder) toRtf.toText
(OutputStream outputStream) toText.toText
(JasperTextExporterBuilder textExporterBuilder) toText.toXls
(OutputStream outputStream) toXls.toXls
(JasperXlsExporterBuilder xlsExporterBuilder) toXls.toXlsx
(OutputStream outputStream) toXlsx.toXlsx
(JasperXlsxExporterBuilder xlsxExporterBuilder) toXlsx.toXml
(OutputStream outputStream) toXml.toXml
(JasperXmlExporterBuilder xmlExporterBuilder) 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
-
Constructor Details
-
JasperReportBuilder
public JasperReportBuilder()Constructor for JasperReportBuilder.
-
-
Method Details
-
setStartPageNumber
Setter for the field
startPageNumber
.- Parameters:
startPageNumber
- aInteger
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
setDataSource
Sets a data source object. Creates a new JRBeanCollectionDataSource data source object.- Parameters:
collection
- - the collection values- Returns:
- a report builder
-
setDataSource
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
Sets a database data source. In this type of data source, data are retrieved from a database.- Parameters:
sql
- - the sql queryconnection
- - the database connection- Returns:
- a report builder
-
setDataSource
Sets a database data source. In this type of data source, data are retrieved from a database.- Parameters:
query
- - the query definitionconnection
- - the database connection- Returns:
- a report builder
-
setTemplateDesign
setTemplateDesign.
- Parameters:
inputStream
- aInputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
setTemplateDesign
setTemplateDesign.
- Parameters:
file
- aFile
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
setTemplateDesign
setTemplateDesign.
- Parameters:
fileName
- aString
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
- aJasperDesign
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
setTemplateDesign
setTemplateDesign.
- Parameters:
jasperDesignUrl
- aURL
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
setParameter
- Overrides:
setParameter
in classReportBuilder<JasperReportBuilder>
-
setParameters
- Overrides:
setParameters
in classReportBuilder<JasperReportBuilder>
-
rebuild
rebuild.
- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toJasperDesign
toJasperDesign.
- Returns:
- a
JasperDesign
object. - Throws:
DRException
- if any.
-
toJasperReport
toJasperReport.
- Returns:
- a
JasperReport
object. - Throws:
DRException
- if any.
-
getJasperParameters
getJasperParameters.
- Returns:
- a
Map
object. - Throws:
DRException
- if any.
-
toJasperPrint
toJasperPrint.
- Returns:
- a
JasperPrint
object. - Throws:
DRException
- if any.
-
show
show.
- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
show
show.
- Parameters:
exitOnClose
- a boolean.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
showJrXml
showJrXml.
- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toJrXml
toJrXml.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
print
print.
- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
print
print.
- Parameters:
withPrintDialog
- a boolean.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
setVirtualizer
Setter for the field
virtualizer
.- Parameters:
virtualizer
- aJRVirtualizer
object.- Returns:
- a
JasperReportBuilder
object.
-
toImage
public JasperReportBuilder toImage(OutputStream outputStream, ImageType imageType) throws DRException toImage.
- Parameters:
outputStream
- aOutputStream
object.imageType
- aImageType
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toImage
public JasperReportBuilder toImage(JasperImageExporterBuilder imageExporterBuilder) throws DRException toImage.
- Parameters:
imageExporterBuilder
- aJasperImageExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toCsv
toCsv.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toCsv
toCsv.
- Parameters:
csvExporterBuilder
- aJasperCsvExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toDocx
toDocx.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toDocx
toDocx.
- Parameters:
docxExporterBuilder
- aJasperDocxExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toHtml
toHtml.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toHtml
toHtml.
- Parameters:
htmlExporterBuilder
- aJasperHtmlExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toJson
toJson.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toJson
toJson.
- Parameters:
htmlExporterBuilder
- aJasperJsonExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toOds
toOds.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toOds
toOds.
- Parameters:
odsExporterBuilder
- aJasperOdsExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toOdt
toOdt.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toOdt
toOdt.
- Parameters:
odtExporterBuilder
- aJasperOdtExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toPdf
toPdf.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toPdf
toPdf.
- Parameters:
pdfExporterBuilder
- aJasperPdfExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toRtf
toRtf.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toRtf
toRtf.
- Parameters:
rtfExporterBuilder
- aJasperRtfExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toText
toText.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toText
toText.
- Parameters:
textExporterBuilder
- aJasperTextExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toXls
toXls.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toXls
toXls.
- Parameters:
xlsExporterBuilder
- aJasperXlsExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toXlsx
toXlsx.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toXlsx
toXlsx.
- Parameters:
xlsxExporterBuilder
- aJasperXlsxExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toXml
toXml.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toXml
toXml.
- Parameters:
xmlExporterBuilder
- aJasperXmlExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toPptx
toPptx.
- Parameters:
outputStream
- aOutputStream
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
toPptx
toPptx.
- Parameters:
pptxExporterBuilder
- aJasperPptxExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
export
public JasperReportBuilder export(AbstractJasperExporterBuilder<?, ? extends AbstractJasperExporter> exporterBuilder) throws DRExceptionexport.
- Parameters:
exporterBuilder
- aAbstractJasperExporterBuilder
object.- Returns:
- a
JasperReportBuilder
object. - Throws:
DRException
- if any.
-
getConnection
Getter for the field
connection
.- Returns:
- a
Connection
object.
-
setConnection
Setter for the field
connection
.- Parameters:
connection
- aConnection
object.- Returns:
- a
JasperReportBuilder
object.
-
getDataSource
public net.sf.jasperreports.engine.JRDataSource getDataSource()Getter for the field
dataSource
.- Returns:
- a
JRDataSource
object.
-
setDataSource
Sets a data source object.- Parameters:
dataSource
- - the JRDataSource object- Returns:
- a report builder
-