ReportGenerator (net.sf.nervalreports:core 1.2 API)

java.lang.Object
- net.sf.nervalreports.core.ReportGenerator

```
public abstract class ReportGenerator
extends Object
```
Basic class for all generator's implementations.

A generator is a state machine of styles and commands, where each style affects all command calls after its definition (for those familiarized with fixed-pipelined OpenGL, it should be easy to get the general idea).

For example, when defined setBold(boolean) with true value, all texts added thereafter to the report will be rendered bold, until another call to setBold(boolean) is made with false value.

Also, each report element usually is added with sequential begin-end calls. For example, to add a table, one should call beginTable(int, int...), add any valid elements to it (with each specific command call) and then call endTable.

Although it's somewhat verbose, it's the best way to keep the creation easily portable to any kind of report format (html, tex, csv, ods) without any changes to the report code and, as much important, feasible to only iterate through the data once for most of the use cases (ideally, one should only iterate a single time through the report data. For example, when using a relational database, it should iterate to generate the report exactly at the same time it iterate through the ResultSet).

Page Footer and Header are defined with three elements: left, center and right, representing each one a corner of the page or its element center.

After a report is generated and no longer necessary, a call to release() is highly recommended.

To generator creators: All sanity validations to the state machine are made here with EmptyStackException and IllegalStateException.

The ReportGenerator class isn't thread-safe, but obviously each instance of a ReportGenerator should be (and in fact they are) independent, allowing the existence of multiple instances without interference between them.

Author:

farrer

Field Summary

Fields
Modifier and Type	Field and Description
`protected static float`	`PIXELS_TO_UNITS_FACTOR` Conversion factor from pixels to PDF units.
`protected float`	`UNITS_TO_PIXELS` Conversion factor from PDF units to pixels

Constructor Summary

Constructors
Constructor and Description

ReportGenerator()

