BusinessAssessmentRow.java

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition 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 General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.fibu.kost;

import groovy.lang.Script;

import java.io.Serializable;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang.StringUtils;
import org.projectforge.common.IntRanges;
import org.projectforge.core.ConfigXml;
import org.projectforge.core.CurrencyFormatter;
import org.projectforge.core.Priority;
import org.projectforge.scripting.GroovyExecutor;
import org.projectforge.scripting.GroovyResult;

/**
 * Used in config.xml for the definition of the used business assessment schema. This object represents a single row of the business
 * assessment.
 * 
 * @author Kai Reinhard (k.reinhard@micromata.de)
 * 
 */
public class BusinessAssessmentRow implements Serializable
{
  private static final long serialVersionUID = -5192131633290561520L;

  private final BusinessAssessment businessAssessment;

  private final BusinessAssessmentRowConfig config;

  private List<BuchungssatzDO> accountRecords;

  private BigDecimal amount;

  // If true then no recalculation is done, otherwise the amounts are lost.
  private boolean accountRecordsExist;

  public BusinessAssessmentRow(final BusinessAssessment bussinessAssessment, final BusinessAssessmentRowConfig config)
  {
    this.businessAssessment = bussinessAssessment;
    this.config = config;
  }

  /**
   * @param accountNumber
   * @return true if the given account number matches the account number ranges of this row.
   */
  public boolean doesMatch(final int accountNumber)
  {
    return config.getAccountNumberRanges().doesMatch(accountNumber);
  }

  /**
   * Removes any previous existing Buchungssatz.
   * @param value If true then all account records will be stored, if added via addAccountRecord. Otherwise no records are stored.
   */
  public void setStoreAccountRecords(final boolean value)
  {
    if (value == true) {
      this.accountRecords = new ArrayList<BuchungssatzDO>();
    } else {
      this.accountRecords = null;
    }
    accountRecordsExist = false;
  }

  /**
   * Addiert den Kontoumsatz und falls setStoreBuchungsaetze(true) gesetzt wurde, wird der Buchungssatz intern hinzugefügt.
   * @param satz
   */
  public void addAccountRecord(final BuchungssatzDO record)
  {
    accountRecordsExist = true;
    if (amount == null) {
      amount = BigDecimal.ZERO;
    }
    amount = amount.add(record.getBetrag());
    if (this.accountRecords != null) {
      this.accountRecords.add(record);
    }
  }

  /**
   * @return the amount
   */
  public BigDecimal getAmount()
  {
    return amount;
  }

  /**
   * @return the accountRecords if stored otherwise null.
   */
  public List<BuchungssatzDO> getAccountRecords()
  {
    return accountRecords;
  }

  /**
   * @return the bussinessAssessment of which this row is part of.
   */
  public BusinessAssessment getBussinessAssessment()
  {
    return businessAssessment;
  }

  /**
   * The number has no other functionality than to be displayed.
   * @return Number to display (e. g. 1051).
   */
  public String getNo()
  {
    return config.getNo();
  }

  /**
   * The id can be used for referring the row e. g. inside scripts or for calculating values (see {@link #getValue()}).
   * @see #getValue()
   */
  public String getId()
  {
    return config.getId();
  }

  /**
   * Priority to display. If a short business assessment is displayed only rows with high priority are shown.
   * @return
   */
  public Priority getPriority()
  {
    return config.getPriority() != null ? config.getPriority() : Priority.MIDDLE;
  }

  /**
   * The title will be displayed.
   */
  public String getTitle()
  {
    return config.getTitle();
  }

  /**
   * Only for indenting when displaying this row.
   * @return the indent
   */
  public int getIndent()
  {
    return config.getIndent();
  }

  /**
   * Only for indenting when displaying this row.
   * @return the indent
   */
  public int getScale()
  {
    return config.getScale() >=0 ? config.getScale() : 2;
  }

  /**
   * @return the configured unit or if not configured the standard currency symbol.
   */
  public String getUnit()
  {
    return config.getUnit() != null ? config.getUnit() : ConfigXml.getInstance().getCurrencySymbol();
  }

  /**
   * @return the accountNumberRanges
   */
  public IntRanges getAccountNumberRanges()
  {
    return config.getAccountNumberRanges();
  }

  void recalculate()
  {
    if (accountRecordsExist == true) {
      // Nothing to do.
      return;
    }
    final Script groovyScript = config.getValueScript();
    if (groovyScript == null) {
      // Nothing to do.
      return;
    }
    amount = BigDecimal.ZERO;
    final Map<String, Object> vars = new HashMap<String, Object>();
    BusinessAssessment.putBusinessAssessmentRows(vars, businessAssessment);
    final GroovyResult result = new GroovyExecutor().execute(groovyScript, vars);
    final Object rval = result.getResult();
    if (rval instanceof BigDecimal) {
      amount = (BigDecimal)rval;
    } else if (rval instanceof Number) {
      amount = new BigDecimal(String.valueOf(rval)).setScale(getScale(), RoundingMode.HALF_UP);
    }
  }

  @Override
  public String toString()
  {
    return StringUtils.leftPad(getNo(), 4)
        + " "
        + StringUtils.rightPad(getTitle(), 20)
        + " "
        + StringUtils.leftPad(CurrencyFormatter.format(getAmount()), 18);
    /*
     * StringBuffer buf = new StringBuffer(); buf.append(row); for (KontoUmsatz umsatz : kontoUmsaetze) { buf.append("\n ");
     * buf.append(umsatz.toString()); } return buf.toString();
     */
  }

}