bsfinancials-www/src/main/java/org/turro/financials/document/logic/DocumentWrapper.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.document.logic;
 
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.amic.util.date.CheckDate;
import org.turro.command.Command;
import org.turro.command.Context;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.util.DateFormats;
import org.turro.elephant.util.DecimalFormats;
import org.turro.elephant.zkoss.Modal;
import org.turro.elephant.zkoss.ModalWindow;
import org.turro.financials.contract.ContractCombobox;
import org.turro.financials.contract.logic.ContractWrapper;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.document.action.CloneDocumentAction;
import org.turro.financials.entity.*;
import org.turro.financials.model.business.CompanyWrapper;
import org.turro.financials.model.document.SimpleDocumentLineList;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.plugin.dossier.IDossier;
import org.turro.plugin.dossier.IIssue;
import org.turro.plugin.scheduler.ScheduledEdit;
import org.turro.util.PhraseBuilder;
import org.turro.zkoss.dialog.InputDialog;
import org.turro.zkoss.dialog.InputField;
import org.turro.zkoss.input.CollectionListbox;
import org.turro.zkoss.layout.GridLayout;
import org.turro.zul.frame.Framework;
import org.zkoss.zk.ui.HtmlBasedComponent;
import org.zkoss.zul.Checkbox;
 
public class DocumentWrapper extends org.turro.financials.model.document.DocumentWrapper implements ScheduledEdit {
 
  public DocumentWrapper(Document document) {
    super(document);
  }
 
  public String getTabLabel() {
    return getSelfLabel() + " #" + entity.getId();
  }
  
  public String getSelfLabel() {
    return I_.get("Document");
  }
  
  public boolean checkSave(PhraseBuilder pb) {
    if(!CompanyWrapper.isValidDate(entity.getReceiptDate())) {
      pb.addWord(I_.get("Closing date"));
      pb.addWord("\n");
      pb.addWord(DateFormats.format(CompanyWrapper.getCompanyClosingDate(), true));
      pb.addWord("\n");
      return false;
    }
    for(DocumentRelation dr : entity.getDescendants()) {
      if(dr.getDescendant() != null && !CompanyWrapper.isValidDate(dr.getDescendant().getReceiptDate())) {
        pb.addWord(I_.get("Closing date"));
        pb.addWord("\n");
        pb.addWord(DateFormats.format(CompanyWrapper.getCompanyClosingDate(), true));
        pb.addWord("\n");
        return false;
      }
    }
    return true;
  }
 
  public boolean checkBatchs(PhraseBuilder pb) {
    Collection<BatchOf> batchOfs = BatchOf.getFrom(entity);
    if(!batchOfs.isEmpty()) {
      pb.addWord(I_.get("Can't delete") + ":\n\n");
      for(BatchOf b : batchOfs) {
        pb.addWord(new DocumentWrapper(b.getBatch()).getFullDescription() + "\n");
      }      
      return false;
    }
    return true;
  }
  
  public String getDocDescription() {
    return entity.getDocumentDefinition().getName() + ": " +
            (entity.getForcedView() == null ? "" : "(" + entity.getForcedView().getName() + ") ") +
            entity.getDocumentNumber() + " " +
            DateFormats.format(entity.getDocumentDate(), true);
  }
 
  public String getFullDescription() {
    return getDocDescription() + " | " +
            DecimalFormats.format(entity.getTotalAmount());
  }
 
  public String getTooltiptext() {
    try {
      return entity.getContract().getFullDescription() + "\n" + 
              getDocDescription() + " | " +
              DecimalFormats.format(entity.getTotalAmount());
    } catch(Exception ex) {
      return null;
    }
  }
 
  public void changeContract(final Command command) {
    InputDialog.getInput(
            Framework.getCurrent().getPage(),
            I_.get("Change"),
            new InputField[] {
              new InputField("Contract", null, null, 0) {
                @Override
                protected HtmlBasedComponent createEditor() {
                  ContractCombobox ccb = new ContractCombobox();
                  ccb.setOnlyActive(true);
                  ccb.setDocumentDefinition(entity.getDocumentDefinition());
                  ccb.setObjectValue(entity.getContract());
                  return ccb;
                }
              }
            }, new Command() {
      @Override
      public Object execute(Context context) {
        InputField[] fields = (InputField[]) context.get("fields");
        if(fields.length > 0) {
          for(InputField f : fields) {
            if("Contract".equals(f.getLabel())) {
              context.put("contract", f.getValue());
              if(command != null) command.execute(context);
              break;
            }
          }
        }
        return null;
      }
    });
  }
 