Constructors
Constructor and Description
`ReportGenerator()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`ReportColor`	`addColor(int red, int green, int blue, String name)` Declare a color in RGB mode.
`void`	`addCurrentPageNumber()` Add the current page number to the report.
`void`	`addImage(byte[] img, String imgName, int width)` Add an image defined by a byte array of its format (usually it's safe to consider that all ReportGenerator's who support images will support PNG and JPG images formats here).
`void`	`addImage(byte[] img, String imgName, int width, int height)` Add an image defined by a byte array of its format, defining its width and height.
`void`	`addLineBreak()` Add a line break to the document.
`void`	`addLineSpaces(int n)` Add `n` blank lines to the report.
`void`	`addLinkedImage(String imgLink, int width)` Add an image to the document by its link.
`void`	`addLinkedImage(String imgLink, int width, int height)` Add an image to the document by its link.
`void`	`addSeparatorLine()` Add an horizontal line (-----) separator to the report.
`void`	`addTableCell(String element)` Adds a textual table cell element to the page.
`void`	`addTableCell(String element, int colspan, int rowspan)` Same of `addTableCell(String)`, but defining its spans.
`void`	`addTableHeaderCell(String columnName)` Add a table header title text for a single table column.
`void`	`addTableHeaderCell(String columnName, int colspan)` Add a table header title text.
`void`	`addTableHeaderRow(List<String> header)` Create a table header row with a predefined list of table column's titles.
`void`	`addTableRow(List<String> cells)` Generate a table line Note: only use this function if a priori (ie: at the moment of ResultSet iteration) it isn't possible to add the columns.
`void`	`addText(String text)` Add (or better, append) a contiguous text to the report.
`void`	`addTextLine(String line)` Add text to the report with a line break at end.
`void`	`addTextWithNullSupport(String text)` Add (or better, append) a contiguous text to the report, replacing `null` and empty values with '-'.
`void`	`addTotalPagesCount()` Add the number of total report pages to the report.
`void`	`beginDocument()` Start the document.
`void`	`beginDocumentBody()` Begin the report document's body, where usually are all data to report.
`void`	`beginDocumentHead()` Begin the document's head, where should lies all specific implementation declarations.
`void`	`beginGroup(ReportGroupType type)` Begin a group of report elements.
`void`	`beginGroup(ReportGroupType type, String name)` Begin a named group of report elements.
`void`	`beginPageFooterCenter()` Init the center page footer definition.
`void`	`beginPageFooterLeft()` Init the left page footer definition.
`void`	`beginPageFooterRight()` Init the right page footer definition.
`void`	`beginPageHeaderCenter()` Begin the center page header definition.
`void`	`beginPageHeaderLeft()` Begin the right page header definition.
`void`	`beginPageHeaderRight()` Begin the right page header definition.
`void`	`beginTable(int totalColumns, int... eachColumnWidth)` Begin a table, defining or not the width of all its columns.
`void`	`beginTableCell()` Begin the creation of a table element (cell), of a single column in a single row.
`void`	`beginTableCell(int colspan, int rowspan)` Begin the creation of a table element (cell).
`void`	`beginTableHeaderRow()` Begin the definition of a table header row.
`void`	`beginTableRow()` Init a table row.
`void`	`beginTableWithFixedDefinedWidth(int totalColumns, int fixedWidth)` Begin a table definition, setting all column's width to the same fixed value.
`protected void`	`checkDocumentNotFinished()` Check if document is inited and not yet finished.
`protected void`	`checkNotOpenedFooterOrHeader()` Check if no footer or header block is currently opened.
`protected void`	`checkStackState(boolean pop, net.sf.nervalreports.core.ReportGenerator.ReportBlockToken... expected)` Verify the top of currently opened commands, expecting at last one type.
`protected abstract void`	`doAddColor(ReportColor color)` Add a color to the document.
`protected abstract void`	`doAddCurrentPageNumber()` The format specific implementation of `addCurrentPageNumber()`.
`protected abstract void`	`doAddImage(byte[] img, String imgName, int width)` The format specific implementation of `addImage(byte[], java.lang.String, int)`.
`protected abstract void`	`doAddImage(byte[] img, String imgName, int width, int height)` The format specific implementation of `addImage(byte[], java.lang.String, int)`.
`protected abstract void`	`doAddLinkedImage(String imgLink, int width)` The format specific implementation of `addLinkedImage(java.lang.String, int)`.
`protected abstract void`	`doAddLinkedImage(String imgLink, int width, int height)` The format specific implementation of `addLinkedImage(java.lang.String, int)`.
`protected abstract void`	`doAddSeparatorLine()` The format specific implementation of `addSeparatorLine()`.
`protected abstract void`	`doAddTableHeaderCell(String columnName, int colspan)` The format specific implementation of `addTableHeaderCell(java.lang.String)`.
`protected abstract void`	`doAddText(String text)` The format specific implementation of `addText(java.lang.String)`.
`protected abstract void`	`doAddTotalPagesCount()` The format specific implementation of `addTotalPagesCount()`.
`protected abstract void`	`doBeginDocument()` The format specific implementation of `beginDocument()`.
`protected abstract void`	`doBeginDocumentBody()` The format specific implementation of `beginDocumentBody()`.
`protected abstract void`	`doBeginDocumentHead()` The format specific implementation of `beginDocumentHead()`.
`protected abstract void`	`doBeginGroup(ReportGroupType type, String name)` The format specific implementation of `beginGroup(net.sf.nervalreports.core.ReportGroupType)`.
`protected abstract void`	`doBeginPageFooterCenter()` The format specific implementation of `beginPageFooterCenter()`.
`protected abstract void`	`doBeginPageFooterLeft()` The format specific implementation of `beginPageFooterLeft()`.
`protected abstract void`	`doBeginPageFooterRight()` The format specific implementation of `beginPageFooterRight()`.
`protected abstract void`	`doBeginPageHeaderCenter()` The format specific implementation of `beginPageHeaderCenter()`.
`protected abstract void`	`doBeginPageHeaderLeft()` The format specific implementation of `beginPageHeaderLeft()`.
`protected abstract void`	`doBeginPageHeaderRight()` The format specific implementation of `beginPageHeaderRight()`.
`protected abstract void`	`doBeginTable(int totalColumns, int[] eachColumnWidth)` The format specific implementation of `beginTable(int, int...)`.
`protected abstract void`	`doBeginTableCell(int colspan, int rowspan)` The format specific implementation of `beginTableCell(int, int)`.
`protected abstract void`	`doBeginTableHeaderRow()` The format specific implementation of `beginTableHeaderRow()`.
`protected abstract void`	`doBeginTableRow()` The format specific implementation of `beginTableRow()`.
`protected abstract void`	`doCreateLineSpaces(int n)` The format specific implementation of `addLineSpaces(int)`.
`protected abstract void`	`doDefineMargins(int left, int top, int right, int bottom)` The format specific implementation of `setMargins(int, int, int, int)`.
`protected abstract void`	`doEndDocument()` The format specific implementation of `endDocument()`.
`protected abstract void`	`doEndDocumentBody()` The format specific implementation of `endDocumentBody()`.
`protected abstract void`	`doEndDocumentHead()` The format specific implementation of `endDocumentHead()`.
`protected abstract void`	`doEndGroup(ReportGroupType type)` The format specific implementation of `endGroup()`.
`protected abstract void`	`doEndPageFooterCenter()` The format specific implementation of `endPageFooterCenter()`.
`protected abstract void`	`doEndPageFooterLeft()` The format specific implementation of `endPageFooterLeft()`.
`protected abstract void`	`doEndPageFooterRight()` The format specific implementation of `endPageFooterRight()`.
`protected abstract void`	`doEndPageHeaderCenter()` The format specific implementation of `endPageHeaderCenter()`.
`protected abstract void`	`doEndPageHeaderLeft()` The format specific implementation of `endPageHeaderLeft()`.
`protected abstract void`	`doEndPageHeaderRight()` The format specific implementation of `endPageHeaderRight()`.
`protected abstract void`	`doEndTable()` The format specific implementation of `endTable()`.
`protected abstract void`	`doEndTableCell()` The format specific implementation of `endTableCell()`.
`protected abstract void`	`doEndTableHeaderRow()` The format specific implementation of `endTableHeaderRow()`.
`protected abstract void`	`doEndTableRow()` The format specific implementation of `endTableRow()`.
`protected abstract void`	`doHintFont(boolean serifedFont)` Implementation of the hint to use a serifed or non-serifed font.
`protected abstract void`	`doHintLanguage(String language)` The format specific implementation of `hintLanguage(String)`.
`protected abstract void`	`doLineBreak()` The format specific implementation of `addLineBreak()`.
`void`	`endDocument()` End the document.
`void`	`endDocumentBody()` End the currently opened report body.
`void`	`endDocumentHead()` End the head of the document.
`void`	`endGroup()` End the current opened group of report elements.
`void`	`endPageFooterCenter()` End the center page footer definition.
`void`	`endPageFooterLeft()` End the left page footer definition.
`void`	`endPageFooterRight()` End the right page footer definition.
`void`	`endPageHeaderCenter()` End the center page header definition.
`void`	`endPageHeaderLeft()` End the center page header definition.
`void`	`endPageHeaderRight()` End the right page header definition.
`void`	`endTable()` End the current table.
`void`	`endTableCell()` Ends the definition of a table cell element.
`void`	`endTableHeaderRow()` End the declaration of current table header row.
`void`	`endTableRow()` Ends the definition of a table row line.
`ReportColor`	`getBorderColor()`
`Float`	`getBorderWidth()`
`ReportColor`	`getEvenRowColor()`
`abstract String`	`getFileExtension()`
`ReportFontSize`	`getFontSize()`
`protected int`	`getFontSizeInPoints()`
`ReportColor`	`getHeaderBackgroundColor()`
`int[]`	`getMargins()`
`ReportColor`	`getOddRowColor()`
`ReportPaperFormat`	`getPaperFormat()`
`ReportCharset`	`getReportCharset()`
`ReportColor`	`getRowColor()`
`protected StringBuilder`	`getStringBuilder()`
`ReportTextAlignment`	`getTextAlignment()` return `textAlignment`.
`ReportColor`	`getTextColor()`
`void`	`hintLanguage(String language)` Hint the language to use.
`void`	`hintNonSerifFont()` Hint to use a non-serifed font.
`void`	`hintSerifFont()` Hint to use a serifed font.
`boolean`	`isBold()`
`abstract boolean`	`isHeaderAndFooterDeclarationAtDocumentHead()`
`protected boolean`	`isInsideHeaderOrFooter()`
`boolean`	`isItalic()`
`void`	`release()` Clear all references of the report generation (including temporary files created) when they are no more necessary (for example, on reports generated for web applications, after it is sent to the client).
`void`	`saveToFile(String filename)` Save the contents of the generated report to a file.
`void`	`setBold(boolean bold)` Define `bold`.
`void`	`setEvenRowColor(ReportColor evenRowColor)` Set `evenRowColor`.
`void`	`setFontSize(ReportFontSize fontSize)` Set `fontSize`.
`void`	`setHeaderBackgroundColor(ReportColor headerBackgroundColor)` Set `headerBackgroundColor`.
`void`	`setItalic(boolean italic)` Define `italic`.
`void`	`setMargins(int left, int top, int right, int bottom)` Define the document's page margins.
`void`	`setOddRowColor(ReportColor oddRowColor)` Set `oddRowColor`.
`void`	`setPaper(ReportPaperFormat paperFormat)` Set the paper format to use for the whole document (default is `A4`).
`void`	`setReportCharset(ReportCharset charset)` Define the character set to use.
`void`	`setRowColor(ReportColor rowColor)` Set `rowColor`.
`void`	`setTableBorderStyle(Float borderWidth, ReportColor borderColor)` Set table border style that will take effect for next `beginTable(int, int...)` call.
`void`	`setTextAlignment(ReportTextAlignment textAlignment)` Set `textAlignment`.
`void`	`setTextColor(ReportColor color)` Define `textColor`.
`abstract boolean`	`supportImages()`
`abstract boolean`	`supportImagesOfJarFilesOrURLs()`
`byte[]`	`toByteArray()` Get the byte array representation of the generated report.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PIXELS_TO_UNITS_FACTOR
```
protected static final float PIXELS_TO_UNITS_FACTOR
```
    Conversion factor from pixels to PDF units.
    
    See Also:
    
    Constant Field Values
  - UNITS_TO_PIXELS
```
protected final float UNITS_TO_PIXELS
```
    Conversion factor from PDF units to pixels
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReportGenerator
```
public ReportGenerator()
```
- Method Detail
  - getFileExtension
```
public abstract String getFileExtension()
```
    Returns:
    
    String to be used as extension to the files generated by the generator.
  - supportImages
```
public abstract boolean supportImages()
```
    Returns:
    
    if the implemented generator supports images (if not supported, should avoid some image - graphs and plots, for example - creation).
  - supportImagesOfJarFilesOrURLs
```
public abstract boolean supportImagesOfJarFilesOrURLs()
```
    Returns:
    
    if the implemented generator supports both images inside jars or remote web images.
  - isHeaderAndFooterDeclarationAtDocumentHead
```
public abstract boolean isHeaderAndFooterDeclarationAtDocumentHead()
```
    Returns:
    
    if header and footer must be declared at document head (true) or body (false).
  - doBeginDocument
```
protected abstract void doBeginDocument()
                                 throws Exception
