001 /*
002 * Copyright 2011 The Kuali Foundation.
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.kuali.kfs.module.ld.dataaccess.impl;
017
018 import java.util.ArrayList;
019 import java.util.Collection;
020 import java.util.HashMap;
021 import java.util.Iterator;
022 import java.util.List;
023 import java.util.Map;
024
025 import org.apache.ojb.broker.query.Criteria;
026 import org.apache.ojb.broker.query.Query;
027 import org.apache.ojb.broker.query.QueryByCriteria;
028 import org.apache.ojb.broker.query.QueryFactory;
029 import org.apache.ojb.broker.query.ReportQueryByCriteria;
030 import org.apache.ojb.broker.util.ObjectModification;
031 import org.kuali.kfs.gl.OJBUtility;
032 import org.kuali.kfs.module.ld.LaborConstants;
033 import org.kuali.kfs.module.ld.LaborPropertyConstants.AccountingPeriodProperties;
034 import org.kuali.kfs.module.ld.businessobject.AccountStatusCurrentFunds;
035 import org.kuali.kfs.module.ld.businessobject.July1PositionFunding;
036 import org.kuali.kfs.module.ld.dataaccess.LaborDao;
037 import org.kuali.kfs.module.ld.util.ConsolidationUtil;
038 import org.kuali.kfs.sys.KFSConstants;
039 import org.kuali.kfs.sys.KFSPropertyConstants;
040 import org.kuali.rice.kns.bo.BusinessObject;
041 import org.kuali.rice.kns.dao.impl.PlatformAwareDaoBaseOjb;
042 import org.kuali.rice.kns.util.KualiDecimal;
043
044 /**
045 * OJB Implementation of Labor Distribution DAO database queries.
046 */
047 public class LaborDaoOjb extends PlatformAwareDaoBaseOjb implements LaborDao {
048 private static final org.apache.commons.logging.Log LOG = org.apache.commons.logging.LogFactory.getLog(LaborDaoOjb.class);
049
050 /**
051 * @see org.kuali.kfs.module.ld.dataaccess.LaborDao#getEncumbranceTotal(java.util.Map)
052 */
053 public Object getEncumbranceTotal(Map fieldValues) {
054
055 Criteria criteria = new Criteria();
056 criteria.addAndCriteria(OJBUtility.buildCriteriaFromMap(fieldValues, new AccountStatusCurrentFunds()));
057
058 ReportQueryByCriteria query = QueryFactory.newReportQuery(AccountStatusCurrentFunds.class, criteria);
059
060 List<String> groupByList = new ArrayList<String>();
061 groupByList.add(KFSPropertyConstants.UNIVERSITY_FISCAL_YEAR);
062 groupByList.add(KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE);
063 groupByList.add(KFSPropertyConstants.ACCOUNT_NUMBER);
064 groupByList.add(KFSPropertyConstants.SUB_ACCOUNT_NUMBER);
065 groupByList.add(KFSPropertyConstants.FINANCIAL_OBJECT_CODE);
066 groupByList.add(KFSPropertyConstants.FINANCIAL_SUB_OBJECT_CODE);
067
068 String[] groupBy = (String[]) groupByList.toArray(new String[groupByList.size()]);
069
070 query.setAttributes(new String[] { ConsolidationUtil.sum(LaborConstants.BalanceInquiries.ANNUAL_BALANCE) + " + " + ConsolidationUtil.sum(LaborConstants.BalanceInquiries.CONTRACT_GRANT_BB_AMOUNT) });
071 query.addGroupBy(groupBy);
072
073 Object[] encumbrances = null;
074
075 Iterator<Object[]> accountStatusCurrentFunds = getPersistenceBrokerTemplate().getReportQueryIteratorByQuery(query);
076 while (accountStatusCurrentFunds != null && accountStatusCurrentFunds.hasNext()) {
077 encumbrances = accountStatusCurrentFunds.next();
078 }
079 KualiDecimal encumbranceTotal = KualiDecimal.ZERO;
080 if (encumbrances != null)
081 encumbranceTotal = new KualiDecimal(encumbrances[0].toString());
082 return encumbranceTotal;
083 }
084
085 /**
086 * @see org.kuali.kfs.module.ld.dataaccess.LaborDao#getJuly1(java.util.Map)
087 */
088 public Collection getJuly1(Map fieldValues) {
089 Map fieldCriteria = new HashMap();
090 fieldCriteria.putAll(fieldValues);
091 fieldCriteria.remove(KFSPropertyConstants.FINANCIAL_BALANCE_TYPE_CODE);
092
093 ArrayList objectTypeCodes = new ArrayList();
094 Criteria criteria = new Criteria();
095 criteria.addAndCriteria(OJBUtility.buildCriteriaFromMap(fieldCriteria, new July1PositionFunding()));
096 QueryByCriteria query = QueryFactory.newQuery(July1PositionFunding.class, criteria);
097
098 Collection<July1PositionFunding> july1PositionFundings = getPersistenceBrokerTemplate().getCollectionByQuery(query);
099 return july1PositionFundings;
100 }
101
102 /**
103 * @see org.kuali.kfs.module.ld.dataaccess.LaborDao#getCurrentFunds(java.util.Map)
104 */
105 public Iterator getCurrentFunds(Map fieldValues, boolean isConsolidated) {
106 fieldValues.put(KFSPropertyConstants.FINANCIAL_BALANCE_TYPE_CODE, KFSConstants.BALANCE_TYPE_ACTUAL);
107 return getAccountStatus(AccountStatusCurrentFunds.class, fieldValues, isConsolidated);
108 }
109
110 protected <T> Iterator getAccountStatus(Class<T> clazz, Map fieldValues, boolean isConsolidated) {
111 Query query = getAccountStatusQuery(clazz, fieldValues, isConsolidated);
112 OJBUtility.limitResultSize(query);
113
114 if (isConsolidated) {
115 return getPersistenceBrokerTemplate().getReportQueryIteratorByQuery(query);
116 }
117 return getPersistenceBrokerTemplate().getIteratorByQuery(query);
118 }
119
120 // build the query for balance search
121 protected <T> Query getAccountStatusQuery(Class<T> clazz, Map fieldValues, boolean isConsolidated) {
122 LOG.debug("getAccountStatusQuery(Class<T>, Map, boolean) started");
123 LOG.debug("Building criteria from map fields: " + fieldValues.entrySet());
124
125 Criteria criteria = new Criteria();
126 try {
127 criteria.addAndCriteria(OJBUtility.buildCriteriaFromMap(fieldValues, clazz.newInstance()));
128 }
129 catch (Exception e) {
130 LOG.error("Could not add and criteria properly for " + clazz);
131 throw new RuntimeException(e);
132 }
133
134 ReportQueryByCriteria query = QueryFactory.newReportQuery(clazz, criteria);
135 LOG.debug("Built query: " + query);
136
137 // if consolidated, then ignore subaccount number and balance type code
138 if (isConsolidated) {
139 ConsolidationUtil.buildConsolidatedQuery(query, ConsolidationUtil.sum(AccountingPeriodProperties.JULY.propertyName));
140 }
141
142 return query;
143 }
144
145 /**
146 * @see org.kuali.kfs.module.ld.dataaccess.LaborDao#getJuly1PositionFunding(java.util.Map)
147 */
148 public Collection<July1PositionFunding> getJuly1PositionFunding(Map<String, String> fieldValues) {
149 Criteria criteria = OJBUtility.buildCriteriaFromMap(fieldValues, new July1PositionFunding());
150
151 criteria.addEqualToField(KFSPropertyConstants.LABOR_OBJECT + "." + KFSPropertyConstants.UNIVERSITY_FISCAL_YEAR, KFSPropertyConstants.UNIVERSITY_FISCAL_YEAR);
152 criteria.addEqualToField(KFSPropertyConstants.LABOR_OBJECT + "." + KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE, KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE);
153 criteria.addEqualToField(KFSPropertyConstants.LABOR_OBJECT + "." + KFSPropertyConstants.FINANCIAL_OBJECT_CODE, KFSPropertyConstants.FINANCIAL_OBJECT_CODE);
154 criteria.addNotNull(KFSPropertyConstants.LABOR_OBJECT + "." + KFSPropertyConstants.FINANCIAL_OBJECT_FRINGE_OR_SALARY_CODE);
155
156 QueryByCriteria query = QueryFactory.newQuery(July1PositionFunding.class, criteria);
157 OJBUtility.limitResultSize(query);
158
159 return getPersistenceBrokerTemplate().getCollectionByQuery(query);
160 }
161
162 /**
163 * @see org.kuali.kfs.module.ld.dataaccess.LaborDao#insert(org.kuali.rice.kns.bo.BusinessObject)
164 */
165 public void insert(BusinessObject businessObject) {
166 getPersistenceBroker(true).store(businessObject, ObjectModification.INSERT);
167 }
168 }