org.kuali.kfs.module.endow.report.util
Class TransactionSummaryReportPrint

java.lang.Object
  org.kuali.kfs.module.endow.report.util.EndowmentReportPrintBase
      org.kuali.kfs.module.endow.report.util.TransactionSummaryReportPrint

public class TransactionSummaryReportPrint
extends EndowmentReportPrintBase

Field Summary

Fields inherited from class org.kuali.kfs.module.endow.report.util.EndowmentReportPrintBase

CRITERIA_TABLE_WIDTH, footerRegularFont, footerTitleFont, FORMAT164, FORMAT192, FORMAT195, FULL_TABLE_WIDTH, headerFont, headerSheetRegularFont, headerShheetTitleFont, KEMID_SELECTED_TABLE_WIDTH, KEMIDS_SELECTED_COLUMN_NUM, LETTER_LANDSCAPE, LETTER_PORTRAIT, MULTIPLE_KEMID_TABLE_WIDTH, regularFont, REQUEST_INFO_TABLE_WIDTH, titleFont, ZERO_FOR_REPORT

Constructor Summary

TransactionSummaryReportPrint()

Method Summary

protected List<TransactionSummaryReportDataHolder>	combineKemidTotals(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders)
protected void	getSummaryTotalsForCashTransfers(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, TransactionSummaryReportDataHolder transactionSummaryReportDataHolder) Method to summarize the cash transfers list records for the summary totals report.
protected void	getSummaryTotalsForContributions(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, TransactionSummaryReportDataHolder transactionSummaryReportDataHolder) Method to summarize the expenses list records for the summary totals report.
protected void	getSummaryTotalsForExpenses(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, TransactionSummaryReportDataHolder transactionSummaryReportDataHolder) Method to summarize the expenses list records for the summary totals report.
protected void	getSummaryTotalsForSecurityTransfers(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, TransactionSummaryReportDataHolder transactionSummaryReportDataHolder) Method to summarize the Security transfers list records for the summary totals report.
protected boolean	printReportBodyByAllTotals(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, com.lowagie.text.Document document, String reportOption) Helper method to print body of the transaction summary report, listing all total fields.
boolean	printReportBodyByAllTotalsForDetailReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryReportDataHolders, com.lowagie.text.Document document) Generates the Transaction Summary report showing all amounts fields.
protected boolean	printReportBodyByAllTotalsForTotalReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, com.lowagie.text.Document document) Method to combine the kemid totals into one data record and print all fields.
protected boolean	printReportBodyBySummaryTotals(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, com.lowagie.text.Document document, String reportOption) Helper method to print body of the transaction summary report, listing only total field.
boolean	printReportBodyForDetailReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryReportDataHolders, com.lowagie.text.Document document) Generates the Transaction Summary report showing only summary amount field.
protected boolean	printReportBodyForSummaryReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, com.lowagie.text.Document document) Method to combine the kemid totals into one data record and print only summary field.
ByteArrayOutputStream	printTransactionSummaryReport(EndowmentReportHeaderDataHolder reportRequestHeaderDataHolder, List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders, String listKemidsInHeader, String reportOption, String summaryTotalsOnly) Generates the report in PDF using iText
protected void	writeCashTransfersRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the cash transfers list and write the lines..
protected void	writeCashTransfersRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the expenses list and write the lines..
protected void	writeContributionsRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the contributions list and write the lines..
protected void	writeContributionsRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the contributions list and write the lines..For summary report
protected void	writeDetailLineRow(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, String description, BigDecimal totalAmount) Helper method to write the details line.
protected void	writeDetailLineRow(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, String description, BigDecimal incomeAmount, BigDecimal principalAmount, BigDecimal totalAmount) Helper method to write the details line.
protected void	writeDetailsLineWithTotalAmountOnly(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, String description, BigDecimal amount, String reportOption) helper method to write the details lines where only the last column exists for amounts..
protected void	writeDocumentHeader(com.lowagie.text.Document document, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to write the document header
protected com.lowagie.text.pdf.PdfPTable	writeDocumentTitleHeadings(String reportOption) Helper method to write a line containing the column headings for the report
protected void	writeExpensesRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the expenses list and write the lines..
protected void	writeExpensesRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the expenses list and write the lines..
protected void	writeSecurityTransfersRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the cash transfers list and write the lines..
protected void	writeSecurityTransfersRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table, com.lowagie.text.Font cellFont, TransactionSummaryReportDataHolder transactionSummaryReport) Helper method to go through the security list and write the lines..
protected void	writeSubHeader(com.lowagie.text.pdf.PdfPTable table, String subHeading, String reportOption) helper method to write out a sub-heading into the report.

