org.kuali.ole.gl.dataaccess.impl

Class BalanceDaoOjb

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

org.kuali.ole.gl.dataaccess.impl.BalanceDaoOjb

All Implemented Interfaces:

BalanceDao, LedgerBalanceBalancingDao, org.kuali.rice.core.framework.persistence.dao.PlatformAwareDao, org.springframework.beans.factory.InitializingBean

public class BalanceDaoOjb
extends org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
implements BalanceDao, LedgerBalanceBalancingDao

An OJB implementation of BalanceDao

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
BalanceDaoOjb()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<String>	buildAttributeList(boolean isExtended) This method builds the atrribute list used by balance searching
protected org.apache.ojb.broker.query.Criteria	buildCriteriaFromMap(Map fieldValues, Balance balance, Collection<String> encumbranceBalanceTypes) This method builds the query criteria based on the input field map
protected List<String>	buildGroupByList() This method builds group by attribute list used by balance searching
int	countBalancesForFiscalYear(Integer year) Returns the count of balances for a given fiscal year; this method is used for year end job reporting
protected void	criteriaBuilder(org.apache.ojb.broker.query.Criteria criteria, String name, Collection collection) This method adds to the given criteria if the given collection is non-empty.
protected void	criteriaBuilderHelper(org.apache.ojb.broker.query.Criteria criteria, String name, Collection collection, boolean negate) This method provides the implementation for the conveniences methods criteriaBuilder & negatedCriteriaBuilder
Iterator<Balance>	findAccountBalances(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber) Find all matching account balances.
Iterator<Balance>	findAccountBalances(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String sfCode) Find all matching account balances.
Iterator<Balance>	findBalance(Map fieldValues, boolean isConsolidated, Collection<String> encumbranceBalanceTypes) Given a map of values, build a query out of those and find all the balances that qualify
Iterator<Balance>	findBalances(Account account, Integer fiscalYear, Collection includedObjectCodes, Collection excludedObjectCodes, Collection objectTypeCodes, Collection balanceTypeCodes) Build a query based on all the parameters, and return an Iterator of all Balances from the database that qualify
Iterator<Balance>	findBalancesForFiscalYear(Integer year) Queries the database for all the balances for a given fiscal year
Integer	findCountGreaterOrEqualThan(Integer year)
Iterator<Balance>	findCumulativeBalancesToForwardForFiscalYear(Integer year, Collection<String> cumulativeForwardBalanceObjectTypes, Collection<String> contractsAndGrantsDenotingValues, Collection<String> subFundGroupsForCumulativeBalanceForwarding, Collection<String> cumulativeBalanceForwardBalanceTypes, boolean fundGroupDenotesCGInd) Returns the C&G balances specifically to be forwarded to the next fiscal year, based on the "cumulative" rule
Iterator<Balance>	findGeneralBalancesToForwardForFiscalYear(Integer year, Collection<String> generalForwardBalanceObjectTypes, Collection<String> generalBalanceForwardBalanceTypes) Returns the balances specifically to be forwarded to the next fiscal year, based on the "general" rule
Iterator<Balance>	findNominalActivityBalancesForFiscalYear(Integer year, Collection<String> nominalActivityObjectTypeCodes, SystemOptions currentYearOptions) Finds all of the balances for the fiscal year that should be processed by nominal activity closing
Iterator<Balance>	findOrganizationReversionBalancesForFiscalYear(Integer year, boolean endOfYear, SystemOptions options, List<ParameterEvaluator> parameterEvaluators) Returns a list of balances to return for the Organization Reversion year end job to process
Balance	getBalanceByTransaction(Transaction t) Using values from the transaction as keys, lookup the balance the transaction would affect were it posted
protected org.apache.ojb.broker.query.ReportQueryByCriteria	getBalanceCountQuery(Map fieldValues, Collection<String> encumbranceBalanceTypes) build the query for balance search
protected org.apache.ojb.broker.query.Query	getBalanceQuery(Map fieldValues, boolean isConsolidated, Collection<String> encumbranceBalanceTypes) build the query for balance search
protected org.apache.ojb.broker.query.ReportQueryByCriteria	getCashBalanceCountQuery(Map fieldValues, Collection<String> encumbranceBalanceTypes) Builds a query for cash balances, based on the given field values
protected org.apache.ojb.broker.query.Query	getCashBalanceQuery(Map fieldValues, boolean isConsolidated, Collection<String> encumbranceBalanceTypes) build the query for cash balance search
Iterator	getConsolidatedBalanceRecordCount(Map fieldValues, Collection<String> encumbranceBalanceTypes) Given a Map of keys to use as a query, if we performed that query as a consolidated query...
int	getConsolidatedCashBalanceRecordCount(Map fieldValues, Collection<String> encumbranceBalanceTypes) Given a map of keys, return all of the report data about qualifying cash balances
Balance	getCurrentBudgetForObjectCode(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String objectCode) Since SubAccountNumber, SubObjectCode, and ObjectType are all part of the primary key of Balance, you're guaranteed to get one of those records when you call this method.
Integer	getDetailedCashBalanceRecordCount(Map fieldValues, Collection<String> encumbranceBalanceTypes) Get the number of detailed cash balance records that would be returned, were we to do a query based on the given fieldValues
Iterator<Object[]>	getGlSummary(int universityFiscalYear, Collection<String> balanceTypeCodes) Does a ReportQuery to summarize GL balance data
Iterator<Balance>	lookupCashBalance(Map fieldValues, boolean isConsolidated, Collection<String> encumbranceBalanceTypes) Using the given fieldValues as keys, return all cash balance records.
protected void	negatedCriteriaBuilder(org.apache.ojb.broker.query.Criteria criteria, String name, Collection collection) Similar to criteriaBuilder, this adds a negative criterion (NOT EQUALS, NOT IN)
void	purgeYearByChart(String chartOfAccountsCode, int year) Purge the sufficient funds balance table by year/chart