```
    The format specific implementation of beginDocument().
    
    Throws:
    
    Exception - in case of failure.
  - doEndDocument
```
protected abstract void doEndDocument()
                               throws Exception
```
    The format specific implementation of endDocument().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginDocumentHead
```
protected abstract void doBeginDocumentHead()
                                     throws Exception
```
    The format specific implementation of beginDocumentHead().
    
    Throws:
    
    Exception - in case of failure.
  - doAddColor
```
protected abstract void doAddColor(ReportColor color)
                            throws Exception
```
    Add a color to the document.
    
    Parameters:
    
    color - color to add.
    
    Throws:
    
    Exception - in case of failure.
  - doHintFont
```
protected abstract void doHintFont(boolean serifedFont)
                            throws Exception
```
    Implementation of the hint to use a serifed or non-serifed font.
    
    Parameters:
    
    serifedFont - true for serifed fonts, false for non-serifed.
    
    Throws:
    
    Exception - in case of failure.
  - doHintLanguage
```
protected abstract void doHintLanguage(String language)
                                throws Exception
```
    The format specific implementation of hintLanguage(String).
    
    Throws:
    
    Exception - in case of failure.
  - doDefineMargins
```
protected abstract void doDefineMargins(int left,
                                        int top,
                                        int right,
                                        int bottom)
                                 throws Exception
```
    The format specific implementation of setMargins(int, int, int, int).
    
    Throws:
    
    Exception - in case of failure.
  - doEndDocumentHead
```
protected abstract void doEndDocumentHead()
                                   throws Exception
```
    The format specific implementation of endDocumentHead().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginDocumentBody
```
protected abstract void doBeginDocumentBody()
                                     throws Exception
```
    The format specific implementation of beginDocumentBody().
    
    Throws:
    
    Exception - in case of failure.
  - doEndDocumentBody
```
protected abstract void doEndDocumentBody()
                                   throws Exception
```
    The format specific implementation of endDocumentBody().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginTable
```
protected abstract void doBeginTable(int totalColumns,
                                     int[] eachColumnWidth)
                              throws Exception
```
    The format specific implementation of beginTable(int, int...).
    
    Throws:
    
    Exception - in case of failure.
  - doEndTable
```
protected abstract void doEndTable()
                            throws Exception
