MultiRegisterGrid.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.register;
 
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.util.DateFormats;
import org.turro.elephant.util.Messages;
import org.turro.financials.account.AccountCombobox;
import org.turro.financials.entity.Account;
import org.turro.financials.entity.Register;
import org.turro.financials.entity.RegisterEntry;
import org.turro.financials.entity.RegisterView;
import org.turro.financials.model.AccountCreator;
import org.turro.financials.model.AccountSet;
import org.turro.financials.model.business.CompanyWrapper;
import org.turro.financials.model.register.AccountStringWrapper;
import org.turro.financials.model.register.MultiRegisterEntry;
import org.turro.financials.model.register.RegisterWrapper;
import org.turro.financials.model.register.ViewWrapper;
import org.turro.financials.view.ViewListbox;
import org.turro.i18n.I_;
import org.turro.math.Zero;
import org.turro.util.PhraseBuilder;
import org.turro.zkoss.grid.CollectionGrid;
import org.turro.zkoss.grid.EditableCell;
import org.turro.zkoss.grid.EditableColumn;
import org.turro.zul.frame.Framework;
import org.zkoss.zk.ui.HtmlBasedComponent;
import org.zkoss.zul.Row;
 
public class MultiRegisterGrid extends CollectionGrid<MultiRegisterEntry> {
 
  private RegisterView lastView = ViewWrapper.getFormalView();
  private Date lastDate = new Date();
  private Register register;
  private boolean autocheck = true, regularizeVAT = false, regularizeIRPF = false;
 
  public MultiRegisterGrid() {
    super(new TreeSet<MultiRegisterEntry>());
  }
 
  public void setRegister(Register register) {
    this.register = register;
    if(this.register != null) {
      for(RegisterEntry entry : this.register.getRegisterEntries()) {
        getCollection().add(new MultiRegisterEntry(entry));
      }
      regularizeVAT = register.isRegularizeVAT();
      regularizeIRPF = register.isRegularizeIRPF();
    }
  }
 
  public boolean isAutocheck() {
    return autocheck;
  }
 
  public void setAutocheck(boolean autocheck) {
    this.autocheck = autocheck;
  }
 
  public boolean isRegularizeIRPF() {
    return regularizeIRPF;
  }
 
  public void setRegularizeIRPF(boolean regularizeIRPF) {
    this.regularizeIRPF = regularizeIRPF;
  }
 
  public boolean isRegularizeVAT() {
    return regularizeVAT;
  }
 
  public void setRegularizeVAT(boolean regularizeVAT) {
    this.regularizeVAT = regularizeVAT;
  }
 
  public void doCheck() {
    checkValues();
  }
 
  public void save(final boolean close) {
    if(register != null) {
      register.setRegularizeVAT(regularizeVAT);
      register.setRegularizeIRPF(regularizeIRPF);
      final RegisterWrapper wReg = new RegisterWrapper(register, false);
      if(wReg.checkSave()) {
        wReg.save();
        if(close) Framework.getCurrent().closeSelected();
      } else {
        PhraseBuilder pb = new PhraseBuilder(I_.get("Closing date"));
        pb.addWord("\n");
        pb.addWord(DateFormats.format(CompanyWrapper.getCompanyClosingDate(), true));
        if(Application.getApplication().isInRole("finan-model:edit")) {
          pb.addWord(I_.get("Proceed anyway"));
          Messages.question().add(pb.toString()).show(() -> {
            wReg.save();
            if(close) Framework.getCurrent().closeSelected();
          });
        } else {
          Messages.info(I_.get("Closing date")).add(pb.toString()).show();
        }
      }
    } else {
      Register reg = null;
      MultiRegisterEntry lastEntry = null;
      final HashSet<Register> regs = new HashSet<>();
      int count = 0;
      for(Object obj : getRows().getChildren()) {
        if(obj instanceof Row) {
          MultiRegisterEntry rentry = (MultiRegisterEntry) ((Row) obj).getValue();
          if(rentry.isValid()) {
            if(lastEntry != null && lastEntry.isValid()) {
              if(!rentry.isSameRegister(lastEntry)) {
                reg = null;
              }
            }
            if(reg == null) {
              count = 0;
              reg = new Register();
              reg.setRegisterDate(rentry.getDate());
              reg.setView(rentry.getView());
              regs.add(reg);
            }
            rentry.getEntry().setRegister(reg);
            rentry.getEntry().setEntryOrder(count++);
            reg.getRegisterEntries().add(rentry.getEntry());
            lastEntry = rentry;
          }
        }
      }
      boolean isSafe = true;
      for(Register r : regs) {
        if(!(new RegisterWrapper(r).checkSave())) {
          isSafe = false;
          break;
        }
      }
      if(!isSafe) {
        PhraseBuilder pb = new PhraseBuilder(I_.get("Closing date"));
        pb.addWord("\n");
        pb.addWord(DateFormats.format(CompanyWrapper.getCompanyClosingDate(), true));
        if(Application.getApplication().isInRole("finan-model:edit")) {
          pb.addWord(I_.get("Proceed anyway"));
          Messages.question().add(pb.toString()).show(() -> {
            for(Register r : regs) {
              r.setRegularizeVAT(regularizeVAT);
              r.setRegularizeIRPF(regularizeIRPF);
              new RegisterWrapper(r).save();
            }
            if(close) Framework.getCurrent().closeSelected();
          });
        } else {
          Messages.info(I_.get("Closing date")).add(pb.toString()).show();
        }
      } else {
        for(Register r : regs) {
          r.setRegularizeVAT(regularizeVAT);
          r.setRegularizeIRPF(regularizeIRPF);
          new RegisterWrapper(r).save();
        }
        if(close) Framework.getCurrent().closeSelected();
      }
    }
  }
 