Methods inherited from class org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

getDbPlatform, setDbPlatform

Methods inherited from class org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

BalanceDaoOjb

public BalanceDaoOjb()

Method Detail

getGlSummary

public Iterator<Object[]> getGlSummary(int universityFiscalYear,
                              Collection<String> balanceTypeCodes)

Does a ReportQuery to summarize GL balance data

Specified by:

getGlSummary in interface BalanceDao

Parameters:

universityFiscalYear - the fiscal year of balances to search for

balanceTypeCodes - a list of balance type codes of balances to search for

Returns:

iterator of reported on java.lang.Object arrays with the report data

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#getGlSummary(int, java.util.List)

findBalancesForFiscalYear

public Iterator<Balance> findBalancesForFiscalYear(Integer year)

Queries the database for all the balances for a given fiscal year

Specified by:

findBalancesForFiscalYear in interface BalanceDao

Parameters:

year - the university fiscal year of balances to return

Returns:

an iterator over all balances for a given fiscal year

See Also:

BalanceDao.findBalancesForFiscalYear(java.lang.Integer)

getBalanceByTransaction

public Balance getBalanceByTransaction(Transaction t)

Using values from the transaction as keys, lookup the balance the transaction would affect were it posted

Specified by:

getBalanceByTransaction in interface BalanceDao

Parameters:

t - a transaction

Returns:

a Balance that the given transaction would affect

See Also:

BalanceDao.getBalanceByTransaction(org.kuali.ole.gl.businessobject.Transaction)

criteriaBuilder

protected void criteriaBuilder(org.apache.ojb.broker.query.Criteria criteria,
                   String name,
                   Collection collection)

This method adds to the given criteria if the given collection is non-empty. It uses an EQUALS if there is exactly one element in the collection; otherwise, its uses an IN

Parameters:

criteria - - the criteria that might have a criterion appended

name - - name of the attribute

collection - - the collection to inspect

negatedCriteriaBuilder

protected void negatedCriteriaBuilder(org.apache.ojb.broker.query.Criteria criteria,
                          String name,
                          Collection collection)

Similar to criteriaBuilder, this adds a negative criterion (NOT EQUALS, NOT IN)

Parameters:

criteria - - the criteria that might have a criterion appended

name - - name of the attribute

collection - - the collection to inspect

criteriaBuilderHelper

protected void criteriaBuilderHelper(org.apache.ojb.broker.query.Criteria criteria,
                         String name,
                         Collection collection,
                         boolean negate)

This method provides the implementation for the conveniences methods criteriaBuilder & negatedCriteriaBuilder