```
    The format specific implementation of endTable().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginTableHeaderRow
```
protected abstract void doBeginTableHeaderRow()
                                       throws Exception
```
    The format specific implementation of beginTableHeaderRow().
    
    Throws:
    
    Exception - in case of failure.
  - doAddTableHeaderCell
```
protected abstract void doAddTableHeaderCell(String columnName,
                                             int colspan)
                                      throws Exception
```
    The format specific implementation of addTableHeaderCell(java.lang.String).
    
    Throws:
    
    Exception - in case of failure.
  - doEndTableHeaderRow
```
protected abstract void doEndTableHeaderRow()
                                     throws Exception
```
    The format specific implementation of endTableHeaderRow().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginTableRow
```
protected abstract void doBeginTableRow()
                                 throws Exception
```
    The format specific implementation of beginTableRow().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginTableCell
```
protected abstract void doBeginTableCell(int colspan,
                                         int rowspan)
                                  throws Exception
```
    The format specific implementation of beginTableCell(int, int). beginTableCell().
    
    Throws:
    
    Exception - in case of failure.
  - doEndTableCell
```
protected abstract void doEndTableCell()
                                throws Exception
```
    The format specific implementation of endTableCell().
    
    Throws:
    
    Exception - in case of failure.
  - doEndTableRow
```
protected abstract void doEndTableRow()
                               throws Exception
```
    The format specific implementation of endTableRow().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginGroup
```
protected abstract void doBeginGroup(ReportGroupType type,
                                     String name)
                              throws Exception
```
    The format specific implementation of beginGroup(net.sf.nervalreports.core.ReportGroupType).
    
    Throws:
    
    Exception - in case of failure.
  - doEndGroup
```
protected abstract void doEndGroup(ReportGroupType type)
                            throws Exception
```
    The format specific implementation of endGroup().
    
    Throws:
    
    Exception - in case of failure.
  - doAddImage
```
protected abstract void doAddImage(byte[] img,
                                   String imgName,
                                   int width)
                            throws Exception
```
    The format specific implementation of addImage(byte[], java.lang.String, int).
    
    Throws:
    
    Exception - in case of failure.
  - doAddLinkedImage
```
protected abstract void doAddLinkedImage(String imgLink,
                                         int width)
                                  throws Exception
```
    The format specific implementation of addLinkedImage(java.lang.String, int).
    
    Throws:
    
    Exception - in case of failure.
  - doAddImage
```
protected abstract void doAddImage(byte[] img,
                                   String imgName,
                                   int width,
                                   int height)
                            throws Exception
```
    The format specific implementation of addImage(byte[], java.lang.String, int).
    
    Throws:
    
    Exception - in case of failure.
  - doAddLinkedImage
```
protected abstract void doAddLinkedImage(String imgLink,
                                         int width,
                                         int height)
                                  throws Exception
```
    The format specific implementation of addLinkedImage(java.lang.String, int).
    
    Throws:
    
    Exception - in case of failure.
  - doCreateLineSpaces
```
protected abstract void doCreateLineSpaces(int n)
                                    throws Exception
```
    The format specific implementation of addLineSpaces(int).
    
    Throws:
    
    Exception - in case of failure.
  - doLineBreak
```
protected abstract void doLineBreak()
                             throws Exception
```
    The format specific implementation of addLineBreak().
    
    Throws:
    
    Exception - in case of failure.
  - doAddText
```
protected abstract void doAddText(String text)
                           throws Exception
```
    The format specific implementation of addText(java.lang.String).
    
    Throws:
    
    Exception - in case of failure.
  - doAddSeparatorLine
```
protected abstract void doAddSeparatorLine()
                                    throws Exception
```
    The format specific implementation of addSeparatorLine().
    
    Throws:
    
    Exception - in case of failure.
  - doAddCurrentPageNumber
```
protected abstract void doAddCurrentPageNumber()
                                        throws Exception
```
    The format specific implementation of addCurrentPageNumber().
    
    Throws:
    
    Exception - in case of failure.
  - doAddTotalPagesCount
```
protected abstract void doAddTotalPagesCount()
                                      throws Exception
```
    The format specific implementation of addTotalPagesCount().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginPageHeaderLeft
```
protected abstract void doBeginPageHeaderLeft()
                                       throws Exception
```
    The format specific implementation of beginPageHeaderLeft().
    
    Throws:
    
    Exception - in case of failure.
  - doEndPageHeaderLeft
```
protected abstract void doEndPageHeaderLeft()
                                     throws Exception
```
    The format specific implementation of endPageHeaderLeft().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginPageHeaderCenter
```
protected abstract void doBeginPageHeaderCenter()
                                         throws Exception
```
    The format specific implementation of beginPageHeaderCenter().
    
    Throws:
    
    Exception - in case of failure.
  - doEndPageHeaderCenter
```
protected abstract void doEndPageHeaderCenter()
                                       throws Exception
```
    The format specific implementation of endPageHeaderCenter().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginPageHeaderRight
```
protected abstract void doBeginPageHeaderRight()
                                        throws Exception
```
    The format specific implementation of beginPageHeaderRight().
    
    Throws:
    
    Exception - in case of failure.
  - doEndPageHeaderRight
```
protected abstract void doEndPageHeaderRight()
                                      throws Exception
```
    The format specific implementation of endPageHeaderRight().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginPageFooterLeft
```
protected abstract void doBeginPageFooterLeft()
                                       throws Exception
```
    The format specific implementation of beginPageFooterLeft().
    
    Throws:
    
    Exception - in case of failure.
  - doEndPageFooterLeft
```
protected abstract void doEndPageFooterLeft()
                                     throws Exception
```
    The format specific implementation of endPageFooterLeft().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginPageFooterCenter
```
protected abstract void doBeginPageFooterCenter()
                                         throws Exception
```
    The format specific implementation of beginPageFooterCenter().
    
    Throws:
    
    Exception - in case of failure.
  - doEndPageFooterCenter
```
protected abstract void doEndPageFooterCenter()
                                       throws Exception
