AbstractReportBuilder (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.admin.server.reports.AbstractReportBuilder<THeaderObject,TRowObject,TFooterObject>

Type Parameters:

THeaderObject - Represents a header of the target report

TRowObject - Represents a row of the target report

TFooterObject - Represents a footer of the target report

All Implemented Interfaces:

PdfReportBuilder, ReportBuilder<PdfReportBuilder.PdfReportSettings,PdfReportBuilder.PdfDocument>

Direct Known Subclasses:

AccountsReportBuilder, DefaultReportBuilder
```
public abstract class AbstractReportBuilder<THeaderObject extends AbstractReportBuilder.Header,TRowObject,TFooterObject extends AbstractReportBuilder.Footer>
extends java.lang.Object
implements PdfReportBuilder
```
AbstractReportBuilder is an abstract implementation of PdfReportBuilder.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractReportBuilder.CellValueRenderer<TRowObject>` Defines a cell renderer.
`static interface`	`AbstractReportBuilder.ColumnHeaderRenderer` Defines methods to draw column headers.
`static class`	`AbstractReportBuilder.ColumnInfo<TRowObject>` The column info provides with an access getter to its cell's value and its cell's layout and size.
`(package private) class`	`AbstractReportBuilder.DefaultCellRenderer` The Default Cell Renderer.
`(package private) class`	`AbstractReportBuilder.DefaultColumnHeaderRenderer` The Default Column Header Renderer.
`(package private) class`	`AbstractReportBuilder.DefaultFooterRenderer` The Default Footer Renderer.
`(package private) class`	`AbstractReportBuilder.DefaultHeaderRenderer` The Default Header Renderer.
`static class`	`AbstractReportBuilder.ExtendedColumnInfo<TRowObject extends ExtendedRowInfo>` The Extended Column Info.
`static interface`	`AbstractReportBuilder.Footer` Defines the footer data.
`static interface`	`AbstractReportBuilder.Header` Defines the header data.
`static interface`	`AbstractReportBuilder.IPageCanvas` Defines the page canvas.
`(package private) class`	`AbstractReportBuilder.PageCanvas` Implements IPageCanvas based on the PDFBox API
`static class`	`AbstractReportBuilder.PageState` Defines the current page state
`static interface`	`AbstractReportBuilder.Renderer<T>` Defines methods to draw the report data on the page
`private class`	`AbstractReportBuilder.ReportDirector` The report director.
`static interface`	`AbstractReportBuilder.SectionRenderer<T>` The Interface SectionRenderer.
`static class`	`AbstractReportBuilder.SimpleFooter` The Class SimpleFooter.
`static class`	`AbstractReportBuilder.SimpleHeader` The Class SimpleHeader.
`static class`	`AbstractReportBuilder.StaticColumnInfo<TRowObject extends ExtendedRowInfo>` The Static Column Info.

Nested classes/interfaces inherited from interface com.goldencode.p2j.admin.server.reports.PdfReportBuilder
PdfReportBuilder.PdfDocument, PdfReportBuilder.PdfReportSettings

Nested classes/interfaces inherited from interface com.goldencode.p2j.admin.server.reports.ReportBuilder
ReportBuilder.Document, ReportBuilder.ReportSettings

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) org.apache.pdfbox.pdmodel.font.PDFont`	`boldFont` The bold font used for the built report
`private boolean`	`breakPageForNewSection` True value indicates that new section must be printed on the next new page, otherwise the new section must be printed on the current page if it is possible.
`(package private) float`	`cellFontSize` The size of the table cell font
`private float`	`cellMargin` Defines a cell margin.
`private float`	`cellPadding` Defines a cell pading.
`(package private) float`	`columnFontSize` The size of the table column font
`(package private) org.apache.pdfbox.pdmodel.PDDocument`	`doc` The current instance of the created pdf document
`private java.util.function.Predicate<TRowObject>`	`filterRecords` The filter records predicate that tests if a row should be present in new reports
`(package private) org.apache.pdfbox.pdmodel.font.PDFont`	`font` The normal font used for the built report
`(package private) float`	`footerFontSize` The size of the footer font
`private float`	`footerMargin` Defines top and bottom margin for the footer.
`private AbstractReportBuilder.Renderer<TFooterObject>`	`footerRenderer` The render of the report footer
`private AbstractReportBuilder.SectionRenderer<TRowObject>`	`footerSectionRenderer` The render of the section footer
`(package private) float`	`headerFontSize` The size of the header font
`private float`	`headerMargin` Defines top and bottom margin for the header.
`private AbstractReportBuilder.Renderer<THeaderObject>`	`headerRenderer` The render of the report header
`private float[]`	`margin` Defines page margin in this order: left, top, right and bottom.
`private int`	`maxPagesNumber` Maximal number of report pages that this builder can produce in a one document.
`(package private) PaperOrientation`	`orient` The page orientation of the built report
`private java.lang.Integer`	`previewPage` The page to preview, in the preview mode PDF is built only for the selected page, to do list of pages to preview.
`private java.lang.String`	`reportId` Report id
`(package private) org.apache.pdfbox.pdmodel.common.PDRectangle`	`reportSize` The page size of the built report
`private AbstractReportBuilder.SectionRenderer<TRowObject>`	`sectionRenderer` The render of the section header
`private boolean`	`selfPrintedDocument` True value indicates that PDF report will request to print itself if while it is opened or rendered by PDF viewer with enabled java script support.
`private java.util.LinkedList<byte[]>`	`splittedDoc` Holds binary documents that comprise the all report and their maximal numbers of pages don't exceed the defined limit given by MAX_PAGE_NUMBER.

Fields inherited from interface com.goldencode.p2j.admin.server.reports.PdfReportBuilder
BOTTOM, LEFT, RIGHT, TOP

Constructor Summary

Constructors
Constructor and Description

AbstractReportBuilder(java.lang.String reportId)
Creates a report builder per a report request.

Constructors
Constructor and Description
`AbstractReportBuilder(java.lang.String reportId)` Creates a report builder per a report request.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`PdfReportBuilder.PdfDocument`	`buildReport(PdfReportBuilder.PdfReportSettings parameters)` Builds a document according to the provided report settings.
`float`	`getAvailablePageSpace()` Returns available space for content between its page header and footer.
`org.apache.pdfbox.pdmodel.font.PDFont`	`getBoldFont()` Gets the bold font.
`float`	`getCellFontSize()` Gets the cell font size.
`float`	`getCellMargin()` Gets the cell margin.
`float`	`getCellOuterSpace()` Gets the cell outer space.
`float`	`getCellPadding()` Gets the cell padding.
`float`	`getColumnFontSize()` Gets the column font size.
`protected abstract java.util.List<AbstractReportBuilder.ColumnInfo<TRowObject>>`	`getColumns()` Returns the list of report columns.
`float`	`getContentLowBound()` Returns the low bound for the page content.
`protected abstract java.util.stream.Stream<TRowObject>`	`getDataStream()` Returns the report data stream.
`org.apache.pdfbox.pdmodel.PDDocument`	`getDoc()` Gets the doc.
`java.util.function.Predicate<TRowObject>`	`getFilterRecords()` Returns the current records filter used internally to select the target sub set of data.
`org.apache.pdfbox.pdmodel.font.PDFont`	`getFont()` Gets the font.
`float`	`getFooterFontSize()` Gets the footer font size.
`float`	`getFooterMargin()` Gets the footer margin.
`AbstractReportBuilder.Renderer<TFooterObject>`	`getFooterRenderer()` Returns the current header renderer.
`AbstractReportBuilder.SectionRenderer<TRowObject>`	`getFooterSectionRenderer()` Returns the current renderer to draw a page section footer.
`float`	`getHeaderFontSize()` Gets the header font size.
`float`	`getHeaderMargin()` Gets the header margin.
`AbstractReportBuilder.Renderer<THeaderObject>`	`getHeaderRenderer()` Returns the current header renderer.
`float[]`	`getMargin()` Gets the margin.
`float`	`getMinCellHeight()` Gets the min cell height.
`PaperOrientation`	`getOrient()` Gets the orient.
`java.lang.Integer`	`getPreviewPage()` Returns the page number to preview.
`protected abstract TFooterObject`	`getReportFooter()` Returns the footer data.
`protected abstract THeaderObject`	`getReportHeader()` Returns the header data.
`java.lang.String`	`getReportId()` Returns the report id.
`org.apache.pdfbox.pdmodel.common.PDRectangle`	`getReportSize()` Gets the report size.
`AbstractReportBuilder.SectionRenderer<TRowObject>`	`getSectionRenderer()` Returns the current section renderer.
`boolean`	`isBreakPageForNewSection()` The returned true value indicates that the current page should be interrupted if it is followed by a new section.
`boolean`	`isSelfPrintedDocument()` Returned true value indicates that PDF report will request to print itself if it will be rendered.
`void`	`setBreakPageForNewSection(boolean breakPageForNewSection)` Sets a boolean value indicating the current page should be interrupted or not if it is followed by a new section.
`void`	`setFilterRecords(java.util.function.Predicate<TRowObject> filterRecords)` Sets the current records filter that will be used to build reports for the target sub set of data.
`void`	`setFooterRenderer(AbstractReportBuilder.Renderer<TFooterObject> footerRenderer)` Sets the current footer renderer to draw a page footer.
`void`	`setFooterSectionRenderer(AbstractReportBuilder.SectionRenderer<TRowObject> footerSectionRenderer)` Sets the current renderer to draw a page section footer.
`void`	`setHeaderRenderer(AbstractReportBuilder.Renderer<THeaderObject> headerRenderer)` Sets the current header renderer to draw a page header.
`void`	`setPreviewPage(java.lang.Integer previewPage)` Sets the page number to preview.
`void`	`setSectionRenderer(AbstractReportBuilder.SectionRenderer<TRowObject> sectionRenderer)` Sets the current section renderer to draw a page section header.
`void`	`setSelfPrintedDocument(boolean selfPrintedDocument)` Sets the boolean value indicating if the produced PDF report will print itself or not while it is opened or rendered by PDF viewer with enabled java script support.

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

- Field Detail
  - maxPagesNumber
```
private int maxPagesNumber
```
    Maximal number of report pages that this builder can produce in a one document.
  - margin
```
private float[] margin
```
    Defines page margin in this order: left, top, right and bottom.
  - cellMargin
```
private float cellMargin
```
    Defines a cell margin.
  - cellPadding
```
private float cellPadding
```
    Defines a cell pading.
  - headerMargin
```
private float headerMargin
```
    Defines top and bottom margin for the header.
  - footerMargin
```
private float footerMargin
```
    Defines top and bottom margin for the footer.
  - reportId
```
private final java.lang.String reportId
```
    Report id
  - splittedDoc
```
private final java.util.LinkedList<byte[]> splittedDoc
```
    Holds binary documents that comprise the all report and their maximal numbers of pages don't exceed the defined limit given by MAX_PAGE_NUMBER.
  - doc
```
org.apache.pdfbox.pdmodel.PDDocument doc
```
    The current instance of the created pdf document
  - reportSize
```
org.apache.pdfbox.pdmodel.common.PDRectangle reportSize
```
    The page size of the built report
  - orient
```
PaperOrientation orient
```
    The page orientation of the built report
  - headerFontSize
```
float headerFontSize
```
    The size of the header font
  - columnFontSize
```
float columnFontSize
```
    The size of the table column font
  - cellFontSize
```
float cellFontSize
```
    The size of the table cell font
  - footerFontSize
```
float footerFontSize
```
    The size of the footer font
  - font
```
org.apache.pdfbox.pdmodel.font.PDFont font
```
    The normal font used for the built report
  - boldFont
```
org.apache.pdfbox.pdmodel.font.PDFont boldFont
```
    The bold font used for the built report
  - headerRenderer
```
private AbstractReportBuilder.Renderer<THeaderObject extends AbstractReportBuilder.Header> headerRenderer
```
    The render of the report header
  - footerRenderer
```
private AbstractReportBuilder.Renderer<TFooterObject extends AbstractReportBuilder.Footer> footerRenderer
```
    The render of the report footer
  - filterRecords
```
private java.util.function.Predicate<TRowObject> filterRecords
```
    The filter records predicate that tests if a row should be present in new reports
  - sectionRenderer
```
private AbstractReportBuilder.SectionRenderer<TRowObject> sectionRenderer
```
    The render of the section header
  - footerSectionRenderer
```
private AbstractReportBuilder.SectionRenderer<TRowObject> footerSectionRenderer
```
    The render of the section footer
  - breakPageForNewSection
```
private boolean breakPageForNewSection
```
    True value indicates that new section must be printed on the next new page, otherwise the new section must be printed on the current page if it is possible.
  - previewPage
```
private java.lang.Integer previewPage
```
    The page to preview, in the preview mode PDF is built only for the selected page, to do list of pages to preview.
  - selfPrintedDocument
```
private boolean selfPrintedDocument
```
    True value indicates that PDF report will request to print itself if while it is opened or rendered by PDF viewer with enabled java script support.
- Constructor Detail
  - AbstractReportBuilder
```
public AbstractReportBuilder(java.lang.String reportId)
```
    Creates a report builder per a report request.
    
    Parameters:
    
    reportId - Report id.
- Method Detail
  - getFilterRecords
```
public java.util.function.Predicate<TRowObject> getFilterRecords()
```
    Returns the current records filter used internally to select the target sub set of data.
    
    Returns:
    
    The records filter.
  - setFilterRecords
```
public void setFilterRecords(java.util.function.Predicate<TRowObject> filterRecords)
```
    Sets the current records filter that will be used to build reports for the target sub set of data.
    
    Parameters:
    
    filterRecords - The records filter.
  - getHeaderRenderer
```
public AbstractReportBuilder.Renderer<THeaderObject> getHeaderRenderer()
```
    Returns the current header renderer.
    
    Returns:
    
    The header renderer
  - setHeaderRenderer
```
public void setHeaderRenderer(AbstractReportBuilder.Renderer<THeaderObject> headerRenderer)
```
    Sets the current header renderer to draw a page header.
    
    Parameters:
    
    headerRenderer - The header renderer
  - getFooterRenderer
```
public AbstractReportBuilder.Renderer<TFooterObject> getFooterRenderer()
```
    Returns the current header renderer.
    
    Returns:
    
    The footer renderer
  - setFooterRenderer
```
public void setFooterRenderer(AbstractReportBuilder.Renderer<TFooterObject> footerRenderer)
```
    Sets the current footer renderer to draw a page footer.
    
    Parameters:
    
    footerRenderer - The footer renderer
  - getSectionRenderer
```
public AbstractReportBuilder.SectionRenderer<TRowObject> getSectionRenderer()
```
    Returns the current section renderer.
    
    Returns:
    
    The section renderer
  - setSectionRenderer
```
public void setSectionRenderer(AbstractReportBuilder.SectionRenderer<TRowObject> sectionRenderer)
```
    Sets the current section renderer to draw a page section header.
    
    Parameters:
    
    sectionRenderer - The section renderer
  - getFooterSectionRenderer
```
public AbstractReportBuilder.SectionRenderer<TRowObject> getFooterSectionRenderer()
```
    Returns the current renderer to draw a page section footer.
    
    Returns:
    
    The section footer renderer
  - setFooterSectionRenderer
```
public void setFooterSectionRenderer(AbstractReportBuilder.SectionRenderer<TRowObject> footerSectionRenderer)
```
    Sets the current renderer to draw a page section footer.
    
    Parameters:
    
    footerSectionRenderer - The section footer renderer
  - isBreakPageForNewSection
```
public boolean isBreakPageForNewSection()
```
    The returned true value indicates that the current page should be interrupted if it is followed by a new section.
    
    Returns:
    
    The break page boolean value
  - setBreakPageForNewSection
```
public void setBreakPageForNewSection(boolean breakPageForNewSection)
```
    Sets a boolean value indicating the current page should be interrupted or not if it is followed by a new section.
    
    Parameters:
    
    breakPageForNewSection - The break page boolean value
  - getReportId
```
public java.lang.String getReportId()
```
    Returns the report id.
    
    Returns:
    
    The report id
  - getPreviewPage
```
public java.lang.Integer getPreviewPage()
```
    Returns the page number to preview.
    
    Returns:
    
    The page number to preview
  - setPreviewPage
```
public void setPreviewPage(java.lang.Integer previewPage)
```
    Sets the page number to preview. If the page number is set and is a positive whole number, then this builder is switched on the preview mode. It means that only this preview page will be produced.
    
    Parameters:
    
    previewPage - The page number to preview
  - isSelfPrintedDocument
```
public boolean isSelfPrintedDocument()
```
    Returned true value indicates that PDF report will request to print itself if it will be rendered.
    
    Returns:
    
    The self printed boolean value
  - setSelfPrintedDocument
```
public void setSelfPrintedDocument(boolean selfPrintedDocument)
```
    Sets the boolean value indicating if the produced PDF report will print itself or not while it is opened or rendered by PDF viewer with enabled java script support.
    
    Parameters:
    
    selfPrintedDocument - The self printed boolean value
  - buildReport
```
public final PdfReportBuilder.PdfDocument buildReport(PdfReportBuilder.PdfReportSettings parameters)
                                               throws java.io.IOException
```
    Builds a document according to the provided report settings.
    
    Specified by:
    
    buildReport in interface ReportBuilder<PdfReportBuilder.PdfReportSettings,PdfReportBuilder.PdfDocument>
    
    Parameters:
    
    parameters - The provided report parameters
    
    Returns:
    
    The PDF report document
    
    Throws:
    
    java.io.IOException - This exception can be thrown if there are failed output operations
  - getContentLowBound
```
public float getContentLowBound()
```
    Returns the low bound for the page content.
    
    Returns:
    
    The low bound for the page content
  - getAvailablePageSpace
```
public float getAvailablePageSpace()
```
    Returns available space for content between its page header and footer.
    
    Returns:
    
    The available space for content
  - getMinCellHeight
```
public float getMinCellHeight()
```
    Gets the min cell height.
    
    Returns:
    
    The min cell height
  - getCellOuterSpace
```
public float getCellOuterSpace()
```
    Gets the cell outer space.
    
    Returns:
    
    The cell outer space
  - getMargin
```
public float[] getMargin()
```
    Gets the margin.
    
    Returns:
    
    The margin
  - getCellMargin
```
public float getCellMargin()
```
    Gets the cell margin.
    
    Returns:
    
    The cell margin
  - getCellPadding
```
public float getCellPadding()
```
    Gets the cell padding.
    
    Returns:
    
    The cell padding
  - getHeaderMargin
```
public float getHeaderMargin()
```
    Gets the header margin.
    
    Returns:
    
    The header margin
  - getFooterMargin
```
public float getFooterMargin()
```
    Gets the footer margin.
    
    Returns:
    
    The footer margin
  - getDoc
```
public org.apache.pdfbox.pdmodel.PDDocument getDoc()
```
    Gets the doc.
    
    Returns:
    
    The doc
  - getReportSize
```
public org.apache.pdfbox.pdmodel.common.PDRectangle getReportSize()
```
    Gets the report size.
    
    Returns:
    
    The report size
  - getOrient
```
public PaperOrientation getOrient()
```
    Gets the orient.
    
    Returns:
    
    The orient
  - getHeaderFontSize
```
public float getHeaderFontSize()
```
    Gets the header font size.
    
    Returns:
    
    The header font size
  - getColumnFontSize
```
public float getColumnFontSize()
```
    Gets the column font size.
    
    Returns:
    
    The column font size
  - getCellFontSize
```
public float getCellFontSize()
```
    Gets the cell font size.
    
    Returns:
    
    The cell font size
  - getFooterFontSize
```
public float getFooterFontSize()
```
    Gets the footer font size.
    
    Returns:
    
    The footer font size
  - getFont
```
public org.apache.pdfbox.pdmodel.font.PDFont getFont()
```
    Gets the font.
    
    Returns:
    
    The font
  - getBoldFont
```
public org.apache.pdfbox.pdmodel.font.PDFont getBoldFont()
```
    Gets the bold font.
    
    Returns:
    
    The bold font
  - getDataStream
```
protected abstract java.util.stream.Stream<TRowObject> getDataStream()
```
    Returns the report data stream. It must be provided by the concrete implementation.
    
    Returns:
    
    The report data stream
  - getColumns
```
protected abstract java.util.List<AbstractReportBuilder.ColumnInfo<TRowObject>> getColumns()
```
    Returns the list of report columns. It must be provided by the concrete implementation.
    
    Returns:
    
    The list of report columns
  - getReportHeader
```
protected abstract THeaderObject getReportHeader()
```
    Returns the header data. The concrete implementation must provide the header data.
    
    Returns:
    
    The header data
  - getReportFooter
```
protected abstract TFooterObject getReportFooter()
```
    Returns the footer data. The concrete implementation must provide the footer data.
    
    Returns:
    
    The footer data

Class AbstractReportBuilder<THeaderObject extends AbstractReportBuilder.Header,TRowObject,TFooterObject extends AbstractReportBuilder.Footer>

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.admin.server.reports.PdfReportBuilder

Nested classes/interfaces inherited from interface com.goldencode.p2j.admin.server.reports.ReportBuilder

Field Summary

Fields inherited from interface com.goldencode.p2j.admin.server.reports.PdfReportBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maxPagesNumber

margin

cellMargin

cellPadding

headerMargin

footerMargin

reportId

splittedDoc

doc

reportSize

orient

headerFontSize

columnFontSize

cellFontSize

footerFontSize

font

boldFont

headerRenderer

footerRenderer

filterRecords

sectionRenderer

footerSectionRenderer

breakPageForNewSection

previewPage

selfPrintedDocument

Constructor Detail

AbstractReportBuilder

Method Detail

getFilterRecords

setFilterRecords

getHeaderRenderer

setHeaderRenderer

getFooterRenderer

setFooterRenderer

getSectionRenderer

setSectionRenderer

getFooterSectionRenderer

setFooterSectionRenderer

isBreakPageForNewSection

setBreakPageForNewSection

getReportId

getPreviewPage

setPreviewPage

isSelfPrintedDocument

setSelfPrintedDocument

buildReport

getContentLowBound

getAvailablePageSpace

getMinCellHeight

getCellOuterSpace

getMargin

getCellMargin

getCellPadding

getHeaderMargin

getFooterMargin

getDoc

getReportSize

getOrient

getHeaderFontSize

getColumnFontSize

getCellFontSize

getFooterFontSize

getFont

getBoldFont

getDataStream

getColumns

getReportHeader

getReportFooter