DocumentComposer.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2012 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.document.logic;
 
import java.util.Collection;
import java.util.List;
import org.turro.command.Command;
import org.turro.command.Context;
import org.turro.command.LabelControl;
import org.turro.elephant.context.Application;
import org.turro.elephant.util.DecimalFormats;
import org.turro.elephant.util.Images;
import org.turro.elephant.util.Messages;
import org.turro.financials.batchof.BatchOfGrid;
import org.turro.financials.contract.ContractCombobox;
import org.turro.financials.contract.ContractInfo;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.document.DocumentDefinitionListbox;
import org.turro.financials.document.DocumentExpiriesGrid;
import org.turro.financials.document.DocumentLinesGrid;
import org.turro.financials.document.DocumentRegistersGrid;
import org.turro.financials.document.DocumentReport;
import org.turro.financials.document.DocumentSummaryGrid;
import org.turro.financials.document.contract.DocumentContractFlowListbox;
import org.turro.financials.document.process.DocumentProcessListbox;
import org.turro.financials.entity.Contract;
import org.turro.financials.entity.ContractFlow;
import org.turro.financials.entity.Document;
import org.turro.financials.entity.DocumentRelation;
import org.turro.financials.menu.FinancialsMenu;
import org.turro.financials.relation.RelationshipViewer;
import org.turro.i18n.I_;
import org.turro.jpa.composer.EntityComposer;
import org.turro.jpa.entity.DaoEntity;
import org.turro.math.Zero;
import org.turro.reflection.XMLSerializer;
import org.turro.util.PhraseBuilder;
import org.turro.zul.acceptance.AcceptanceButton;
import org.turro.zul.frame.Framework;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.select.annotation.Listen;
import org.zkoss.zk.ui.select.annotation.Wire;
import org.zkoss.zul.Label;
import org.zkoss.zul.Row;
import org.zkoss.zul.Tab;
import org.zkoss.zul.Toolbarbutton;
 
public class DocumentComposer extends EntityComposer<Document, Long> {
 
  @Wire("#contract")
  private ContractCombobox contract;
  
  @Wire("#entInf")
  private LabelControl entInf;
  
  @Wire("#ctcInf")
  private ContractInfo ctcInf;
  
  @Wire("#properties")
  private Toolbarbutton properties;
  
  @Wire("#lbCtcDef")
  private DocumentDefinitionListbox lbCtcDef;
  
  @Wire("#docProcess")
  private DocumentProcessListbox docProcess;
  
  @Wire("#tablines")
  private Tab tablines;
  
  @Wire("#tabexpiries")
  private Tab tabexpiries;
  
  @Wire("#tabrelations")
  private Tab tabrelations;
  
  @Wire("#tabbatchof")
  private Tab tabbatchof;
  
  @Wire("#tabregister")
  private Tab tabregister;
  
  @Wire("#lines")
  private DocumentLinesGrid lines;
  
  @Wire("#tflow")
  private Label tflow;
  
  @Wire("#lbflow")
  private DocumentContractFlowListbox lbflow;
  
  @Wire("#tadvance")
  private Label tadvance;
  
  @Wire("#ladvance")
  private Label ladvance;
  
  @Wire("#expiries")
  private DocumentExpiriesGrid expiries;
  
  @Wire("#relations")
  private RelationshipViewer relations;
  
  @Wire("#batchOf")
  private BatchOfGrid batchOf;
  
  @Wire("#register")
  private DocumentRegistersGrid register;
  
  @Wire("#acceptance")
  private AcceptanceButton acceptance;
  
  @Wire("#report")
  private DocumentReport report;
  
  @Wire("#reportnv")
  private DocumentReport reportnv;
 
  @Wire("#reportsend")
  private DocumentReport reportsend;
  
  @Wire("#summary")
  private DocumentSummaryGrid summary;
 
  @Listen("onSelect = #tablines")
  public void onSelectLines() {
    lines.updateRows();
  }
 
  @Listen("onSelect = #tabexpiries")
  public void onSelectExpiries() {
    if(expiries.getCollection() == null || expiries.getCollection().isEmpty()) {
      expiries.notifyChange();
    }
    updateExpiriesOptions();
  }
 
  @Listen("onSelect = #tabrelations")
  public void onSelectRelations() {
    relations.notifyChange();
  }
 
  @Listen("onSelect = #tabbatchof")
  public void onSelectBatchOf() {
    batchOf.reload();
  }
  