```
    The format specific implementation of endPageFooterCenter().
    
    Throws:
    
    Exception - in case of failure.
  - doBeginPageFooterRight
```
protected abstract void doBeginPageFooterRight()
                                        throws Exception
```
    The format specific implementation of beginPageFooterRight().
    
    Throws:
    
    Exception - in case of failure.
  - doEndPageFooterRight
```
protected abstract void doEndPageFooterRight()
                                      throws Exception
```
    The format specific implementation of endPageFooterRight().
    
    Throws:
    
    Exception - in case of failure.
  - saveToFile
```
public void saveToFile(String filename)
                throws ReportGenerationException
```
    Save the contents of the generated report to a file.
    
    Parameters:
    
    filename - path name of the file to save.
    
    Throws:
    
    ReportGenerationException - on file errors.
  - toByteArray
```
public byte[] toByteArray()
                   throws ReportGenerationException
```
    Get the byte array representation of the generated report.
    Note: Usually to be used as a servlet response, for example.
    
    Returns:
    
    Byte array with report.
    
    Throws:
    
    ReportGenerationException - on conversion errors.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - release
```
public void release()
```
    Clear all references of the report generation (including temporary files created) when they are no more necessary (for example, on reports generated for web applications, after it is sent to the client). It's highly recommended to call this function as soon as possible, to avoid keeping unnecessary references to no more used memory spaces (allowing the garbage collector to quickly clear them), or bunch of temporary files.
  - isBold
```
public boolean isBold()
```
    Returns:
    
    bold.
  - setBold
```
public void setBold(boolean bold)
```
    Define bold.
    
    Parameters:
    
    bold - new value to bold.
  - isItalic
```
public boolean isItalic()
```
    Returns:
    
    italic.
  - setItalic
```
public void setItalic(boolean italic)
```
    Define italic.
    
    Parameters:
    
    italic - new value to italic.
  - getFontSize
```
public ReportFontSize getFontSize()
```
    Returns:
    
    fontSize.
  - getFontSizeInPoints
```
protected int getFontSizeInPoints()
```
    Returns:
    
    getFontSize() in points unit.
  - setFontSize
```
public void setFontSize(ReportFontSize fontSize)
```
    Set fontSize.
    
    Parameters:
    
    fontSize - font size to use.
  - getTextAlignment
```
public ReportTextAlignment getTextAlignment()
```
    return textAlignment.
  - setTextAlignment
```
public void setTextAlignment(ReportTextAlignment textAlignment)
```
    Set textAlignment. It is usually applied for the next begin* block.
    
    Parameters:
    
    textAlignment - text alignment to use.
  - getOddRowColor
```
public ReportColor getOddRowColor()
```
    Returns:
    
    oddRowColor.
  - setOddRowColor
```
public void setOddRowColor(ReportColor oddRowColor)
```
    Set oddRowColor.
    
    Parameters:
    
    oddRowColor - new value to oddRowColor.
  - getEvenRowColor
```
public ReportColor getEvenRowColor()
```
    Returns:
    
    evenRowColor.
  - setEvenRowColor
```
public void setEvenRowColor(ReportColor evenRowColor)
```
    Set evenRowColor.
    
    Parameters:
    
    evenRowColor - new value to evenRowColor.
  - getRowColor
```
public ReportColor getRowColor()
```
    Returns:
    
    rowColor. Could be null.
  - setRowColor
```
public void setRowColor(ReportColor rowColor)
```
    Set rowColor.
    
    Parameters:
    
    rowColor - color to use for all rows. If null will use evenRowColor and oddRowColor instead.
  - getHeaderBackgroundColor
```
public ReportColor getHeaderBackgroundColor()
```
    Returns:
    
    headerBackgroundColor.
  - setHeaderBackgroundColor
```
public void setHeaderBackgroundColor(ReportColor headerBackgroundColor)
```
    Set headerBackgroundColor.
    
    Parameters:
    
    headerBackgroundColor - new value to headerBackgroundColor.
  - getBorderColor
```
public ReportColor getBorderColor()
```
    Returns:
    
    borderColor.
  - getBorderWidth
```
public Float getBorderWidth()
```
    Returns:
    
    borderWidth.
  - getTextColor
```
public ReportColor getTextColor()
```
    Returns:
    
    textColor.
  - setTextColor
```
public void setTextColor(ReportColor color)
```
    Define textColor.
    
    Parameters:
    
    color - new value to textColor.
  - getStringBuilder
```
protected StringBuilder getStringBuilder()
```
    Returns:
    
    getStringBuilder().
  - beginDocument
```
public void beginDocument()
                   throws ReportGenerationException
```
    Start the document. Must be called only once per report generation (ie: before calling beginDocument() again, one must call clear()).
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - endDocument
```
public void endDocument()
                 throws ReportGenerationException
```
    End the document. Must be called to finish the current document generation.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - beginDocumentHead
```
public void beginDocumentHead()
                       throws ReportGenerationException
```
    Begin the document's head, where should lies all specific implementation declarations.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - addColor
```
public ReportColor addColor(int red,
                            int green,
                            int blue,
                            String name)
                     throws ReportGenerationException
```
    Declare a color in RGB mode.
    
    Note: Should be called inner document's head.
    
    Parameters:
    
    red - red component of the color [0, 255].
    
    green - green component of the color [0, 255].
    
    blue - blue component of the color [0, 255].
    
    name - color name (must be unique per report and without spaces).
    
    Returns:
    
    ReportColor declared and created.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - setPaper
```
public void setPaper(ReportPaperFormat paperFormat)
```
    Set the paper format to use for the whole document (default is A4).
    
    Note: Should be called inner document's head.
    
    Parameters:
    
    paperFormat - to use.
  - getPaperFormat
```
public ReportPaperFormat getPaperFormat()
```
    Returns:
    
    paperFormat.
  - setMargins
```
public void setMargins(int left,
                       int top,
                       int right,
                       int bottom)
                throws ReportGenerationException