Methods inherited from class org.kuali.kfs.module.endow.report.util.EndowmentReportPrintBase

convertToUpperCase, createCell, createCell, createCellWithDefaultFontAndBorderLine, createCellWithDefaultFontAndWithoutBorderLine, formatAmount, formatAmount, getAmountCell, getAmountCell, printFooter, printReportHeaderPage

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionSummaryReportPrint

public TransactionSummaryReportPrint()

Method Detail

printTransactionSummaryReport

public ByteArrayOutputStream printTransactionSummaryReport(EndowmentReportHeaderDataHolder reportRequestHeaderDataHolder,
                                                           List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                           String listKemidsInHeader,
                                                           String reportOption,
                                                           String summaryTotalsOnly)

Generates the report in PDF using iText

Parameters:

reportRequestHeaderDataHolder -

transactionStatementDataReportHolders -

Returns:

pdfStream

printReportBodyBySummaryTotals

protected boolean printReportBodyBySummaryTotals(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                 com.lowagie.text.Document document,
                                                 String reportOption)

Helper method to print body of the transaction summary report, listing only total field.

Parameters:

transactionSummaryDataReportHolders -

document -

reportOption -

Returns:

true if successful else return false

printReportBodyByAllTotals

protected boolean printReportBodyByAllTotals(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                             com.lowagie.text.Document document,
                                             String reportOption)

Helper method to print body of the transaction summary report, listing all total fields.

Parameters:

transactionSummaryDataReportHolders -

document -

reportOption -

Returns:

true if successful else false

printReportBodyByAllTotalsForDetailReportOption

public boolean printReportBodyByAllTotalsForDetailReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryReportDataHolders,
                                                               com.lowagie.text.Document document)

Generates the Transaction Summary report showing all amounts fields.

Parameters:

transactionSummaryReports -

document -

Returns:

true if document created else return false

printReportBodyForDetailReportOption

public boolean printReportBodyForDetailReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryReportDataHolders,
                                                    com.lowagie.text.Document document)

Generates the Transaction Summary report showing only summary amount field. This report will only show the total amount field for each kemid

Parameters:

transactionSummaryReports -

document -

Returns:

true if document created else return false

printReportBodyByAllTotalsForTotalReportOption

protected boolean printReportBodyByAllTotalsForTotalReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                                 com.lowagie.text.Document document)

Method to combine the kemid totals into one data record and print all fields.

Parameters:

transactionSummaryDataReportHolders -

document -

Returns:

true if successful else return false

printReportBodyForSummaryReportOption

protected boolean printReportBodyForSummaryReportOption(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                        com.lowagie.text.Document document)

Method to combine the kemid totals into one data record and print only summary field.

Parameters:

transactionSummaryDataReportHolders -

document -

Returns:

true if successful else return false

combineKemidTotals

protected List<TransactionSummaryReportDataHolder> combineKemidTotals(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders)

getSummaryTotalsForContributions

protected void getSummaryTotalsForContributions(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                TransactionSummaryReportDataHolder transactionSummaryReportDataHolder)

Method to summarize the expenses list records for the summary totals report.

Parameters:

transactionSummaryDataReportHolders -

transactionSummaryReportDataHolder -

getSummaryTotalsForExpenses

protected void getSummaryTotalsForExpenses(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                           TransactionSummaryReportDataHolder transactionSummaryReportDataHolder)

Method to summarize the expenses list records for the summary totals report.

Parameters:

transactionSummaryDataReportHolders -

transactionSummaryReportDataHolder -

getSummaryTotalsForCashTransfers