  public void delete(final boolean close) {
    final RegisterWrapper wReg = new RegisterWrapper(register, false);
    Messages.confirmDeletion().show(() -> {
      if(wReg.checkSave()) {
        if(wReg.delete() && close) Framework.getCurrent().closeSelected();
      }
    });
  }
 
  public void loadPosibleAccounts() {
    cancelEdition();
    AccountSet accs = AccountCreator.getPosibleAccounts();
    for(Account acc : accs) {
      RegisterEntry re = new RegisterEntry();
      re.setAccount(acc);
      if(register != null) {
        re.setRegister(register);
        register.getRegisterEntries().add(re);
      }
      Row row = addNewRow();
      MultiRegisterEntry mentry = new MultiRegisterEntry(re);
      initiateRow(row, mentry);
    }
    updateRows();
  }
 
  public void loadUsedAccounts() {
    cancelEdition();
    AccountSet accs = AccountCreator.getOnUseAccounts();
    for(Account acc : accs) {
      RegisterEntry re = new RegisterEntry();
      re.setAccount(acc);
      if(register != null) {
        re.setRegister(register);
        register.getRegisterEntries().add(re);
      }
      Row row = addNewRow();
      MultiRegisterEntry mentry = new MultiRegisterEntry(re);
      initiateRow(row, mentry);
    }
    updateRows();
  }
 
  @Override
  protected void initiateRow(Row row, MultiRegisterEntry value) {
    if(value == null) {
      value = new MultiRegisterEntry(register);
      row.setSclass("invalid");
    }
    if(register == null) {
      value.setView(lastView);
      value.setDate(lastDate);
    }
    row.setValue(value);
  }
 
  @Override
  protected boolean deleteRow(Row row) {
    MultiRegisterEntry mre = (MultiRegisterEntry) row.getValue();
    if(mre != null) {
      mre.deleteEntry();
    }
    return true;
  }
 
  @Override
  protected boolean isValid(MultiRegisterEntry v) {
    return v.isValid();
  }
 
  @Override
  protected void cellChanged(EditableCell editableCell, Object value) {
    super.cellChanged(editableCell, value);
    MultiRegisterEntry mre = (MultiRegisterEntry) editableCell.getRow().getValue();
    if(value instanceof Double) {
      if(mre != null) {
        mre.checkValues(editableCell.getCellIndex());
      }
      updateRow(editableCell.getRow());
    }
    if(value instanceof RegisterView) {
      lastView = (RegisterView) value;
      if(register != null) {
        register.setView(lastView);
        setAllValuesAsRegister();
      }
    } else if(value instanceof Date) {
      lastDate = (Date) value;
      if(register != null) {
        register.setRegisterDate(lastDate);
        setAllValuesAsRegister();
      }
    }
  }
 
  @Override
  protected void rowChanged(Row row) {
    if(autocheck) {
      checkValues();
    }
    super.rowChanged(row);
  }
 
  @Override
  protected String formatCell(EditableCell editableCell, Object value) {
    if(value instanceof RegisterView) {
      RegisterView rv = ((RegisterView) value);
      return rv.getName();
    } else if(value instanceof Account) {
      Account a = ((Account) value);
      return a.getFullDescription();
    }
    return super.formatCell(editableCell, value);
  }
 