```
    Define the document's page margins.
    
    Note: Must be called immediately after beginDocument() and before beginDocumentHead() / beginDocumentBody().
    
    Parameters:
    
    left - left margin in PDF units.
    
    top - top margin in PDF units.
    
    right - right margin in PDF units.
    
    bottom - bottom margin in PDF units.
    
    Throws:
    
    ReportGenerationException
  - getMargins
```
public int[] getMargins()
```
    Returns:
    
    margins.
  - hintLanguage
```
public void hintLanguage(String language)
                  throws ReportGenerationException
```
    Hint the language to use. As a hint, not all generator's implementations will take that in consideration.
    
    Parameters:
    
    language - String with the language as defined by LaTeX babel package {see: http://www.ctan.org/pkg/babel}.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - setReportCharset
```
public void setReportCharset(ReportCharset charset)
                      throws ReportGenerationException
```
    Define the character set to use. If not defined will use VM's default, but LaTeX support could be incomplete.
    
    Parameters:
    
    charset - to define.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - getReportCharset
```
public ReportCharset getReportCharset()
```
    Returns:
    
    {#charset}. If null should be at VM's default.
  - hintSerifFont
```
public void hintSerifFont()
                   throws ReportGenerationException
```
    Hint to use a serifed font. As a hint, some generators could ignore it.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - hintNonSerifFont
```
public void hintNonSerifFont()
                      throws ReportGenerationException
```
    Hint to use a non-serifed font. As a hint, some generators could ignore it.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - endDocumentHead
```
public void endDocumentHead()
                     throws ReportGenerationException
```
    End the head of the document.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - beginDocumentBody
```
public void beginDocumentBody()
                       throws ReportGenerationException
```
    Begin the report document's body, where usually are all data to report.
    Each report must have a maximum of one body.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - endDocumentBody
```
public void endDocumentBody()
                     throws ReportGenerationException
```
    End the currently opened report body.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - setTableBorderStyle
```
public void setTableBorderStyle(Float borderWidth,
                                ReportColor borderColor)
```
    Set table border style that will take effect for next beginTable(int, int...) call.
    
    Parameters:
    
    borderWidth - width to use for table border (null for no border).
    
    borderColor - color to use for table border (if its width is not null).
  - beginTable
```
public void beginTable(int totalColumns,
                       int... eachColumnWidth)
                throws ReportGenerationException
```
    Begin a table, defining or not the width of all its columns. To not define any column width, simple call the method only with the totalColumns defined.
    Note: If not defined, most ReportGenerators (but not all) will make the table with full page width.
    
    Parameters:
    
    totalColumns - total number of columns the table has.
    
    eachColumnWidth - width, in PDF units, for each table column. If defined, the total number of eachColumnWidth must be equal to the number of columns.
    
    Throws:
    
    ReportGenerationException - in case of failure.
  - beginTableWithFixedDefinedWidth
```
public void beginTableWithFixedDefinedWidth(int totalColumns,
                                            int fixedWidth)
                                     throws ReportGenerationException
```
    Begin a table definition, setting all column's width to the same fixed value.
    
    Parameters:
    
    totalColumns - total number of columns the table has.
    
    fixedWidth - width, in PDF units, for each table columns.
    
    Throws:
    
    ReportGenerationException - in case of failure.
    
    See Also:
    
    beginTable(int, int...)
  - endTable
```
public void endTable()
              throws ReportGenerationException
```
    End the current table.
    
    Throws:
    
    ReportGenerationException
  - addTableHeaderRow
```
public void addTableHeaderRow(List<String> header)
                       throws ReportGenerationException
```
    Create a table header row with a predefined list of table column's titles.
    
    Parameters:
    
    header - list with each column title.
    
    Throws:
    
    ReportGenerationException
  - beginTableHeaderRow
```
public void beginTableHeaderRow()
                         throws ReportGenerationException
```
    Begin the definition of a table header row.
    
    Note: Must be inner a table.
    
    Throws:
    
    ReportGenerationException
  - addTableHeaderCell
```
public void addTableHeaderCell(String columnName)
                        throws ReportGenerationException
```
    Add a table header title text for a single table column.
    
    Note: Must be inner a table.
    
    Parameters:
    
    columnName - column title.
    
    Throws:
    
    ReportGenerationException
  - addTableHeaderCell
```
public void addTableHeaderCell(String columnName,
                               int colspan)
                        throws ReportGenerationException
```
    Add a table header title text.
    
    Note: Must be inner a table.
    
    Parameters:
    
    columnName - title of the column.
    
    colspan - number of columns the title should occupy. Equals to 1 to represent a single column title.
    
    Throws:
    
    ReportGenerationException
  - endTableHeaderRow
```
public void endTableHeaderRow()
                       throws ReportGenerationException
```
    End the declaration of current table header row.
    
    Throws:
    
    ReportGenerationException
  - addTableRow
```
public void addTableRow(List<String> cells)
                 throws ReportGenerationException
```
    Generate a table line
    
    Note: only use this function if a priori (ie: at the moment of ResultSet iteration) it isn't possible to add the columns. This method reiterates through the elements, which is really awful when using large volumes of data. When possible, use a sequence of beginTableRow(), addTableCell(String)'s endTableRow() instead of this.
    
    Note: Must be inner a table.
    
    Parameters:
    
    cells - list with all cells of the line (according to their columns).
    
    Throws:
    
    ReportGenerationException
  - beginTableRow
```
public void beginTableRow()
                   throws ReportGenerationException
```
    Init a table row.
    
    Note: Must be inner a table.
    
    Throws:
    
    ReportGenerationException
  - beginTableCell
```
public void beginTableCell()
                    throws ReportGenerationException
```
    Begin the creation of a table element (cell), of a single column in a single row.
    Note: Must be inner a table row.
    
    Throws:
    
    ReportGenerationException
  - beginTableCell
```
public void beginTableCell(int colspan,
                           int rowspan)
                    throws ReportGenerationException