protected void getSummaryTotalsForCashTransfers(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                TransactionSummaryReportDataHolder transactionSummaryReportDataHolder)

Method to summarize the cash transfers list records for the summary totals report.

Parameters:

transactionSummaryDataReportHolders -

transactionSummaryReportDataHolder -

getSummaryTotalsForSecurityTransfers

protected void getSummaryTotalsForSecurityTransfers(List<TransactionSummaryReportDataHolder> transactionSummaryDataReportHolders,
                                                    TransactionSummaryReportDataHolder transactionSummaryReportDataHolder)

Method to summarize the Security transfers list records for the summary totals report.

Parameters:

transactionSummaryDataReportHolders -

transactionSummaryReportDataHolder -

writeDetailLineRow

protected void writeDetailLineRow(com.lowagie.text.pdf.PdfPTable table,
                                  com.lowagie.text.Font cellFont,
                                  String description,
                                  BigDecimal incomeAmount,
                                  BigDecimal principalAmount,
                                  BigDecimal totalAmount)

Helper method to write the details line.

Parameters:

table -

cellFont -

description -

incomeAmount -

principalAmount -

totalAmount -

writeDetailLineRow

protected void writeDetailLineRow(com.lowagie.text.pdf.PdfPTable table,
                                  com.lowagie.text.Font cellFont,
                                  String description,
                                  BigDecimal totalAmount)

Helper method to write the details line.

Parameters:

table -

cellFont -

description -

incomeAmount -

principalAmount -

totalAmount -

writeContributionsRecordsForDetailReportOption

protected void writeContributionsRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                              com.lowagie.text.Font cellFont,
                                                              TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the contributions list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeContributionsRecordsForSummaryReportOption

protected void writeContributionsRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                               com.lowagie.text.Font cellFont,
                                                               TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the contributions list and write the lines..For summary report

Parameters:

table -

cellFont -

transactionSummaryReport -

writeExpensesRecordsForDetailReportOption

protected void writeExpensesRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                         com.lowagie.text.Font cellFont,
                                                         TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the expenses list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeExpensesRecordsForSummaryReportOption

protected void writeExpensesRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                          com.lowagie.text.Font cellFont,
                                                          TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the expenses list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeCashTransfersRecordsForDetailReportOption

protected void writeCashTransfersRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                              com.lowagie.text.Font cellFont,
                                                              TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the cash transfers list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeCashTransfersRecordsForSummaryReportOption

protected void writeCashTransfersRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                               com.lowagie.text.Font cellFont,
                                                               TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the expenses list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeSecurityTransfersRecordsForSummaryReportOption

protected void writeSecurityTransfersRecordsForSummaryReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                                   com.lowagie.text.Font cellFont,
                                                                   TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the security list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeSecurityTransfersRecordsForDetailReportOption

protected void writeSecurityTransfersRecordsForDetailReportOption(com.lowagie.text.pdf.PdfPTable table,
                                                                  com.lowagie.text.Font cellFont,
                                                                  TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to go through the cash transfers list and write the lines..

Parameters:

table -

cellFont -

transactionSummaryReport -

writeDocumentHeader

protected void writeDocumentHeader(com.lowagie.text.Document document,
                                   TransactionSummaryReportDataHolder transactionSummaryReport)

Helper method to write the document header

Parameters:

document -

transactionSummaryReport -

writeDocumentTitleHeadings

protected com.lowagie.text.pdf.PdfPTable writeDocumentTitleHeadings(String reportOption)

Helper method to write a line containing the column headings for the report

Returns:

table

writeSubHeader

protected void writeSubHeader(com.lowagie.text.pdf.PdfPTable table,
                              String subHeading,
                              String reportOption)

helper method to write out a sub-heading into the report.

writeDetailsLineWithTotalAmountOnly

protected void writeDetailsLineWithTotalAmountOnly(com.lowagie.text.pdf.PdfPTable table,
                                                   com.lowagie.text.Font cellFont,
                                                   String description,
                                                   BigDecimal amount,
                                                   String reportOption)

helper method to write the details lines where only the last column exists for amounts..

Parameters:

description -

amount -