  public void cloneDocument() {
    try {
      Context ctx = new Context();
      ctx.put("entity", entity);
      new CloneDocumentAction().execute(ctx);
    } catch (Exception ex) {
      Logger.getLogger(DocumentWrapper.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
  }
 
  public void copyLines() {
    Framework.getClipboard().put("bbf_clip_doc_lin", new SimpleDocumentLineList(entity));
  }
 
  public void pasteLines() {
    SimpleDocumentLineList sdll = (SimpleDocumentLineList) Framework.getClipboard().get("bbf_clip_doc_lin");
    if(sdll != null) {
      sdll.addLines(entity);
    }
  }
 
  public boolean checkDuplicates(PhraseBuilder pb) {
    Dao dao = new FinancialsPU();
    List<Document> docs = dao.getResultList(
            "select doc from Document as doc " +
            "where doc.documentNumber = ? " +
            "and doc.documentDefinition = ? " +
            "and doc.contract = ? " +
            "and year(doc.documentDate) = ? " +
            "and doc.id <> ?",
            new Object[] {
              entity.getDocumentNumber(),
              entity.getDocumentDefinition(),
              entity.getContract(),
              new CheckDate(entity.getDocumentDate()).getYear(),
              entity.getId()
            });
    if(!docs.isEmpty()) {
      pb.addWord(I_.get("Posible duplicates, save anyway?"));
      pb.addWord("\n");
      for(Document d : docs) {
        pb.addWord("\n");
        pb.addWord(new DocumentWrapper(d).getFullDescription());
      }
      pb.addWord("\n");
      return false;
    } else {
      return true;
    }
  }
 
  public void relateAncestors(final DocumentDefinition documentDefinition, final Command command) {
    HashMap args = new HashMap();
    List<Document> list = getRelatedAncestor(documentDefinition);
    args.put("relatedDoc", list);
    args.put("mode", "descendant");
    final ModalWindow rels = Modal.getModal("/WEB-INF/_zul/financials/document/relation.zul", null, args);
    Modal.doModal(rels, new Command() {
      @Override
      public Object execute(Context context) {
        if(rels.getResult() > 0) {
          for(Document doc : (Collection<Document>) rels.getResultValue()) {
            addRelation(doc, true, rels.getResult(), getSuitableWorkflow(documentDefinition));
          }
          if(command != null) command.execute(null);
        }
        return null;
      }
    });
  }
 
  public void relateDescendants(final DocumentDefinition documentDefinition, final Command command) {
    HashMap args = new HashMap();
    List<Document> list = getRelatedDescendant(documentDefinition);
    args.put("relatedDoc", list);
    args.put("mode", "ancestor");
    final ModalWindow rels = Modal.getModal("/WEB-INF/_zul/financials/document/relation.zul", null, args);
    Modal.doModal(rels, new Command() {
      @Override
      public Object execute(Context context) {
        if(rels.getResult() > 0) {
          for(Document doc : (Collection<Document>) rels.getResultValue()) {
            addRelation(doc, false, rels.getResult(), getSuitableWorkflow(documentDefinition));
          }
          if(command != null) command.execute(null);
        }
        return null;
      }
    });
  }
 
  private void addRelation(Document relDoc, boolean ancestor, int mode, DocumentWorkflow dw) {
    DocumentRelation rel = new DocumentRelation();
    if(ancestor) {
      rel.setDescendant(entity);
      rel.setAncestor(relDoc);
      entity.getAncestors().add(rel);
      if(mode == 2) {
        // lines
        entity.appendLines(relDoc, new DocumentWrapper(relDoc).getDocDescription(), dw);
      } else if(mode == 3) {
        // amount
        entity.appendAmounts(relDoc, new DocumentWrapper(relDoc).getDocDescription(), dw);
      }
    } else {
      rel.setDescendant(relDoc);
      rel.setAncestor(entity);
      entity.getDescendants().add(rel);
    }
  }
 
  public DocumentWorkflow getSuitableWorkflow(DocumentDefinition docDef) {
    for(DocumentWorkflow dw : entity.getContract().getContractDefinition().getDocumentWorkflows()) {
      if((dw.getAncestor().getId() == entity.getDocumentDefinition().getId() &&
              dw.getDescendant().getId() == docDef.getId()) ||
         (dw.getDescendant().getId() == entity.getDocumentDefinition().getId() &&
              dw.getAncestor().getId() == docDef.getId())) {
        return dw;
      }
    }
    return null;
  }
 
  public IIssue getIssue() {
    if(entity.getId() > 0) {
      IDossier dossier = new ContractWrapper(entity.getContract()).getDossier();
      IIssue issue = dossier.addIssue();
      issue.setDescription(getFullDescription());
      issue.setPath(FinancialsPU.getObjectPath(entity));
      return issue;
    }
    return null;
  }
 
  /* ScheduledEdit */
 
  private CollectionListbox<String> actions = null;
  private Checkbox draft = null;
 
  @Override
  public Object getDataEditor(String data) {
    GridLayout gl = new GridLayout("min,1");
    actions = new CollectionListbox<String>() {
      @Override
      protected String convertToString(String v) {
        return v;
      }
    };
    actions.setMold("select");
    actions.setCollection(Arrays.asList(new String[] { I_.get("Clone document") }));
    if(data != null) {
      if(data.contains(":clone")) {
        actions.setObjectValue(I_.get("Clone document"));
      }
    }
    gl.addCaption(I_.get("Action"));
    gl.addComponent(actions);
    gl.addRow();
    draft = new Checkbox(I_.get("Draft"));
    draft.setChecked(data == null || data.contains(":draft"));
    gl.addSpace();
    gl.addComponent(draft);
    return gl;
  }
 
  @Override
  public String getDataEditorValue() {
    String data = "action";
    if(actions.getObjectValue().equals(I_.get("Clone document"))) {
      data += ":clone";
    }
    if(draft.isChecked()) {
      data += ":draft";
    }
    return data;
  }
 
}