/*
    * Copyright 2006-2009 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.gl.report;
  
  import java.text.MessageFormat;
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.kuali.ole.gl.businessobject.OriginEntryInformation;
  import org.kuali.ole.gl.businessobject.PosterOutputSummaryBalanceTypeFiscalYearAndPeriodTotal;
  import org.kuali.ole.gl.businessobject.PosterOutputSummaryBalanceTypeFiscalYearTotal;
  import org.kuali.ole.gl.businessobject.PosterOutputSummaryBalanceTypeTotal;
  import org.kuali.ole.gl.businessobject.PosterOutputSummaryEntry;
  import org.kuali.ole.gl.businessobject.PosterOutputSummaryTotal;
  import org.kuali.ole.gl.businessobject.Transaction;
  import org.kuali.ole.gl.service.PosterOutputSummaryService;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.service.ReportWriterService;
  import org.kuali.rice.core.api.config.property.ConfigurationService;
  
  /**
   * A class which builds up the data and then reports the PosterOutputSummary report
   */
  public class PosterOutputSummaryReport {
      private Map<String, PosterOutputSummaryEntry> posterOutputSummaryEntries;
      private PosterOutputSummaryTotal posterOutputSummaryTotal;
      private PosterOutputSummaryService posterOutputSummaryService;
      
      /**
       * Constructs a PosterOutputSummaryReport
       */
      public PosterOutputSummaryReport() {
          posterOutputSummaryTotal = new PosterOutputSummaryTotal();
          posterOutputSummaryEntries = new LinkedHashMap<String, PosterOutputSummaryEntry>();
      }
      
      /**
       * Summarizes a transaction for this report
       * @param transaction the transaction to summarize
       */
      public void summarize(Transaction transaction) {
          getPosterOutputSummaryService().summarize(transaction, posterOutputSummaryEntries);
      }
      
      /**
       * Summarizes an origin entry for this report
       * @param originEntry the origin entry to summarize
       */
      public void summarize(OriginEntryInformation originEntry) {
          getPosterOutputSummaryService().summarize(originEntry, posterOutputSummaryEntries);
      }
      
      /**
       * Writes the report to the given reportWriterService
       * @param reportWriterService the reportWriterService to write the report to
       */
      public void writeReport(ReportWriterService reportWriterService) {
          List<PosterOutputSummaryEntry> entries = new ArrayList<PosterOutputSummaryEntry>(posterOutputSummaryEntries.values());
          
          if (entries.size() > 0) {
              Collections.sort(entries, getPosterOutputSummaryService().getEntryComparator());
              final ConfigurationService configurationService = SpringContext.getBean(ConfigurationService.class);
              
              String currentBalanceTypeCode = entries.get(0).getBalanceTypeCode();
              PosterOutputSummaryBalanceTypeTotal balanceTypeTotal = new PosterOutputSummaryBalanceTypeTotal(currentBalanceTypeCode);
              Integer currentFiscalYear = entries.get(0).getUniversityFiscalYear();
              PosterOutputSummaryBalanceTypeFiscalYearTotal balanceTypeFiscalYearTotal = new PosterOutputSummaryBalanceTypeFiscalYearTotal(currentBalanceTypeCode, currentFiscalYear);
              String currentFiscalPeriod = entries.get(0).getFiscalPeriodCode();
              PosterOutputSummaryBalanceTypeFiscalYearAndPeriodTotal balanceTypeFiscalYearAndPeriodTotal = new PosterOutputSummaryBalanceTypeFiscalYearAndPeriodTotal(currentBalanceTypeCode, currentFiscalYear, currentFiscalPeriod);
          
              final String titleMessage = configurationService.getPropertyValueAsString(OLEKeyConstants.MESSAGE_REPORT_POSTER_OUTPUT_SUMMARY_TITLE_LINE);
              String formattedTitle = MessageFormat.format(titleMessage, entries.get(0).getUniversityFiscalYear().toString(), entries.get(0).getBalanceTypeCode());
              
              reportWriterService.writeFormattedMessageLine(formattedTitle);
              reportWriterService.writeTableHeader(entries.get(0));
              
              for (PosterOutputSummaryEntry entry : entries) {
                  if (!entry.getBalanceTypeCode().equals(currentBalanceTypeCode)) {
                      reportWriterService.writeTableRow(balanceTypeFiscalYearAndPeriodTotal);
                      reportWriterService.writeTableRow(balanceTypeFiscalYearTotal);
                      reportWriterService.writeTableRow(balanceTypeTotal);
                      
                     balanceTypeFiscalYearAndPeriodTotal = new PosterOutputSummaryBalanceTypeFiscalYearAndPeriodTotal(entry.getBalanceTypeCode(), entry.getUniversityFiscalYear(), entry.getFiscalPeriodCode());
                     balanceTypeFiscalYearTotal = new PosterOutputSummaryBalanceTypeFiscalYearTotal(entry.getBalanceTypeCode(), entry.getUniversityFiscalYear());
                     balanceTypeTotal = new PosterOutputSummaryBalanceTypeTotal(entry.getBalanceTypeCode());
                     currentBalanceTypeCode = entry.getBalanceTypeCode();
                     currentFiscalYear = entry.getUniversityFiscalYear();
                     currentFiscalPeriod = entry.getFiscalPeriodCode();
                     
                     // new top-level header for balance types
                     reportWriterService.pageBreak();
                     formattedTitle = MessageFormat.format(titleMessage, currentFiscalYear.toString(), currentBalanceTypeCode);
                     reportWriterService.writeFormattedMessageLine(formattedTitle);
                     reportWriterService.writeTableHeader(entry);
                 } else if (!entry.getUniversityFiscalYear().equals(currentFiscalYear)) {
                     reportWriterService.writeTableRow(balanceTypeFiscalYearAndPeriodTotal);
                     reportWriterService.writeTableRow(balanceTypeFiscalYearTotal);
                     
                     balanceTypeFiscalYearAndPeriodTotal = new PosterOutputSummaryBalanceTypeFiscalYearAndPeriodTotal(entry.getBalanceTypeCode(), entry.getUniversityFiscalYear(), entry.getFiscalPeriodCode());
                     balanceTypeFiscalYearTotal = new PosterOutputSummaryBalanceTypeFiscalYearTotal(entry.getBalanceTypeCode(), entry.getUniversityFiscalYear());
                     currentFiscalYear = entry.getUniversityFiscalYear();
                     currentFiscalPeriod = entry.getFiscalPeriodCode();
                 } else if (!entry.getFiscalPeriodCode().equals(currentFiscalPeriod)) {
                     reportWriterService.writeTableRow(balanceTypeFiscalYearAndPeriodTotal);
                     
                     balanceTypeFiscalYearAndPeriodTotal = new PosterOutputSummaryBalanceTypeFiscalYearAndPeriodTotal(entry.getBalanceTypeCode(), entry.getUniversityFiscalYear(), entry.getFiscalPeriodCode());
                     currentFiscalPeriod = entry.getFiscalPeriodCode();
                 }
                 
                 reportWriterService.writeTableRow(entry);
                 balanceTypeFiscalYearAndPeriodTotal.addAmount(entry);
                 balanceTypeFiscalYearTotal.addAmount(entry);
                 balanceTypeTotal.addAmount(entry);
                 posterOutputSummaryTotal.addAmount(entry);
             }
             
             reportWriterService.writeTableRow(balanceTypeFiscalYearAndPeriodTotal);
             reportWriterService.writeTableRow(balanceTypeFiscalYearTotal);
             reportWriterService.writeTableRow(balanceTypeTotal);
             reportWriterService.writeNewLines(1);
             reportWriterService.writeTableRow(posterOutputSummaryTotal);
         }
     }
     
     /**
      * @return an implementation of the PosterOutputSummaryService
      */
     public PosterOutputSummaryService getPosterOutputSummaryService() {
         if (posterOutputSummaryService == null) {
             posterOutputSummaryService = SpringContext.getBean(PosterOutputSummaryService.class);
         }
         
         return posterOutputSummaryService;
     }
 }