Parameters:

criteria - - the criteria that might have a criterion appended

name - - name of the attribute

collection - - the collection to inspect

negate - - the criterion will be negated (NOT EQUALS, NOT IN) when this is true

findBalances

public Iterator<Balance> findBalances(Account account,
                             Integer fiscalYear,
                             Collection includedObjectCodes,
                             Collection excludedObjectCodes,
                             Collection objectTypeCodes,
                             Collection balanceTypeCodes)

Build a query based on all the parameters, and return an Iterator of all Balances from the database that qualify

Specified by:

findBalances in interface BalanceDao

Parameters:

account - the account of balances to find

fiscalYear - the fiscal year of balances to find

includedObjectCodes - a Collection of object codes found balances should have one of

excludedObjectCodes - a Collection of object codes found balances should not have one of

objectTypeCodes - a Collection of object type codes found balances should have one of

balanceTypeCodes - a Collection of balance type codes found balances should have one of

Returns:

an Iterator of Balances

See Also:

BalanceDao.findBalances(org.kuali.ole.coa.businessobject.Account, java.lang.Integer, java.util.Collection, java.util.Collection, java.util.Collection, java.util.Collection)

lookupCashBalance

public Iterator<Balance> lookupCashBalance(Map fieldValues,
                                  boolean isConsolidated,
                                  Collection<String> encumbranceBalanceTypes)

Using the given fieldValues as keys, return all cash balance records. The results will be limited to the system lookup results limit.

Specified by:

lookupCashBalance in interface BalanceDao

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

encumbranceBalanceTypes - a list of encumbrance Balance Types

Returns:

the records of cash balance entries

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#lookupCashBalance(Map, boolean, List)

getDetailedCashBalanceRecordCount

public Integer getDetailedCashBalanceRecordCount(Map fieldValues,
                                        Collection<String> encumbranceBalanceTypes)

Get the number of detailed cash balance records that would be returned, were we to do a query based on the given fieldValues

Specified by:

getDetailedCashBalanceRecordCount in interface BalanceDao

Parameters:

fieldValues - the input fields and values

isConsolidated - consolidation option is applied or not

Returns:

the size collection of cash balance entry groups

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#getDetailedCashBalanceRecordCount(Map, List)

getConsolidatedCashBalanceRecordCount

public int getConsolidatedCashBalanceRecordCount(Map fieldValues,
                                        Collection<String> encumbranceBalanceTypes)

Given a map of keys, return all of the report data about qualifying cash balances

Specified by:

getConsolidatedCashBalanceRecordCount in interface BalanceDao

Parameters:

fieldValues - the input fields and values

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

the size collection of cash balance entry groups

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#getConsolidatedCashBalanceRecordCount(Map, List)

findBalance

public Iterator<Balance> findBalance(Map fieldValues,
                            boolean isConsolidated,
                            Collection<String> encumbranceBalanceTypes)

Given a map of values, build a query out of those and find all the balances that qualify

Specified by:

findBalance in interface BalanceDao

Parameters:

fieldValues - a Map of fieldValues to use as keys in the query

isConsolidated - should the results be consolidated?

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

an Iterator of Balances

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#findBalance(java.util.Map, boolean)

getConsolidatedBalanceRecordCount

public Iterator getConsolidatedBalanceRecordCount(Map fieldValues,
                                         Collection<String> encumbranceBalanceTypes)

Given a Map of keys to use as a query, if we performed that query as a consolidated query... how many records would we get back?

Specified by:

getConsolidatedBalanceRecordCount in interface BalanceDao

Parameters:

fieldValues - a Map of values to use as keys to build the query

encumbranceBalanceTypes - a list of encumbrance balance types

Returns:

an Iterator of counts...

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#getConsolidatedBalanceRecordCount(Map, List)

getCashBalanceCountQuery

protected org.apache.ojb.broker.query.ReportQueryByCriteria getCashBalanceCountQuery(Map fieldValues,
                                                                         Collection<String> encumbranceBalanceTypes)

Builds a query for cash balances, based on the given field values

Parameters:

fieldValues - a map of keys to use when building the query

Returns:

an OJB ReportQuery to use as the query

getCashBalanceQuery