```
    Begin the creation of a table element (cell).
    
    Note: Must be inner a table row.
    
    Parameters:
    
    colspan - number of columns occupied by the cell.
    
    rowspan - number of rows occupied by the cell.
    
    Throws:
    
    ReportGenerationException
  - addTableCell
```
public void addTableCell(String element,
                         int colspan,
                         int rowspan)
                  throws ReportGenerationException
```
    Same of addTableCell(String), but defining its spans.
    
    Note: Must be inner a table row.
    
    Parameters:
    
    element - cell's text.
    
    colspan - number of columns occupied by the cell.
    
    rowspan - number of rows occupied by the cell.
    
    Throws:
    
    ReportGenerationException
  - addTableCell
```
public void addTableCell(String element)
                  throws ReportGenerationException
```
    Adds a textual table cell element to the page. This function is a quick alternative for beginTableCell() - addText(java.lang.String) - endTableCell() sequence, of adding single text to a table cell.
    
    Note: Must be inner a table row.
    
    Parameters:
    
    element - cell's text.
    
    Throws:
    
    ReportGenerationException
  - endTableCell
```
public void endTableCell()
                  throws ReportGenerationException
```
    Ends the definition of a table cell element.
    
    Throws:
    
    ReportGenerationException
  - endTableRow
```
public void endTableRow()
                 throws ReportGenerationException
```
    Ends the definition of a table row line.
    
    Throws:
    
    ReportGenerationException
  - beginGroup
```
public void beginGroup(ReportGroupType type)
                throws ReportGenerationException
```
    Begin a group of report elements.
    
    Parameters:
    
    type - type of the group to begin.
    
    Throws:
    
    ReportGenerationException
  - beginGroup
```
public void beginGroup(ReportGroupType type,
                       String name)
                throws ReportGenerationException
```
    Begin a named group of report elements.
    
    Parameters:
    
    type - type of the group to begin.
    
    name - optional name of the group (could be null).
    
    Throws:
    
    ReportGenerationException
  - endGroup
```
public void endGroup()
              throws ReportGenerationException
```
    End the current opened group of report elements.
    
    Throws:
    
    ReportGenerationException
  - addCurrentPageNumber
```
public void addCurrentPageNumber()
                          throws ReportGenerationException
```
    Add the current page number to the report.
    
    Throws:
    
    ReportGenerationException
  - isInsideHeaderOrFooter
```
protected boolean isInsideHeaderOrFooter()
```
    Returns:
    
    if is currently inside a header or a footer.
  - addTotalPagesCount
```
public void addTotalPagesCount()
                        throws ReportGenerationException
```
    Add the number of total report pages to the report.
    
    Note: Should only be used inside page's headers or footers.
    
    Note: Beware that using this could make the report generation slower for some generators, because this value will only be available after the whole document is defined (making the need to go back through it to replace places where totalPages references are made).
    
    Throws:
    
    ReportGenerationException
  - beginPageHeaderLeft
```
public void beginPageHeaderLeft()
                         throws ReportGenerationException
```
    Begin the right page header definition.
    
    Throws:
    
    ReportGenerationException
  - endPageHeaderLeft
```
public void endPageHeaderLeft()
                       throws ReportGenerationException
```
    End the center page header definition.
    
    Throws:
    
    ReportGenerationException
  - beginPageHeaderCenter
```
public void beginPageHeaderCenter()
                           throws ReportGenerationException
```
    Begin the center page header definition.
    
    Throws:
    
    ReportGenerationException
  - endPageHeaderCenter
```
public void endPageHeaderCenter()
                         throws ReportGenerationException
```
    End the center page header definition.
    
    Throws:
    
    ReportGenerationException
  - beginPageHeaderRight
```
public void beginPageHeaderRight()
                          throws ReportGenerationException
```
    Begin the right page header definition.
    
    Throws:
    
    ReportGenerationException
  - endPageHeaderRight
```
public void endPageHeaderRight()
                        throws ReportGenerationException
```
    End the right page header definition.
    
    Throws:
    
    ReportGenerationException
  - beginPageFooterLeft
```
public void beginPageFooterLeft()
                         throws ReportGenerationException
```
    Init the left page footer definition.
    
    Throws:
    
    ReportGenerationException
  - endPageFooterLeft
```
public void endPageFooterLeft()
                       throws ReportGenerationException
```
    End the left page footer definition.
    
    Throws:
    
    ReportGenerationException
  - beginPageFooterCenter
```
public void beginPageFooterCenter()
                           throws ReportGenerationException
```
    Init the center page footer definition.
    
    Throws:
    
    ReportGenerationException
  - endPageFooterCenter
```
public void endPageFooterCenter()
                         throws ReportGenerationException
```
    End the center page footer definition.
    
    Throws:
    
    ReportGenerationException
  - beginPageFooterRight
```
public void beginPageFooterRight()
                          throws ReportGenerationException
```
    Init the right page footer definition.
    
    Throws:
    
    ReportGenerationException
  - endPageFooterRight
```
public void endPageFooterRight()
                        throws ReportGenerationException
```
    End the right page footer definition.
    
    Throws:
    
    ReportGenerationException
  - addImage
```
public void addImage(byte[] img,
                     String imgName,
                     int width)
              throws ReportGenerationException
```
    Add an image defined by a byte array of its format (usually it's safe to consider that all ReportGenerator's who support images will support PNG and JPG images formats here).
    
    Note: This function will keep original image aspect ratio.
    
    Note: When using TeXReportGenerator, you must avoid using this function inside headers or footers.
    
    Parameters:
    
    img - image represented by a byte array.
    
    imgName - image name: must be unique per document and without spaces.
    
    width - width (in pixels) to display the image.
    
    Throws:
    
    ReportGenerationException
  - addImage
```
public void addImage(byte[] img,
                     String imgName,
                     int width,
                     int height)
              throws ReportGenerationException
