org.kuali.kfs.gl.report
Class LedgerSummaryReport

java.lang.Object
  org.kuali.kfs.gl.report.LedgerSummaryReport

public class LedgerSummaryReport
extends Object

Helper class which can summarize entries by balance type and then print out a ledger summary report

Constructor Summary

LedgerSummaryReport()
Constructs a LedgerSummaryReport

Method Summary

protected void	addEntryToLedgerSummaries(OriginEntryInformation originEntry, LedgerSummaryTotalLine totalLine, LedgerBalanceTypeSummaryTotalLine balanceTypeTotal, LedgerSummaryDetailLine detailLine) Adds the amount of the origin entry into the appropriate total - debit, credit, or budget - on the various ledger summarizers
protected LedgerBalanceTypeSummaryTotalLine	getBalanceTypeSummaryTotalLine(OriginEntryInformation entry, Map<String,LedgerBalanceTypeSummaryTotalLine> balanceTypeTotals) Retrieves the proper balance type summarizer from the given map, or creates a new summarizer and puts it in the Map if it doesn't already exist
protected LedgerSummaryDetailLine	getDetailLine(OriginEntryInformation entry, Map<String,LedgerSummaryDetailLine> detailLines) Retrieves the proper detail line summarizer from the given map, or creates a new summarizer and adds it to the map if needed
void	summarizeEntry(OriginEntryInformation entry) Summarizes an entry into the various totals which this report is keeping
void	writeReport(ReportWriterService reportWriterService) Writes the report of totals to the given reportWriterService

Methods inherited from class java.lang.Object

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

Constructor Detail

LedgerSummaryReport

public LedgerSummaryReport()

Constructs a LedgerSummaryReport

Method Detail

summarizeEntry

public void summarizeEntry(OriginEntryInformation entry)

Summarizes an entry into the various totals which this report is keeping

Parameters:

entry - an entry to summarize

getBalanceTypeSummaryTotalLine

protected LedgerBalanceTypeSummaryTotalLine getBalanceTypeSummaryTotalLine(OriginEntryInformation entry,
                                                                           Map<String,LedgerBalanceTypeSummaryTotalLine> balanceTypeTotals)

Retrieves the proper balance type summarizer from the given map, or creates a new summarizer and puts it in the Map if it doesn't already exist

Parameters:

entry - the origin entry to find a balance type summarizer for

balanceTypeTotals - the Map of balance type summarizers

Returns:

the proper balance type summarizer

getDetailLine

protected LedgerSummaryDetailLine getDetailLine(OriginEntryInformation entry,
                                                Map<String,LedgerSummaryDetailLine> detailLines)

Retrieves the proper detail line summarizer from the given map, or creates a new summarizer and adds it to the map if needed

Parameters:

entry - the origin entry to find a detail line summarizer for

detailLines - a Map of detail line summarizers

Returns:

the proper detail line summarizer

addEntryToLedgerSummaries

protected void addEntryToLedgerSummaries(OriginEntryInformation originEntry,
                                         LedgerSummaryTotalLine totalLine,
                                         LedgerBalanceTypeSummaryTotalLine balanceTypeTotal,
                                         LedgerSummaryDetailLine detailLine)

Adds the amount of the origin entry into the appropriate total - debit, credit, or budget - on the various ledger summarizers

Parameters:

originEntry - the origin entry to add the total from

totalLine - a complete total to add the amount to

balanceTypeTotal - the total for the entries with the same balance type as the origin entry to add the amount to

detailLine - the proper detail amount to add the amoun tto

writeReport

public void writeReport(ReportWriterService reportWriterService)

Writes the report of totals to the given reportWriterService

Parameters:

reportWriterService - a report writer service to write the ledger summary report to