  @Listen("onSelect = #tabregister")
  public void onSelectRegister() {
    register.updateDocument(entity, expiries.getRelations());
  }
  
  @Listen("onSelect = #lbflow")
  public void onSelectFlow() {
    ContractFlow cf = lbflow.getObjectValue();
    if(cf != null) {
      cf.generateFlows(entity);
      expiries.notifyChange();
    }
  }
  
  @Listen("onChange = #contract")
  public void onContractChange() {
    if(contract.getObjectValue() != null) {
      DocumentWrapper w = (DocumentWrapper) getWrapper();
      ctcInf.setContract(contract.getObjectValue());
      entInf.setEntity(contract.getObjectValue());
      entInf.generate();
      entity.setContract(contract.getObjectValue());
      lbCtcDef.updateContractDefinition(contract.getObjectValue().getContractDefinition());
      lbCtcDef.setDisabled(false);
      lines.updateDocument(entity);
      docProcess.setDocument(entity);
      updateExpiriesOptions();
    } else {
      lbCtcDef.setDisabled(true);
      lines.clearTable();
      expiries.clearTable();
    }
  }
  
  @Listen("onSelect = #lbCtcDef")
  public void onDocumentDefinitionChange() {
    entity.setDocumentDefinition(lbCtcDef.getObjectValue());
    lines.updateDocument(entity);
    docProcess.setDocument(entity);
  }
  
  @Listen("onSelect = #docProcess")
  public void onDocProcess() {
    docProcess.doProcess(entity);
    lines.updateLines();
    expiries.updateLines();
  }
  
