com.goldencode.p2j.admin.server.reports

Class AccountsReportBuilder<TRowObject>

java.lang.Object

com.goldencode.p2j.admin.server.reports.AbstractReportBuilder<AbstractReportBuilder.SimpleHeader,TRowObject,AbstractReportBuilder.SimpleFooter>

com.goldencode.p2j.admin.server.reports.AccountsReportBuilder<TRowObject>

Type Parameters:

TRowObject - Type that represents row data for accounts reports.

All Implemented Interfaces:

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

Direct Known Subclasses:

GroupsReportsBuilder, ProcessesReportsBuilder, UsersReportsBuilder

public abstract class AccountsReportBuilder<TRowObject>
extends AbstractReportBuilder<AbstractReportBuilder.SimpleHeader,TRowObject,AbstractReportBuilder.SimpleFooter>

Abstract base report builder for accounts reports.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AccountsReportBuilder.AccountColumnInfo<T extends AccountData> A column info that allows to display extended rows.

Nested classes/interfaces inherited from class com.goldencode.p2j.admin.server.reports.AbstractReportBuilder

AbstractReportBuilder.CellValueRenderer<TRowObject>, AbstractReportBuilder.ColumnHeaderRenderer, AbstractReportBuilder.ColumnInfo<TRowObject>, AbstractReportBuilder.DefaultCellRenderer, AbstractReportBuilder.DefaultColumnHeaderRenderer, AbstractReportBuilder.DefaultFooterRenderer, AbstractReportBuilder.DefaultHeaderRenderer, AbstractReportBuilder.ExtendedColumnInfo<TRowObject extends ExtendedRowInfo>, AbstractReportBuilder.Footer, AbstractReportBuilder.Header, AbstractReportBuilder.IPageCanvas, AbstractReportBuilder.PageCanvas, AbstractReportBuilder.PageState, AbstractReportBuilder.Renderer<T>, AbstractReportBuilder.SectionRenderer<T>, AbstractReportBuilder.SimpleFooter, AbstractReportBuilder.SimpleHeader, AbstractReportBuilder.StaticColumnInfo<TRowObject extends ExtendedRowInfo>

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
protected AbstractReportBuilder.SimpleFooter	footer The report footer
protected AbstractReportBuilder.SimpleHeader	header The report header
protected int	numExtendedRows The number of additional extended columns
private java.util.Set<java.lang.String>	selectedRows The ordered set of selected accounts to be used as data sources for generated reports
protected boolean	showExtendedColumns Defines the flag that controls the visibility of additional extended columns

Fields inherited from class com.goldencode.p2j.admin.server.reports.AbstractReportBuilder

boldFont, cellFontSize, columnFontSize, doc, font, footerFontSize, headerFontSize, orient, reportSize

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

BOTTOM, LEFT, RIGHT, TOP

Constructor Summary

Constructors

Constructor and Description
AccountsReportBuilder(java.lang.String reportId, java.lang.String filter, java.lang.String[] selected, java.util.Map<java.lang.String,java.lang.String> reportParameters) Creates this builder.

Method Summary

Modifier and Type	Method and Description
protected <T extends AccountData> java.util.List<AbstractReportBuilder.ColumnInfo<T>>	buildColumns(java.util.List<AbstractReportBuilder.ColumnInfo<T>> core, java.util.List<AbstractReportBuilder.ColumnInfo<T>> ext, int numCoreColumns, int numTuples) Builds extended column definition.
private java.util.function.Predicate<TRowObject>	createFilterPredicate(com.google.gwt.regexp.shared.RegExp filterExp) Creates the report selection criteria.
private static int	getPreviewPageNumber(java.util.Map<java.lang.String,java.lang.String> reportParameters) Gets the number of pages to preview.
protected AbstractReportBuilder.SimpleFooter	getReportFooter() Returns the footer data.
protected AbstractReportBuilder.SimpleHeader	getReportHeader() Returns the header data.
java.util.Set<java.lang.String>	getSelectedRows() Gets ordered set of selected accounts
java.util.stream.Stream<TaggedName>	getSelectionStream(TaggedName[] accounts) Returns a data stream of selected accounts.
boolean	hasSelectedRows() Has selected accounts.

