/*
    * Copyright 2005-2006 The Kuali Foundation
    * 
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    * http://www.opensource.org/licenses/ecl2.php
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.kuali.ole.fp.businessobject;
  
  import static org.kuali.ole.sys.OLEPropertyConstants.ACCOUNT_NUMBER;
  import static org.kuali.ole.sys.OLEPropertyConstants.AMOUNT;
  import static org.kuali.ole.sys.OLEPropertyConstants.CHART_OF_ACCOUNTS_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.CREDIT;
  import static org.kuali.ole.sys.OLEPropertyConstants.DEBIT;
  import static org.kuali.ole.sys.OLEPropertyConstants.FINANCIAL_OBJECT_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.FINANCIAL_SUB_OBJECT_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.OBJECT_TYPE_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.ORGANIZATION_REFERENCE_ID;
  import static org.kuali.ole.sys.OLEPropertyConstants.PROJECT_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.REFERENCE_NUMBER;
  import static org.kuali.ole.sys.OLEPropertyConstants.REFERENCE_ORIGIN_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.REFERENCE_TYPE_CODE;
  import static org.kuali.ole.sys.OLEPropertyConstants.SUB_ACCOUNT_NUMBER;
  
  import java.util.Map;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.coa.service.BalanceTypeService;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.businessobject.SourceAccountingLine;
  import org.kuali.ole.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, 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, 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, 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, OLEConstants.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, OLEConstants.BALANCE_TYPE_EXTERNAL_ENCUMBRANCE)) {
              return ENCUMBRANCE_FORMAT;
          }
          else if (SpringContext.getBean(BalanceTypeService.class).getBalanceTypeByCode(balanceTypeCode).isFinancialOffsetGenerationIndicator()) {
              return OFFSET_FORMAT;
          }
          else {
              return NON_OFFSET_FORMAT;
          }
      }
  }