  @Listen("onClick = #properties")
  public void onProperties() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    w.changeContract(new Command() {
      @Override
      public Object execute(Context context) {
        contract.setObjectValue((Contract) context.get("contract"));
        ctcInf.setContract(contract.getObjectValue());
        entInf.setEntity(contract.getObjectValue());
        entInf.generate();
        entity.setContract(contract.getObjectValue());
        updateExpiriesOptions();
        return null;
      }
    });
  }
  
  @Listen("onChange = #lines")
  public void onLinesChange() {
    summary.updateSummary();
  }
  
  @Listen("onChange = #relations")
  public void onRelationsChange() {
    lines.updateLines();
    summary.updateSummary();
  }
  
  @Listen("onClick = #clone")
  public void onDocumentClone() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    w.cloneDocument();  
  }
  
  @Listen("onClick = #copyLines")
  public void onCopyLines() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    w.copyLines();
  }
  
  @Listen("onClick = #pasteLines")
  public void onPasteLines() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    w.pasteLines();
    lines.updateLines();
    summary.updateSummary();
  }
  
  @Listen("onClick = #appendRow")
  public void onAppendRow() {
    lines.addNewRow();
  }
  
  @Listen("onClick = #insertRow")
  public void onInsertRow() {
    Row row = lines.getLastRow();
    if(row != null) {
      lines.insertInSelectedRow(row);
    }
  }
  
  @Listen("onClick = #deleteRow")
  public void onDeleteRow() {
    Row row = lines.getLastRow();
    if(row != null) {
      lines.insertInSelectedRow(row);
    }
  }
  
  @Override
  protected String getAttributeName() {
    return "document";
  }
 
  @Override
  protected Document getEntityInstance(Long id) {
    if(id == null) {
      entity = new Document();
      entity.setDocumentDate(new java.util.Date());
      entity.setReceiptDate(entity.getDocumentDate());
    } else {
      entity = new FinancialsPU().find(Document.class, id);
    }
    return entity;
  }
 
  @Override
  protected DaoEntity getWrapperInstance(Component comp) {
    DocumentWrapper w =  new DocumentWrapper(entity);
    Framework.getCurrent().setSelectedLabel(w.getTabLabel());
    Framework.getCurrent().setSelectedTooltiptext(w.getTooltiptext());
    return w;
  }
 
  @Override
  protected boolean beforeDelete() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    return super.beforeSave() && !acceptance.isBlocked();
  }
 
  @Override
  protected boolean beforeSave() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    w.setPriorSavingValues(lines.getValues(), (List<DocumentRelation>) expiries.getRelations());
    return super.beforeSave() && (acceptance == null || !acceptance.isBlocked());
  }
 
  @Override
  protected void doOnDelete() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    PhraseBuilder pb = new PhraseBuilder();
    boolean wrongDate = !w.checkSave(pb);
    boolean batchs = !w.checkBatchs(pb);
    if(wrongDate || batchs) {
      if(batchs) {
        Messages.info(I_.get("Can't delete")).add(pb.toString()).show();
        // can't save
      } else if(wrongDate && !Application.getApplication().isInRole("finan-model:edit")) {
        // can't save
        Messages.info(I_.get("Can't delete")).add(pb.toString()).show();
      } else {
        pb.addWord(I_.get("Proceed anyway"));
        Messages.question().add(pb.toString()).show(() -> {
          DocumentComposer.super.doOnDelete();
        });
      }
    } else {
      super.doOnDelete();
    }
  }
 
  @Override
  protected void doOnSave() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    PhraseBuilder pb = new PhraseBuilder();
    boolean wrongDate = !w.checkSave(pb);
    boolean duplicates = !w.checkDuplicates(pb);
    if(wrongDate || duplicates) {
      if(wrongDate && !Application.getApplication().isInRole("finan-model:edit")) {
        // can't save
        Messages.info(I_.get("Can't delete")).add(pb.toString()).show();
      } else {
        pb.addWord(I_.get("Proceed anyway"));
        Messages.question().add(pb.toString()).show(() -> {
          DocumentComposer.super.doOnSave();
        });
      }
    } else {
      super.doOnSave();
    }
  }
 
  
  @Override
  public void afterSave() {
    if(entity != null) {
      FinancialsMenu.showDocument(entity.getId());
    }
  }
 
  @Override
  protected boolean shouldBeSaved() {
    return !entity.isEmpty() && (entity.getId() == 0) || super.shouldBeSaved();
  }
 
  @Override
  public void doFinally() throws Exception {
    super.doFinally();
    if(entity.getId() == 0) {
      acceptance.setVisible(false);
      entInf.setVisible(false);
      properties.setVisible(false);
    } else {
      contract.setVisible(false);
      lbCtcDef.setContractDefinition(entity.getContract().getContractDefinition());
      lbCtcDef.setObjectValue(entity.getDocumentDefinition());
    }
    lbCtcDef.setDisabled(true);
    contract.setObjectValue(entity.getContract());
    ctcInf.setContract(entity.getContract());
    entInf.setEntity(entity.getContract());
    entInf.generate();
    docProcess.setDocument(entity);
    updateExpiriesOptions();
    report.setGrid(lines);
    reportnv.setGrid(lines);
    reportsend.setGrid(lines);
    reportsend.setImage(Images.getImage("mail_send"));
    reportsend.setTooltiptext(I_.get("Send documents"));
  }
 
  @Override
  protected boolean inSaveRole() {
    return Application.getApplication().isInRole("finan-document:edit");
  }
 
  @Override
  protected boolean inDeleteRole() {
    return Application.getApplication().isInRole("finan-document:delete");
  }
 
  private String expiriesXML = "";
  
  @Override
  protected void retrieveEntity() {
    super.retrieveEntity();
    for(DocumentRelation dr : entity.getDescendants()) {
      if(dr.getDescendant().isValid()) {
        expiriesXML += new XMLSerializer(dr.getDescendant()).data();
      }
    }
  }
 
//  @Override
//  protected boolean hasChanged() {
//    boolean hasChanged = super.hasChanged();
//    if(!hasChanged) {
//      String newXML = "";
//      for(DocumentRelation dr : entity.getDescendants()) {
//        if(dr.getDescendant().isValid()) {
//          newXML += new XMLSerializer(dr.getDescendant()).data();
//        }
//      }
//      hasChanged = CompareUtil.compare(newXML, expiriesXML) != 0;
//    }
//    return hasChanged;
//  }
 
  private void updateExpiriesOptions() {
    DocumentWrapper w = (DocumentWrapper) getWrapper();
    double advance = w.getAdvance();
    if(!Zero.near(advance, 2)) {
      tadvance.setVisible(true);
      ladvance.setVisible(true);
      ladvance.setValue(DecimalFormats.format(advance));
    } else {
      tadvance.setVisible(false);
      ladvance.setVisible(false);
    }
    Collection<ContractFlow> cfs = entity.getContractFlows();
    if(cfs == null || cfs.isEmpty()) {
      tflow.setVisible(false);
      lbflow.setVisible(false);
    } else {
      lbflow.setAllowNull(true);
      lbflow.setDocument(entity);
      lbflow.setObjectValue(null);
      tflow.setVisible(true);
      lbflow.setVisible(true);
    }
  }
 
}