org.kuali.kfs.gl.report
Class CollectorReportData

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

public class CollectorReportData
extends Object

This class aggregates all of the status information together from all of the collector-related processes. Note: this code assumes that each batch is identified by a different collector batch name.

Constructor Summary

CollectorReportData()

Method Summary

void	addBatch(CollectorBatch batch) Adds a batch to this report data object.
Iterator<CollectorBatch>	getAddedBatches()
Set<String>	getAllUnparsableFileNames()
Map<Transaction,List<Message>>	getBatchOriginEntryScrubberErrors(CollectorBatch batch) Returns the scrubber errors related to a batch
DemergerReportData	getDemergerReportData(CollectorBatch batch)
Map<String,String>	getEmailSendingStatus()
LedgerSummaryReport	getLedgerSummaryReport() Gets the ledgerSummaryReport attribute.
Collection<String>	getLoadedfileNames()
org.kuali.rice.kns.util.MessageMap	getMessageMapForFileName(String fileName)
int	getNumberOfAddedBatches() Returns the number of batches that have been added using the addBatch(CollectorBatch) method
Integer	getNumDetailAccountValuesChanged(CollectorBatch batch)
Integer	getNumDetailDeleted(CollectorBatch batch)
Integer	getNumInputDetails(CollectorBatch batch)
int	getNumNotPersistedBatches() Gets the numNotPersistedBatches attribute.
int	getNumNotPersistedCollectorDetailRecords()
int	getNumNotPersistedOriginEntryRecords()
int	getNumPersistedBatches() Gets the numPersistedBatches attribute.
Integer	getNumSavedDetails(CollectorBatch batch)
PreScrubberReportData	getPreScrubberReportData()
ScrubberReportData	getScrubberReportData(CollectorBatch batch)
Map<DocumentGroupData,OriginEntryTotals>	getTotalsOnInputOriginEntriesAssociatedWithErrorGroup(CollectorBatch batch) Returns the totals or all origin entries in the input group that match the document group (doc #, doc type, origination code) of at least one origin entry in the error group, which is generated by the scrubber
void	incrementNumNonPersistedBatches()
void	incrementNumNotPersistedCollectorDetailRecords(int records)
void	incrementNumNotPersistedOriginEntryRecords(int records)
void	incrementNumPersistedBatches()
boolean	isBatchAdded(CollectorBatch batch) Returns whether a batch has already been added
boolean	isBatchValid(CollectorBatch batch) Returns true if batch is valid; False if invalid
void	markUnparsableFileNames(String fileName)
void	markValidationStatus(CollectorBatch batch, boolean validStatus) Marks whether or not a batch is valid or not
void	setBatchDetailScrubberErrors(CollectorBatch batch, Map<CollectorDetail,List<Message>> errorsMap) Stores the errors encountered trying to scrub the InterDepartmentalBilling records in the given batch.
void	setBatchOriginEntryScrubberErrors(CollectorBatch batch, Map<Transaction,List<Message>> errorsMap) Stores the errors encountered trying to scrub the InterDepartmentalBilling records in the given batch.
void	setDemergerReportData(CollectorBatch batch, DemergerReportData demergerReportData)
void	setEmailSendingStatusForParsedBatch(CollectorBatch batch, String emailStatus)
void	setNumDetailAccountValuesChanged(CollectorBatch batch, Integer numDetailAccountValuesChanged) Sets the number of times the details in a batch have had their account numbers changed
void	setNumDetailDeleted(CollectorBatch batch, Integer numDetailDeleted)
void	setNumInputDetails(CollectorBatch batch)
void	setNumSavedDetails(CollectorBatch batch, Integer numSavedDetails)
void	setScrubberReportData(CollectorBatch batch, ScrubberReportData scrubberReportData)
void	setTotalsOnInputOriginEntriesAssociatedWithErrorGroup(CollectorBatch batch, Map<DocumentGroupData,OriginEntryTotals> totals) Stores the totals or all origin entries in the input group that match the document group (doc #, doc type, origination code) of at least one origin entry in the error group, which is generated by the scrubber
protected void	throwExceptionIfBatchNotAdded(CollectorBatch batch) Throws exception if batch has not been added

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectorReportData

public CollectorReportData()

Method Detail

addBatch

public void addBatch(CollectorBatch batch)

Adds a batch to this report data object. If the batch (identified using batch.getBatchName()) has already been added, then an exception is thrown.

Parameters:

batch - collector batch from xml input

isBatchAdded

public boolean isBatchAdded(CollectorBatch batch)

Returns whether a batch has already been added

Parameters:

batch - collector batch from xml input

Returns:

true if batch has already been added

getNumberOfAddedBatches

public int getNumberOfAddedBatches()

Returns the number of batches that have been added using the addBatch(CollectorBatch) method

Returns:

number of added batches

throwExceptionIfBatchNotAdded

protected void throwExceptionIfBatchNotAdded(CollectorBatch batch)

Throws exception if batch has not been added

Parameters:

batch -

setBatchDetailScrubberErrors

public void setBatchDetailScrubberErrors(CollectorBatch batch,
                                         Map<CollectorDetail,List<Message>> errorsMap)

Stores the errors encountered trying to scrub the InterDepartmentalBilling records in the given batch. This method must be called after addBatch has been called with the same batch. Previously saved errors for this batch will be overwritten.

Parameters:

batch - collector batch from input xml

errorsMap - contains a map of all errors encountered while trying to scrub InterDepartmentalBilling records

setBatchOriginEntryScrubberErrors

public void setBatchOriginEntryScrubberErrors(CollectorBatch batch,
                                              Map<Transaction,List<Message>> errorsMap)

Stores the errors encountered trying to scrub the InterDepartmentalBilling records in the given batch. This method must be called after addBatch has been called with the same batch. Previously saved errors for this batch will be overwritten.

Parameters:

batch - collector batch from input xml

errorsMap -

getBatchOriginEntryScrubberErrors

public Map<Transaction,List<Message>> getBatchOriginEntryScrubberErrors(CollectorBatch batch)

Returns the scrubber errors related to a batch

Parameters:

batch - collector batch from input xml

Returns:

Map returns a map containing a list of error messages for each transaction

setScrubberReportData

public void setScrubberReportData(CollectorBatch batch,
                                  ScrubberReportData scrubberReportData)

getScrubberReportData

public ScrubberReportData getScrubberReportData(CollectorBatch batch)

setDemergerReportData

public void setDemergerReportData(CollectorBatch batch,
                                  DemergerReportData demergerReportData)

getDemergerReportData

public DemergerReportData getDemergerReportData(CollectorBatch batch)

markUnparsableFileNames

public void markUnparsableFileNames(String fileName)

getAllUnparsableFileNames

public Set<String> getAllUnparsableFileNames()

setEmailSendingStatusForParsedBatch

public void setEmailSendingStatusForParsedBatch(CollectorBatch batch,
                                                String emailStatus)

getAddedBatches

public Iterator<CollectorBatch> getAddedBatches()

getEmailSendingStatus

public Map<String,String> getEmailSendingStatus()

setNumDetailAccountValuesChanged

public void setNumDetailAccountValuesChanged(CollectorBatch batch,
                                             Integer numDetailAccountValuesChanged)

Sets the number of times the details in a batch have had their account numbers changed

Parameters:

batch - collector batch from input xml

getNumDetailAccountValuesChanged

public Integer getNumDetailAccountValuesChanged(CollectorBatch batch)

setNumDetailDeleted

public void setNumDetailDeleted(CollectorBatch batch,
                                Integer numDetailDeleted)

getNumDetailDeleted

public Integer getNumDetailDeleted(CollectorBatch batch)

setTotalsOnInputOriginEntriesAssociatedWithErrorGroup

public void setTotalsOnInputOriginEntriesAssociatedWithErrorGroup(CollectorBatch batch,
                                                                  Map<DocumentGroupData,OriginEntryTotals> totals)

Stores the totals or all origin entries in the input group that match the document group (doc #, doc type, origination code) of at least one origin entry in the error group, which is generated by the scrubber

Parameters:

batch - collector batch from input xml

totals - a map such that the key is a document group (doc #, doc type, origination code) and the value is the totals of the origin entry of all those

getTotalsOnInputOriginEntriesAssociatedWithErrorGroup

public Map<DocumentGroupData,OriginEntryTotals> getTotalsOnInputOriginEntriesAssociatedWithErrorGroup(CollectorBatch batch)

Returns the totals or all origin entries in the input group that match the document group (doc #, doc type, origination code) of at least one origin entry in the error group, which is generated by the scrubber

Parameters:

batch - return a map such that the key is a document group (doc #, doc type, origination code) and the value is the totals of the origin entry of all those

setNumInputDetails

public void setNumInputDetails(CollectorBatch batch)

getNumInputDetails

public Integer getNumInputDetails(CollectorBatch batch)

setNumSavedDetails

public void setNumSavedDetails(CollectorBatch batch,
                               Integer numSavedDetails)

getNumSavedDetails

public Integer getNumSavedDetails(CollectorBatch batch)

incrementNumPersistedBatches

public void incrementNumPersistedBatches()

getNumPersistedBatches

public int getNumPersistedBatches()

Gets the numPersistedBatches attribute.

Returns:

Returns the numPersistedBatches.

incrementNumNonPersistedBatches

public void incrementNumNonPersistedBatches()

getNumNotPersistedBatches

public int getNumNotPersistedBatches()

Gets the numNotPersistedBatches attribute.

Returns:

Returns the numNotPersistedBatches.

incrementNumNotPersistedOriginEntryRecords

public void incrementNumNotPersistedOriginEntryRecords(int records)

getNumNotPersistedOriginEntryRecords

public int getNumNotPersistedOriginEntryRecords()

incrementNumNotPersistedCollectorDetailRecords

public void incrementNumNotPersistedCollectorDetailRecords(int records)

getNumNotPersistedCollectorDetailRecords

public int getNumNotPersistedCollectorDetailRecords()

markValidationStatus

public void markValidationStatus(CollectorBatch batch,
                                 boolean validStatus)

Marks whether or not a batch is valid or not

Parameters:

batch - collector batch from input xml

validStatus - valid status fro batch

isBatchValid

public boolean isBatchValid(CollectorBatch batch)

Returns true if batch is valid; False if invalid

Parameters:

batch - collector batch from input xml

Returns:

true if batch is valid

getLedgerSummaryReport

public LedgerSummaryReport getLedgerSummaryReport()

Gets the ledgerSummaryReport attribute.

Returns:

Returns the ledgerSummaryReport.

getPreScrubberReportData

public PreScrubberReportData getPreScrubberReportData()

getMessageMapForFileName

public org.kuali.rice.kns.util.MessageMap getMessageMapForFileName(String fileName)

getLoadedfileNames

public Collection<String> getLoadedfileNames()