protected org.apache.ojb.broker.query.Query getCashBalanceQuery(Map fieldValues,
                                                    boolean isConsolidated,
                                                    Collection<String> encumbranceBalanceTypes)

build the query for cash balance search

Parameters:

fieldValues - Map of keys to use for the query

isConsolidated - should the results be consolidated?

Returns:

the OJB query to perform

getBalanceQuery

protected org.apache.ojb.broker.query.Query getBalanceQuery(Map fieldValues,
                                                boolean isConsolidated,
                                                Collection<String> encumbranceBalanceTypes)

build the query for balance search

Parameters:

fieldValues - Map of keys to use for the query

isConsolidated - should the results be consolidated?

Returns:

an OJB query to perform

getBalanceCountQuery

protected org.apache.ojb.broker.query.ReportQueryByCriteria getBalanceCountQuery(Map fieldValues,
                                                                     Collection<String> encumbranceBalanceTypes)

build the query for balance search

Parameters:

fieldValues - Map of keys to use for the query

Returns:

an OJB ReportQuery to perform

buildCriteriaFromMap

protected org.apache.ojb.broker.query.Criteria buildCriteriaFromMap(Map fieldValues,
                                                        Balance balance,
                                                        Collection<String> encumbranceBalanceTypes)

This method builds the query criteria based on the input field map

Parameters:

fieldValues - Map of keys to use for the query

balance - this really usen't used in the method

Returns:

a query criteria

buildAttributeList

protected List<String> buildAttributeList(boolean isExtended)

This method builds the atrribute list used by balance searching

Parameters:

isExtended - should we add the attributes to sum each of the monthly totals?

Returns:

List an attribute list

buildGroupByList

protected List<String> buildGroupByList()

This method builds group by attribute list used by balance searching

Returns:

List an group by attribute list

getCurrentBudgetForObjectCode

public Balance getCurrentBudgetForObjectCode(Integer universityFiscalYear,
                                    String chartOfAccountsCode,
                                    String accountNumber,
                                    String objectCode)

Since SubAccountNumber, SubObjectCode, and ObjectType are all part of the primary key of Balance, you're guaranteed to get one of those records when you call this method. Let's hope the right one.

Specified by:

getCurrentBudgetForObjectCode in interface BalanceDao

Parameters:

universityFiscalYear - the fiscal year of the CB balance to return

chartOfAccountsCode - the chart of the accounts code of the CB balanes to return

accountNumber - the account number of the CB balance to return

objectCode - the object code of the CB balance to return

Returns:

the CB Balance record

See Also:

BalanceDao.getCurrentBudgetForObjectCode(java.lang.Integer, java.lang.String, java.lang.String, java.lang.String)

findAccountBalances

public Iterator<Balance> findAccountBalances(Integer universityFiscalYear,
                                    String chartOfAccountsCode,
                                    String accountNumber)

Find all matching account balances.

Specified by:

findAccountBalances in interface BalanceDao

Parameters:

universityFiscalYear - the university fiscal year of balances to return

chartOfAccountsCode - the chart of accounts code of balances to return

accountNumber - the account number of balances to return

Returns:

balances sorted by object code

findAccountBalances

public Iterator<Balance> findAccountBalances(Integer universityFiscalYear,
                                    String chartOfAccountsCode,
                                    String accountNumber,
                                    String sfCode)

Find all matching account balances. The Sufficient funds code is used to determine the sort of the results.

Specified by:

findAccountBalances in interface BalanceDao

Parameters:

universityFiscalYear - the university fiscal year of balances to return

chartOfAccountsCode - the chart of accounts code of balances to return

accountNumber - the account number of balances to return

sfCode - the sufficient funds code, used to sort on

Returns:

an Iterator of balances

purgeYearByChart

public void purgeYearByChart(String chartOfAccountsCode,
                    int year)

Purge the sufficient funds balance table by year/chart

Specified by:

purgeYearByChart in interface BalanceDao

Parameters:

chart - the chart of balances to purge

year - the university fiscal year of balances to purge

countBalancesForFiscalYear

public int countBalancesForFiscalYear(Integer year)

Returns the count of balances for a given fiscal year; this method is used for year end job reporting

Specified by:

countBalancesForFiscalYear in interface BalanceDao

Parameters:

year - the university fiscal year to count balances for

Returns:

