/*
    * The Kuali Financial System, a comprehensive financial management system for higher education.
    * 
    * Copyright 2005-2014 The Kuali Foundation
    * 
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU Affero General Public License as
    * published by the Free Software Foundation, either version 3 of the
    * License, or (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU Affero General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   */
  
  package org.kuali.kfs.fp.businessobject;
  
  import static org.kuali.kfs.sys.KFSPropertyConstants.ACCOUNT_NUMBER;
  import static org.kuali.kfs.sys.KFSPropertyConstants.AMOUNT;
  import static org.kuali.kfs.sys.KFSPropertyConstants.CHART_OF_ACCOUNTS_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.CREDIT;
  import static org.kuali.kfs.sys.KFSPropertyConstants.DEBIT;
  import static org.kuali.kfs.sys.KFSPropertyConstants.ENCUMBRANCE_UPDATE_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.FINANCIAL_DOCUMENT_LINE_DESCRIPTION;
  import static org.kuali.kfs.sys.KFSPropertyConstants.FINANCIAL_OBJECT_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.FINANCIAL_SUB_OBJECT_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.OBJECT_TYPE_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.ORGANIZATION_REFERENCE_ID;
  import static org.kuali.kfs.sys.KFSPropertyConstants.PROJECT_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.REFERENCE_NUMBER;
  import static org.kuali.kfs.sys.KFSPropertyConstants.REFERENCE_ORIGIN_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.REFERENCE_TYPE_CODE;
  import static org.kuali.kfs.sys.KFSPropertyConstants.SUB_ACCOUNT_NUMBER;
  
  import java.util.Map;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.kfs.coa.service.BalanceTypeService;
  import org.kuali.kfs.sys.KFSConstants;
  import org.kuali.kfs.sys.businessobject.SourceAccountingLine;
  import org.kuali.kfs.sys.context.SpringContext;
  
  /**
   * This class represents a <code>JournalVoucherDocument</code> accounting line parser.
   */
  public class JournalVoucherAccountingLineParser extends AuxiliaryVoucherAccountingLineParser {
      private String balanceTypeCode;
      protected static final String[] NON_OFFSET_FORMAT = { CHART_OF_ACCOUNTS_CODE, ACCOUNT_NUMBER, SUB_ACCOUNT_NUMBER, FINANCIAL_OBJECT_CODE, OBJECT_TYPE_CODE, FINANCIAL_SUB_OBJECT_CODE, PROJECT_CODE, FINANCIAL_DOCUMENT_LINE_DESCRIPTION, ORGANIZATION_REFERENCE_ID, AMOUNT };
      protected static final String[] OFFSET_FORMAT = { CHART_OF_ACCOUNTS_CODE, ACCOUNT_NUMBER, SUB_ACCOUNT_NUMBER, FINANCIAL_OBJECT_CODE, OBJECT_TYPE_CODE, FINANCIAL_SUB_OBJECT_CODE, PROJECT_CODE, FINANCIAL_DOCUMENT_LINE_DESCRIPTION, ORGANIZATION_REFERENCE_ID, DEBIT, CREDIT };
      protected static final String[] ENCUMBRANCE_FORMAT = { CHART_OF_ACCOUNTS_CODE, ACCOUNT_NUMBER, SUB_ACCOUNT_NUMBER, FINANCIAL_OBJECT_CODE, OBJECT_TYPE_CODE, FINANCIAL_SUB_OBJECT_CODE, PROJECT_CODE, ORGANIZATION_REFERENCE_ID, ENCUMBRANCE_UPDATE_CODE, FINANCIAL_DOCUMENT_LINE_DESCRIPTION, REFERENCE_ORIGIN_CODE, REFERENCE_TYPE_CODE, REFERENCE_NUMBER, DEBIT, CREDIT };
  
      /**
       * Constructs a JournalVoucherAccountingLineParser.java.
       *
       * @param balanceTypeCode
       */
      public JournalVoucherAccountingLineParser(String balanceTypeCode) {
          super();
          this.balanceTypeCode = balanceTypeCode;
      }
  
      /**
       * @see org.kuali.rice.krad.bo.AccountingLineParserBase#performCustomSourceAccountingLinePopulation(java.util.Map,
       *      org.kuali.rice.krad.bo.SourceAccountingLine, java.lang.String)
       */
      @Override
      protected void performCustomSourceAccountingLinePopulation(Map<String, String> attributeValueMap, SourceAccountingLine sourceAccountingLine, String accountingLineAsString) {
  
          boolean isFinancialOffsetGeneration = SpringContext.getBean(BalanceTypeService.class).getBalanceTypeByCode(balanceTypeCode).isFinancialOffsetGenerationIndicator();
          if (isFinancialOffsetGeneration || StringUtils.equals(balanceTypeCode, KFSConstants.BALANCE_TYPE_EXTERNAL_ENCUMBRANCE)) {
              super.performCustomSourceAccountingLinePopulation(attributeValueMap, sourceAccountingLine, accountingLineAsString);
          }
          sourceAccountingLine.setBalanceTypeCode(balanceTypeCode);
      }
  
      /**
       * @see org.kuali.rice.krad.bo.AccountingLineParserBase#getSourceAccountingLineFormat()
       */
      @Override
      public String[] getSourceAccountingLineFormat() {
          return removeChartFromFormatIfNeeded(selectFormat());
      }
  
      /**
       * chooses line format based on balance type code
       *
       * @return String []
       */
      private String[] selectFormat() {
          if (StringUtils.equals(balanceTypeCode, KFSConstants.BALANCE_TYPE_EXTERNAL_ENCUMBRANCE)) {
              return ENCUMBRANCE_FORMAT;
          }
          else if (SpringContext.getBean(BalanceTypeService.class).getBalanceTypeByCode(balanceTypeCode).isFinancialOffsetGenerationIndicator()) {
              return OFFSET_FORMAT;
          }
         else {
             return NON_OFFSET_FORMAT;
         }
     }
 }