org.kuali.kfs.module.ld.util
Class ConsolidationUtil

java.lang.Object
  org.kuali.kfs.module.ld.util.ConsolidationUtil

public class ConsolidationUtil
extends Object

Utility class for helping DAOs deal with building queries for the consolidation option

Constructor Summary

ConsolidationUtil()

Method Summary

static Collection<String>	buildAttributeCollection(Collection<String> extendedFields) This method builds the atrribute list used by balance searching
static Collection<String>	buildAttributeCollection(String... extendedFields) This method builds the atrribute list used by balance searching
static void	buildConsolidatedQuery(org.apache.ojb.broker.query.ReportQueryByCriteria query, String... extraFields) Utility class for helping DAOs deal with building queries for the consolidation option
static Collection<String>	buildGroupByCollection(Collection<String> extraFields) This method builds group by attribute list used by balance searching
static Collection<String>	buildGroupByCollection(String... extraFields) This method builds group by attribute list used by balance searching
static Collection<LedgerBalance>	consolidateA2Balances(Collection<LedgerBalance> actualBalances, Collection<LedgerBalance> effortBalances, String consolidatedBalanceTypeCode, List<String> consolidationKeyList) Consolidates a collection of actual balances with a collection of A2 balances.
static String	sum(String fieldName) wrap the given field name with SQL function "sum"
static void	sumLedgerBalances(LedgerBalance balance1, LedgerBalance balance2) Adds the amounts fields of the second balance record to the first.
static String	wrapAttributeName(String attributeName, boolean isAttributeNameNeeded) wrap the attribute name based on the given flag: isAttributeNameNeeded

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsolidationUtil

public ConsolidationUtil()

Method Detail

sum

public static final String sum(String fieldName)

wrap the given field name with SQL function "sum"

Parameters:

fieldName - the given field name

Returns:

the wrapped field name with SQL function "sum"

buildAttributeCollection

public static Collection<String> buildAttributeCollection(String... extendedFields)

This method builds the atrribute list used by balance searching

Parameters:

extendedFields - extra fields

Returns:

List an attribute list

buildAttributeCollection

public static Collection<String> buildAttributeCollection(Collection<String> extendedFields)

This method builds the atrribute list used by balance searching

Parameters:

extendedFields - extra fields

Returns:

Collection an attribute list

buildConsolidatedQuery

public static void buildConsolidatedQuery(org.apache.ojb.broker.query.ReportQueryByCriteria query,
                                          String... extraFields)

Utility class for helping DAOs deal with building queries for the consolidation option

Parameters:

query - Query to make consolidated

extraFields - fields included in the query

ignoredFields - to omit from the query

buildGroupByCollection

public static Collection<String> buildGroupByCollection(Collection<String> extraFields)

This method builds group by attribute list used by balance searching

Returns:

extraFields

buildGroupByCollection

public static Collection<String> buildGroupByCollection(String... extraFields)

This method builds group by attribute list used by balance searching

Returns:

extraFields

consolidateA2Balances

public static Collection<LedgerBalance> consolidateA2Balances(Collection<LedgerBalance> actualBalances,
                                                              Collection<LedgerBalance> effortBalances,
                                                              String consolidatedBalanceTypeCode,
                                                              List<String> consolidationKeyList)

Consolidates a collection of actual balances with a collection of A2 balances. The A2 balances are changed to AC, then matched by balance key with balances from the actual collection.

Parameters:

actualBalances - - collection of actual balances (consolidatedBalanceTypeCode)

effortBalances - - collection of effort balances ('A2')

consolidatedBalanceTypeCode - - balance type to change A2 records to

Returns:

Collection - collection with consolidated balance records

sumLedgerBalances

public static void sumLedgerBalances(LedgerBalance balance1,
                                     LedgerBalance balance2)

Adds the amounts fields of the second balance record to the first.

Parameters:

balance1 - - LedgerBalance

balance2 - - LedgerBalance

wrapAttributeName

public static String wrapAttributeName(String attributeName,
                                       boolean isAttributeNameNeeded)

wrap the attribute name based on the given flag: isAttributeNameNeeded

Parameters:

attributeName - the given attribute name

isAttributeNameNeeded - the flag that indicates if the attribute name needs to be wrapped with consolidation

Returns:

the attribute name as it is if isAttributeNameNeeded is true; otherwise, the attribute name wrapped with consolidation string