AccountReportItem.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * 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.turro.financials.report;
 
import java.util.ArrayList;
import java.util.List;
import org.turro.string.Strings;
import org.turro.elephant.db.WhereClause;
import org.turro.util.PhraseBuilder;
 
public class AccountReportItem {
 
  private AccountReport report;
  private AccountReportItem parent;
  private List<AccountReportItem> children = new ArrayList<AccountReportItem>();
  private String label;
  private List<String> patterns = new ArrayList<String>();
  private boolean showTotal;
  private PeriodSet periods;
  private ItemMode mode = null;
  private boolean totalItem = false;
 
  public AccountReportItem(String label) {
    this.label = label;
  }
 
  public AccountReportItem addItem(String label) {
    return addItem(new AccountReportItem(label));
  }
 
  public AccountReportItem addItem(AccountReportItem item) {
    item.setReport(report);
    item.setParent(this);
    children.add(item);
    return item;
  }
 
  public void addPattern(String pattern) {
    patterns.add(pattern);
  }
 
  public List<AccountReportItem> getChildren() {
    return children;
  }
 
  public String getLabel() {
    return label;
  }
 
  public void setLabel(String label) {
    this.label = label;
  }
 
  public ItemMode getMode() {
    return mode;
  }
 
  public void setMode(ItemMode mode) {
    this.mode = mode;
  }
 
  public AccountReportItem getParent() {
    return parent;
  }
 
  public void setParent(AccountReportItem parent) {
    this.parent = parent;
  }
 
  public PeriodSet getPeriods() {
    return periods;
  }
 
  public AccountReport getReport() {
    return report;
  }
 
  public void setReport(AccountReport report) {
    this.report = report;
  }
 
  public boolean isShowTotal() {
    return showTotal;
  }
 
  public void setShowTotal(boolean showTotal) {
    this.showTotal = showTotal;
  }
 
  public boolean isTitleItem() {
    return patterns == null || patterns.isEmpty();
  }
 
  public boolean isTotalItem() {
    return totalItem;
  }
 
  public void setTotalItem(boolean totalItem) {
    this.totalItem = totalItem;
    if(totalItem) {
      periods = new PeriodSet();
    }
  }
 
  public AccountReportItem getItem(String label) {
    if(!Strings.isBlank(label)) {
      for(AccountReportItem ari : children) {
        if(label.equals(ari.getLabel())) {
          return ari;
        }
        AccountReportItem ari2 = ari.getItem(label);
        if(ari2 != null) {
          return ari2;
        }
      }
    }
    return null;
  }
 
  public PeriodSet loadData(PeriodSet existingPeriods) {
    if(periods == null) {
      periods = new PeriodSet();
      if(!patterns.isEmpty()) {
        String sqlQuery = getSQLQuery();
        if(!sqlQuery.contains("in ()")) {
          List l = getReport().getDao().getResultList(sqlQuery);
          for(Object[] o : (List<Object[]>) l) {
            AccountReportPeriod arp = new AccountReportPeriod((Integer) o[0], (Integer) o[1]);
            arp.setValue((Double) o[2]);
            arp.setItem(this);
            periods.add(arp);
            existingPeriods.add(arp);
          }
        }
      }
      for(AccountReportItem ari : children) {
        ari.loadData(existingPeriods);
      }
    }
    return periods;
  }
 
  public AccountReportPeriod getPeriodFor(AccountReportPeriod accountReportPeriod) {
    for(AccountReportPeriod period : getPeriods()) {
      if(period.getYear() == accountReportPeriod.getYear() && period.getMonth() == accountReportPeriod.getMonth()) {
        return period;
      }
    }
    return null;
  }
 
  public void regularizeMode(PeriodSet existingPeriods) {
    for(AccountReportPeriod period : existingPeriods) {
      AccountReportPeriod arp = new AccountReportPeriod(period.getYear(), period.getMonth());
      arp.setItem(this);
      periods.add(arp);
    }
    if(mode == ItemMode.BY_YEAR) {
      double acumulated = 0;
      int year = 0;
      for(AccountReportPeriod period : getPeriods()) {
        if(period.getYear() == year) {
          acumulated += period.getValue();
        } else {
          acumulated = period.getValue();
          year = period.getYear();
        }
        period.setValue(acumulated);
      }
    } else if(mode == ItemMode.BY_TAM) {
      TamBuffer tam = new TamBuffer();
      for(AccountReportPeriod period : getPeriods()) {
        tam.add(period.getValue());
        period.setValue(tam.getTotal());
      }
 
    }
    for(AccountReportItem ari : children) {
      ari.regularizeMode(existingPeriods);
    }
  }
 
  public AccountReportItem getTotalItem() {
    AccountReportItem total = new AccountReportItem(label);
    total.setMode(mode);
    total.setParent(parent);
    total.setReport(report);
    total.setTotalItem(true);
    for(AccountReportPeriod period : periods) {
      AccountReportPeriod arp = new AccountReportPeriod(period.getYear(), period.getMonth());
      arp.setItem(total);
      arp.setValue(getAccumulatedFor(period));
      total.getPeriods().add(arp);
    }
    return total;
  }
 
  public double getAccumulatedFor(AccountReportPeriod period) {
    AccountReportPeriod p = period == null ? null : getPeriodFor(period);
    double accumulated = p == null ? 0.0 : p.getValue();
    for(AccountReportItem item : children) {
      accumulated += item.getAccumulatedFor(period);
    }
    return accumulated;
  }
 
  private String getSQLQuery() {
    WhereClause wc = new WhereClause();
    wc.addClause("select year(re.register.registerDate), month(re.register.registerDate), sum(re.debit) - sum(re.credit)");
    wc.addClause("from RegisterEntry re");
    wc.addClause("where re.account.id in " + getInString());
    wc.addClause("and re.register.exclude = FALSE");
    wc.addClause("group by year(re.register.registerDate), month(re.register.registerDate)");
    return wc.getClause();
  }
 
  private String getInString() {
    PhraseBuilder pb = new PhraseBuilder("(");
    for(String account : getReport().getAccounts()) {
      for(String regexp : patterns) {
        if(account.matches(regexp)) {
          pb.addWord("'" + account + "'");
          pb.addPendingSeparator(",");
          break;
        }
      }
    }
    pb.cancelSeparator();
    pb.addWord(")");
    return pb.toString();
  }
 
}