an int with the count of balances for that fiscal year

See Also:

BalanceDao.countBalancesForFiscalYear(java.lang.Integer)

findNominalActivityBalancesForFiscalYear

public Iterator<Balance> findNominalActivityBalancesForFiscalYear(Integer year,
                                                         Collection<String> nominalActivityObjectTypeCodes,
                                                         SystemOptions currentYearOptions)

Finds all of the balances for the fiscal year that should be processed by nominal activity closing

Specified by:

findNominalActivityBalancesForFiscalYear in interface BalanceDao

Parameters:

year - the university fiscal year of balances to find

nominalActivityObjectTypeCodes - a List of nominal activity object type codes

currentYearOptions - current year options

Returns:

an Iterator of Balances to process

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#findNominalActivityBalancesForFiscalYear(Integer, List, SystemOptions)

findGeneralBalancesToForwardForFiscalYear

public Iterator<Balance> findGeneralBalancesToForwardForFiscalYear(Integer year,
                                                          Collection<String> generalForwardBalanceObjectTypes,
                                                          Collection<String> generalBalanceForwardBalanceTypes)

Description copied from interface: BalanceDao

Returns the balances specifically to be forwarded to the next fiscal year, based on the "general" rule

Specified by:

findGeneralBalancesToForwardForFiscalYear in interface BalanceDao

Parameters:

year - the fiscal year to find balances for

generalForwardBalanceObjectTypes - a List of general Forward Balance Object Types

generalBalanceForwardBalanceTypes - an array of general Balance Forward Balance Types

Returns:

an Iterator full of Balances

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#findGeneralBalancesToForwardForFiscalYear(java.lang.Integer, java.util.List, java.lang.String[])

findCumulativeBalancesToForwardForFiscalYear

public Iterator<Balance> findCumulativeBalancesToForwardForFiscalYear(Integer year,
                                                             Collection<String> cumulativeForwardBalanceObjectTypes,
                                                             Collection<String> contractsAndGrantsDenotingValues,
                                                             Collection<String> subFundGroupsForCumulativeBalanceForwarding,
                                                             Collection<String> cumulativeBalanceForwardBalanceTypes,
                                                             boolean fundGroupDenotesCGInd)

Description copied from interface: BalanceDao

Returns the C&G balances specifically to be forwarded to the next fiscal year, based on the "cumulative" rule

Specified by:

findCumulativeBalancesToForwardForFiscalYear in interface BalanceDao

Parameters:

year - the fiscal year to find balances for

cumulativeForwardBalanceObjectTypes - a List of cumulative Forward Balance Object Types

contractsAndGrantsDenotingValues - a List of contracts And Grants Denoting Values

subFundGroupsForCumulativeBalanceForwarding - an array of sub Fund Groups For Cumulative Balance Forwarding

cumulativeBalanceForwardBalanceTypes - an array of cumulative Balance Forward Balance Types

Returns:

and Iterator chuck full of Balances

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#findCumulativeBalancesToForwardForFiscalYear(java.lang.Integer, java.util.List, java.util.List, java.lang.String[], java.lang.String[])

findOrganizationReversionBalancesForFiscalYear

public Iterator<Balance> findOrganizationReversionBalancesForFiscalYear(Integer year,
                                                               boolean endOfYear,
                                                               SystemOptions options,
                                                               List<ParameterEvaluator> parameterEvaluators)

Returns a list of balances to return for the Organization Reversion year end job to process

Specified by:

findOrganizationReversionBalancesForFiscalYear in interface BalanceDao

Parameters:

the - university fiscal year to find balances for

endOfYear - if true, use current year accounts, otherwise use prior year accounts

Returns:

an Iterator of Balances to process

See Also:

org.kuali.ole.gl.dataaccess.BalanceDao#findOrganizationReversionBalancesForFiscalYear(Integer, boolean, SystemOptions)

findCountGreaterOrEqualThan

public Integer findCountGreaterOrEqualThan(Integer year)

Specified by:

findCountGreaterOrEqualThan in interface LedgerBalanceBalancingDao

Parameters:

year - the given university fiscal year

Returns:

count of rows for the given fiscal year

See Also:

org.kuali.ole.gl.dataaccess.BalancingDao#findCountGreaterOrEqualThan(java.lang.Integer)