  @Override
  protected HtmlBasedComponent createEditor(EditableCell editableCell) {
    if(editableCell.getColumn() instanceof EditableColumn) {
      EditableColumn ec = (EditableColumn) editableCell.getColumn();
      if(ec.getJavaClass().equals(RegisterView.class)) {
        Object value = getCellValue(editableCell);
        ViewListbox vl = new ViewListbox();
        vl.setMold("select");
        if(value != null) vl.setObjectValue((RegisterView) value);
        return vl;
      } else if(ec.getJavaClass().equals(Account.class)) {
        Object value = getCellValue(editableCell);
        AccountCombobox acb = new AccountCombobox();
        acb.setAllowNotInModelValues(true);
        acb.setAllowNewAccount(true);
        if(value != null) acb.setObjectValue((Account) value);
        return acb;
      }
    }
    return super.createEditor(editableCell);
  }
 
  @Override
  public void afterCompose() {
    try {
      addColumns();
    } catch (ClassNotFoundException ex) {
      Logger.getLogger(MultiRegisterGrid.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    super.afterCompose();
  }
 
  private void addColumns() throws ClassNotFoundException {
    int fractionDigits = CompanyWrapper.getCompanyCurrency().getDefaultFractionDigits();
    addColumn(I_.get("View"), RegisterView.class,
            "view", null, 0, false, false).setWidth("110px");
    addColumn(I_.get("Date"), Date.class,
            "date", null, fractionDigits, true, false).setWidth("100px");
    addColumn(I_.get("New"), "boolean",
            "newRegister", null, 0, false, register != null).setWidth("35px");
    addColumn(I_.get("Account"), Account.class,
            "account", null, 0, false, false).setWidth("350px");
    addColumn(I_.get("Concept"), String.class,
            "concept", null, 0, false, false);
    addColumn(I_.get("Debit"), "double",
            "debit", null, fractionDigits, false, false).setWidth("100px");
    addColumn(I_.get("Credit"), "double",
            "credit", null, fractionDigits, false, false).setWidth("100px");
    addColumn(I_.get("Balance"), "double",
            "balance", null, fractionDigits, false, true).setWidth("100px");
    addColumn(I_.get("Account"), "double",
            "accountBalance", null, fractionDigits, false, true).setWidth("100px");
  }
 
  private void checkValues() {
    MultiRegisterEntry lastEntry = null;
    Row lastRow = null;
    double balance = 0;
    Map<String, Double> accBal = new HashMap<>();
    for(Object obj : getRows().getChildren()) {
      if(obj instanceof Row) {
        Row row = (Row) obj;
        MultiRegisterEntry rentry = (MultiRegisterEntry) ((Row) obj).getValue();
        row.setSclass("");
        if(rentry.isValid()) {
          if(lastEntry != null && lastEntry.isValid()) {
            if(!rentry.isSameRegister(lastEntry)) {
              balance = 0;
              accBal = new HashMap<>();
              if(lastRow != null) {
                if(Zero.near(lastEntry.getBalance(), 2)) {
                  lastRow.setSclass("endRegister");
                } else {
                  lastRow.setSclass("endBadRegister");
                }
              }
            }
          }
          lastEntry = rentry;
          lastRow = row;
          Double accB = accBal.get(rentry.getAccount().getId());
          if(accB == null) {
            accB = new AccountStringWrapper(rentry.getAccount().getId())
                .getBalance(rentry.getView(), rentry.getDate());
          }
          if(accB == null) {
            accB = 0.0;
          }
          rentry.setAccountBalance(accB + rentry.getDebit() - rentry.getCredit());
          accBal.put(rentry.getAccount().getId(), rentry.getAccountBalance());
          balance += rentry.getDebit() - rentry.getCredit();
          rentry.setBalance(balance);
        } else {
          row.setSclass("invalid");
        }
      }
    }
    if(lastEntry != null && lastEntry.isValid()) {
      if(lastRow != null) {
        if(Zero.near(lastEntry.getBalance(), 2)) {
          lastRow.setSclass("endRegister");
        } else {
          lastRow.setSclass("endBadRegister");
        }
      }
    }
    updateRows();
  }
 
  private void setAllValuesAsRegister() {
    if(register != null) {
      for(Object obj : getRows().getChildren()) {
        if(obj instanceof Row) {
          MultiRegisterEntry rentry = (MultiRegisterEntry) ((Row) obj).getValue();
          rentry.setView(register.getView());
          rentry.setDate(register.getRegisterDate());
        }
      }
    }
    updateRows();
  }
 
}