```
    Add an image defined by a byte array of its format, defining its width and height. (usually it's safe to consider that all ReportGenerator's who support images will support PNG and JPG images formats here).
    
    Note: When using TeXReportGenerator, you must avoid using this function inside headers or footers.
    
    Parameters:
    
    img - image represented by a byte array.
    
    imgName - image name: must be unique per document and without spaces.
    
    width - width (in pixels) to display the image.
    
    height - height (in pixels) to display the image. Could be with different aspect ratio of the original image.
    
    Throws:
    
    ReportGenerationException
  - addLinkedImage
```
public void addLinkedImage(String imgLink,
                           int width)
                    throws ReportGenerationException
```
    Add an image to the document by its link. If the link is for a jar or URL and supportImagesOfJarFilesOrURLs() is false, it's recommended to insert it - if not at header or footer - via addImage(byte[], String, int), or to extract it to a file and insert via the path as link.
    
    Note: This function will keep original image aspect ratio.
    
    Parameters:
    
    imgLink - path to the image.
    
    width - width (in pixels) to display the image.
    
    Throws:
    
    ReportGenerationException
  - addLinkedImage
```
public void addLinkedImage(String imgLink,
                           int width,
                           int height)
                    throws ReportGenerationException
```
    Add an image to the document by its link. If the link is for a jar or URL and supportImagesOfJarFilesOrURLs() is false, it's recommended to insert it - if not at header or footer - via addImage(byte[], String, int, int), or to extract it to a file and insert via the path as link.
    
    Parameters:
    
    imgLink - path to the image.
    
    width - width (in pixels) to display the image.
    
    height - height (in pixels) to display the image. Obviously, could be with different aspect ratio of the original image.
    
    Throws:
    
    ReportGenerationException
  - addLineSpaces
```
public void addLineSpaces(int n)
                   throws ReportGenerationException
```
    Add n blank lines to the report.
    
    Parameters:
    
    n - Number of blank lines to add.
    
    Throws:
    
    ReportGenerationException
  - addLineBreak
```
public void addLineBreak()
                  throws ReportGenerationException
```
    Add a line break to the document. Not all documents support line breaks inner tables, so use with parsimony.
    Note: Current font size will affect the height (and so line space) of the line break.
    
    Throws:
    
    ReportGenerationException
  - addTextWithNullSupport
```
public void addTextWithNullSupport(String text)
                            throws ReportGenerationException
```
    Add (or better, append) a contiguous text to the report, replacing null and empty values with '-'.
    
    Parameters:
    
    text - String with the text to append or null.
    
    Throws:
    
    ReportGenerationException
  - addText
```
public void addText(String text)
             throws ReportGenerationException
```
    Add (or better, append) a contiguous text to the report.
    
    Note: The text should not be empty. For potential empty texts, use addTextWithNullSupport(String).
    
    Parameters:
    
    text - String with the text to append.
    
    Throws:
    
    ReportGenerationException
  - addTextLine
```
public void addTextLine(String line)
                 throws ReportGenerationException
```
    Add text to the report with a line break at end.
    
    Parameters:
    
    line - String with text to add.
    
    Throws:
    
    ReportGenerationException
  - addSeparatorLine
```
public void addSeparatorLine()
                      throws ReportGenerationException
```
    Add an horizontal line (-----) separator to the report.
    
    Throws:
    
    ReportGenerationException
  - checkDocumentNotFinished
```
protected void checkDocumentNotFinished()
```
    Check if document is inited and not yet finished.
  - checkNotOpenedFooterOrHeader
```
protected void checkNotOpenedFooterOrHeader()
```
    Check if no footer or header block is currently opened.
    
    Throws:
    
    IllegalStateException - if the top isn't one of those expected or null.
  - checkStackState
```
protected void checkStackState(boolean pop,
                               net.sf.nervalreports.core.ReportGenerator.ReportBlockToken... expected)
```
    Verify the top of currently opened commands, expecting at last one type.
    
    Parameters:
    
    pop - if will pop (true) or peek (false) the stack top to check.
    
    expected - valid expected types.
    
    Throws:
    
    IllegalStateException - if the top isn't one of those expected or null.
    
    EmptyStackException - if the command stack is empty.

Class ReportGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PIXELS_TO_UNITS_FACTOR

UNITS_TO_PIXELS

Constructor Detail

ReportGenerator

Method Detail

getFileExtension

supportImages

supportImagesOfJarFilesOrURLs

isHeaderAndFooterDeclarationAtDocumentHead

doBeginDocument

doEndDocument

doBeginDocumentHead

doAddColor

doHintFont

doHintLanguage

doDefineMargins

doEndDocumentHead

doBeginDocumentBody

doEndDocumentBody

doBeginTable

doEndTable

doBeginTableHeaderRow

doAddTableHeaderCell

doEndTableHeaderRow

doBeginTableRow

doBeginTableCell

doEndTableCell

doEndTableRow

doBeginGroup

doEndGroup

doAddImage

doAddLinkedImage

doAddImage

doAddLinkedImage

doCreateLineSpaces

doLineBreak

doAddText

doAddSeparatorLine

doAddCurrentPageNumber

doAddTotalPagesCount

doBeginPageHeaderLeft

doEndPageHeaderLeft

doBeginPageHeaderCenter

doEndPageHeaderCenter

doBeginPageHeaderRight

doEndPageHeaderRight

doBeginPageFooterLeft

doEndPageFooterLeft

doBeginPageFooterCenter

doEndPageFooterCenter

doBeginPageFooterRight

doEndPageFooterRight

saveToFile

toByteArray

toString

release

isBold

setBold

isItalic

setItalic

getFontSize

getFontSizeInPoints

setFontSize

getTextAlignment

setTextAlignment

getOddRowColor

setOddRowColor

getEvenRowColor

setEvenRowColor

getRowColor

setRowColor

getHeaderBackgroundColor

setHeaderBackgroundColor

getBorderColor