Methods inherited from class com.goldencode.p2j.admin.server.reports.AbstractReportBuilder

buildReport, getAvailablePageSpace, getBoldFont, getCellFontSize, getCellMargin, getCellOuterSpace, getCellPadding, getColumnFontSize, getColumns, getContentLowBound, getDataStream, getDoc, getFilterRecords, getFont, getFooterFontSize, getFooterMargin, getFooterRenderer, getFooterSectionRenderer, getHeaderFontSize, getHeaderMargin, getHeaderRenderer, getMargin, getMinCellHeight, getOrient, getPreviewPage, getReportId, getReportSize, getSectionRenderer, isBreakPageForNewSection, isSelfPrintedDocument, setBreakPageForNewSection, setFilterRecords, setFooterRenderer, setFooterSectionRenderer, setHeaderRenderer, setPreviewPage, setSectionRenderer, setSelfPrintedDocument

Methods inherited from class java.lang.Object

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

Field Detail

selectedRows

private final java.util.Set<java.lang.String> selectedRows

The ordered set of selected accounts to be used as data sources for generated reports

header

protected final AbstractReportBuilder.SimpleHeader header

The report header

footer

protected final AbstractReportBuilder.SimpleFooter footer

The report footer

showExtendedColumns

protected boolean showExtendedColumns

Defines the flag that controls the visibility of additional extended columns

numExtendedRows

protected int numExtendedRows

The number of additional extended columns

Constructor Detail

AccountsReportBuilder

public AccountsReportBuilder(java.lang.String reportId,
                             java.lang.String filter,
                             java.lang.String[] selected,
                             java.util.Map<java.lang.String,java.lang.String> reportParameters)

Creates this builder.

Parameters:

reportId - The report id

filter - The string that defines the report selection criteria

selected - The array of the selected accounts

reportParameters - The report parameters

Method Detail

getPreviewPageNumber

private static int getPreviewPageNumber(java.util.Map<java.lang.String,java.lang.String> reportParameters)

Gets the number of pages to preview.

Parameters:

reportParameters - The report parameters

Returns:

The number of pages to preview

getSelectionStream

public final java.util.stream.Stream<TaggedName> getSelectionStream(TaggedName[] accounts)

Returns a data stream of selected accounts.

Parameters:

accounts - Set of all target accounts

Returns:

Stream of selected accounts.

getSelectedRows

public final java.util.Set<java.lang.String> getSelectedRows()

Gets ordered set of selected accounts

Returns:

The ordered set of selected accounts.

hasSelectedRows

public final boolean hasSelectedRows()

Has selected accounts.

Returns:

True if selected accounts are set up. Thus there exists at least one selected account.

getReportHeader

protected AbstractReportBuilder.SimpleHeader getReportHeader()

Returns the header data. The concrete implementation must provide the header data.

Specified by:

getReportHeader in class AbstractReportBuilder<AbstractReportBuilder.SimpleHeader,TRowObject,AbstractReportBuilder.SimpleFooter>

Returns:

The header data

getReportFooter

protected AbstractReportBuilder.SimpleFooter getReportFooter()

Returns the footer data. The concrete implementation must provide the footer data.

Specified by:

getReportFooter in class AbstractReportBuilder<AbstractReportBuilder.SimpleHeader,TRowObject,AbstractReportBuilder.SimpleFooter>

Returns:

The footer data

buildColumns

protected <T extends AccountData> java.util.List<AbstractReportBuilder.ColumnInfo<T>> buildColumns(java.util.List<AbstractReportBuilder.ColumnInfo<T>> core,
                                                                                                   java.util.List<AbstractReportBuilder.ColumnInfo<T>> ext,
                                                                                                   int numCoreColumns,
                                                                                                   int numTuples)

Builds extended column definition.

Type Parameters:

T - The row type.

Parameters:

core - The core columns.

ext - The extension columns.

numCoreColumns - The number of core columns to appear on the report.

numTuples - The number of extended column tuples (Attribute + Value) to appear on the report.

Returns:

Resulting columns configuration.

createFilterPredicate

private java.util.function.Predicate<TRowObject> createFilterPredicate(com.google.gwt.regexp.shared.RegExp filterExp)

Creates the report selection criteria.

Parameters:

filterExp - The given regular expression

Returns:

The report selection criteria