/*
    * MoneyWise: Finance Application
    * Copyright 2012-2026. Tony Washer
    *
    * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
   *
   * 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 io.github.tonywasher.joceanus.moneywise.atlas.reports;
  
  import io.github.tonywasher.joceanus.oceanus.format.OceanusDataFormatter;
  import io.github.tonywasher.joceanus.metis.report.MetisReportBase;
  import io.github.tonywasher.joceanus.metis.report.MetisReportHTMLBuilder;
  import io.github.tonywasher.joceanus.metis.report.MetisReportHTMLBuilder.MetisHTMLTable;
  import io.github.tonywasher.joceanus.metis.report.MetisReportManager;
  import io.github.tonywasher.joceanus.metis.report.MetisReportReferenceManager.DelayedTable;
  import io.github.tonywasher.joceanus.moneywise.atlas.data.analysis.buckets.MoneyWiseXAnalysis;
  import io.github.tonywasher.joceanus.moneywise.atlas.views.MoneyWiseXAnalysisFilter;
  import io.github.tonywasher.joceanus.moneywise.data.basic.MoneyWiseBasicResource;
  import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseStaticResource;
  import io.github.tonywasher.joceanus.moneywise.data.statics.MoneyWiseTaxClass;
  import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxAnalysis;
  import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxDueBucket;
  import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxDueBucket.MoneyWiseTaxBandBucket;
  import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxResource;
  import io.github.tonywasher.joceanus.moneywise.tax.MoneyWiseTaxYear;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import java.util.Iterator;
  
  /**
   * TaxCalculation report builder.
   */
  public class MoneyWiseXReportTaxCalculation
          extends MetisReportBase<MoneyWiseXAnalysis, MoneyWiseXAnalysisFilter<?, ?>> {
      /**
       * The Title text.
       */
      private static final String TEXT_TITLE = MoneyWiseXReportResource.TAXCALC_TITLE.getValue();
  
      /**
       * The Income text.
       */
      private static final String TEXT_INCOME = MoneyWiseTaxResource.TAXBANDS_INCOME.getValue();
  
      /**
       * The Rate text.
       */
      private static final String TEXT_RATE = MoneyWiseBasicResource.MONEYWISEDATA_FIELD_RATE.getValue();
  
      /**
       * The TaxDue text.
       */
      private static final String TEXT_TAXDUE = MoneyWiseTaxResource.TAXBANDS_TAXDUE.getValue();
  
      /**
       * The Profit text.
       */
      private static final String TEXT_PROFIT = MoneyWiseTaxResource.TAXYEAR_PROFIT.getValue();
  
      /**
       * HTML builder.
       */
      private final MetisReportHTMLBuilder theBuilder;
  
      /**
       * The Formatter.
       */
      private final OceanusDataFormatter theFormatter;
  
      /**
       * Constructor.
       *
       * @param pManager the Report Manager
       */
      MoneyWiseXReportTaxCalculation(final MetisReportManager<MoneyWiseXAnalysisFilter<?, ?>> pManager) {
          /* Access underlying utilities */
          theBuilder = pManager.getBuilder();
          theFormatter = theBuilder.getDataFormatter();
      }
  
      /**
       * Build a web output of the taxation report.
       *
       * @param pAnalysis the analysis
       * @return Web output
       */
      @Override
      public Document createReport(final MoneyWiseXAnalysis pAnalysis) {
          /* Access the bucket lists */
         final MoneyWiseTaxAnalysis myTaxAnalysis = pAnalysis.getTaxAnalysis();
         final MoneyWiseTaxYear myYear = myTaxAnalysis.getTaxYear();
 
         /* Start the report */
         final Element myBody = theBuilder.startReport();
         theBuilder.makeTitle(myBody, TEXT_TITLE, theFormatter.formatObject(myYear.getYearEnd()));
 
         /* Format the header */
         final MetisHTMLTable myTable = theBuilder.startTable(myBody);
         theBuilder.startHdrRow(myTable);
         theBuilder.makeTitleCell(myTable, MoneyWiseStaticResource.TAXBASIS_NAME.getValue());
         theBuilder.makeTitleCell(myTable, TEXT_INCOME);
         theBuilder.makeTitleCell(myTable, TEXT_TAXDUE);
 
         /* Loop through the Tax Due Buckets */
         final Iterator<MoneyWiseTaxDueBucket> myTaxIterator = myTaxAnalysis.taxDueIterator();
         while (myTaxIterator.hasNext()) {
             final MoneyWiseTaxDueBucket myBucket = myTaxIterator.next();
 
             /* Format the line */
             theBuilder.startRow(myTable);
             theBuilder.makeTableLinkCell(myTable, myBucket.getTaxBasis().toString());
             theBuilder.makeValueCell(myTable, myBucket.getTaxableIncome());
             theBuilder.makeValueCell(myTable, myBucket.getTaxDue());
 
             /* Format the detail */
             makeTaxReport(myTable, myBucket);
         }
 
         /* Access the Totals */
         theBuilder.startTotalRow(myTable);
         theBuilder.makeTotalCell(myTable, MoneyWiseXReportBuilder.TEXT_TOTAL);
         theBuilder.makeTotalCell(myTable, myTaxAnalysis.getTaxableIncome());
         theBuilder.makeTotalCell(myTable, myTaxAnalysis.getTaxDue());
         theBuilder.startTotalRow(myTable);
         theBuilder.makeTotalCell(myTable, MoneyWiseTaxClass.TAXPAID.toString());
         theBuilder.makeStretchedTotalCell(myTable, myTaxAnalysis.getTaxPaid());
         theBuilder.startTotalRow(myTable);
         theBuilder.makeTotalCell(myTable, TEXT_PROFIT);
         theBuilder.makeStretchedTotalCell(myTable, myTaxAnalysis.getTaxProfit());
 
         /* Return the document */
         return theBuilder.getDocument();
     }
 
     /**
      * Build a standard tax report element.
      *
      * @param pParent  the parent table
      * @param pSummary the tax summary
      */
     public void makeTaxReport(final MetisHTMLTable pParent,
                               final MoneyWiseTaxDueBucket pSummary) {
         /* Format the detail */
         final MetisHTMLTable myTable = theBuilder.createEmbeddedTable(pParent);
         theBuilder.startRow(myTable);
         theBuilder.makeTitleCell(myTable, TEXT_INCOME);
         theBuilder.makeTitleCell(myTable, TEXT_RATE);
         theBuilder.makeTitleCell(myTable, TEXT_TAXDUE);
 
         /* Loop through the Transaction Detail Buckets */
         final Iterator<MoneyWiseTaxBandBucket> myIterator = pSummary.taxBandIterator();
         while (myIterator.hasNext()) {
             final MoneyWiseTaxBandBucket myBucket = myIterator.next();
 
             /* Format the detail */
             theBuilder.startRow(myTable);
             theBuilder.makeValueCell(myTable, myBucket.getAmount());
             theBuilder.makeValueCell(myTable, myBucket.getRate());
             theBuilder.makeValueCell(myTable, myBucket.getTaxDue());
         }
 
         /* Embed the table correctly */
         theBuilder.embedTable(myTable, pSummary.getTaxBasis().toString());
     }
 
     @Override
     public MoneyWiseXAnalysisFilter<?, ?> processFilter(final Object pSource) {
         return null;
     }
 
     @Override
     public MetisHTMLTable createDelayedTable(final DelayedTable pTable) {
         return null;
     }
 }