DocumentExpiriesGrid.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;
 
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.Strings;
import org.turro.collections.CollectionUtil;
import org.turro.elephant.context.ElephantContext;
import org.turro.financials.contract.ContractListbox;
import org.turro.financials.contract.logic.ContractWrapper;
import org.turro.financials.document.logic.DocumentDefinitionWrapper;
import org.turro.financials.entity.*;
import org.turro.financials.linetype.LineTypePreferenceListbox;
import org.turro.financials.model.contract.ContractUsualSet;
import org.turro.financials.model.document.DocumentDefinitionUsualSet;
import org.turro.financials.model.document.SingleLineDocumentWrapper;
import org.turro.financials.model.product.ProductWrapper;
import org.turro.financials.product.ProductByContractorCombobox;
import org.turro.financials.product.ProductCombobox;
import org.turro.i18n.I_;
import org.turro.usual.UsualUsages;
import org.turro.zkoss.grid.CollectionGrid;
import org.turro.zkoss.grid.EditableCell;
import org.turro.zkoss.grid.EditableColumn;
import org.zkoss.zk.ui.HtmlBasedComponent;
import org.zkoss.zk.ui.event.Event;
import org.zkoss.zk.ui.event.Events;
import org.zkoss.zul.Row;
 
public class DocumentExpiriesGrid extends CollectionGrid<SingleLineDocumentWrapper> {
 
  private Document document;
  private Collection<DocumentDefinition> expiryDefinitions;
  private final Map<DocumentDefinition, Contract> lastStoreMap = new HashMap<>();
  private DocumentDefinition lastDocDef = null;
  private final Map<Long, Collection<Contract>> storeMap = new HashMap<>();
  //private boolean showStoreInput = false, showLineTypeInput = false;
 
  public DocumentExpiriesGrid() {
    super();
  }
 
  public Collection<DocumentRelation> getRelations() {
    ArrayList<DocumentRelation> list = new ArrayList<>();
    for(SingleLineDocumentWrapper sldw : getValues()) {
      list.add(sldw.getRelation());
    }
    return list;
  }
 
  public Document getDocument() {
    return document;
  }
 
  public void setDocument(Document document) {
    this.document = document;
  }
 
  private void updateDocument() {
    clearTable();
    if(document == null || document.getContract() == null) {
      afterCompose();
      return;
    }
    expiryDefinitions = new ContractWrapper(document.getContract()).getExpiryDefinitions(document.getDocumentDefinition());
    expiryDefinitions = new DocumentDefinitionUsualSet(expiryDefinitions, document.getUsualPath() + "df:");
    Iterator<DocumentDefinition> it = expiryDefinitions.iterator();
    while (it.hasNext()) {
      DocumentDefinition dd = it.next();
      //if(dd.getRelatedLineTypes().size() > 1) {
      //showLineTypeInput = true;
      //}
      Collection<Contract> stores = new DocumentDefinitionWrapper(dd).getRelatedStores(document.getContract());
      if(stores.isEmpty()) {
        stores = new DocumentDefinitionWrapper(dd)
                .getRelatedStores();
      }
      ContractWrapper.clearInactives(stores);
      new ContractWrapper(document.getContract()).addAdvanceIfNeeded(document.getForcedView(), stores);
      //if(stores.size() > 1) {
      //showStoreInput = true;
      //}
      storeMap.put(dd.getId(), stores);
      lastStoreMap.put(dd, CollectionUtil.from(stores).first());
      if(lastDocDef == null) {
        lastDocDef = dd;
      }
    }
    setCollection(SingleLineDocumentWrapper.adapt(document, document.getUpdatedDescendants()));
  }
 
  public void notifyChange() {
    Events.postEvent(new Event(Events.ON_CHANGE, this));
    updateDocument();
    afterCompose();
  }
 
  public void updateLines() {
    if(document == null || getValues().isEmpty()) {
      updateDocument();
    } else {
      clearRows();
      setCollection(SingleLineDocumentWrapper.adapt(document, document.getDescendants()));
      super.afterCompose();
    }
  }
 
  @Override
  protected void initiateRow(Row row, SingleLineDocumentWrapper value) {
    if(value == null && expiryDefinitions != null && !expiryDefinitions.isEmpty()) {
      value = new SingleLineDocumentWrapper(document, lastDocDef);
      //value.setStore(lastStoreMap.get(value.getExpiryDefinition()));
      if(!Strings.isBlank(document.getDocumentNumber())) {
        value.setDocumentNumber(document.getDocumentNumber() + "/" + getRowCount());
      }
      value.setLineType(null);
    }
    row.setValue(value);
  }
 
  @Override
  protected boolean deleteRow(Row row) {
    SingleLineDocumentWrapper dr = (SingleLineDocumentWrapper) row.getValue();
    dr.removeRelation();
    return true;
  }
 
  @Override
  protected boolean isValid(SingleLineDocumentWrapper v) {
    return v != null && v.isValid();
  }
 
  @Override
  public void afterCompose() {
    if(expiryDefinitions != null && !expiryDefinitions.isEmpty()) {
      setReadOnly(false);
      try {
        addColumns();
        invalidate();
      } catch (ClassNotFoundException ex) {
        Logger.getLogger(DocumentExpiriesGrid.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    } else {
      setReadOnly(true);
    }
    super.afterCompose();
  }
 
  @Override
  protected String formatCell(EditableCell editableCell, Object value) {
    if(value instanceof DocumentDefinition) {
      DocumentDefinition dd = (DocumentDefinition) value;
      return dd.getName();
    } else if(value instanceof Product) {
      Product p = ((Product) value);
      return "#" + p.getProductCodeStr() + " " + p.getDescription();
    } else if(value instanceof ProductByContractor) {
      ProductByContractor pbp = ((ProductByContractor) value);
      return "#" + pbp.getContractorCode() + " " + pbp.getProduct().getDescription();
    } else if(value instanceof LineType) {
      LineType lt = ((LineType) value);
      return lt.getComposedName();
    } else if(value instanceof Contract) {
      Contract ctc = ((Contract) value);
      return ctc.getPartialDescription();
    }
    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(DocumentDefinition.class)) {
        Object value = getCellValue(editableCell);
        DocumentDefinitionListbox ddl = new DocumentDefinitionListbox();
        ddl.setCollection(expiryDefinitions);
        if(value != null) {
          ddl.setObjectValue((DocumentDefinition) value);
          lastDocDef = (DocumentDefinition) value;
        }
        ddl.setMold("select");
        return ddl;
      } else if(ec.getJavaClass().equals(Product.class)) {
        Object value = getCellValue(editableCell);
        ProductCombobox pc = new ProductCombobox();
        if(value != null) pc.setObjectValue((Product) value);
        return pc;
      } else if(ec.getJavaClass().equals(ProductByContractor.class)) {
        Object value = getCellValue(editableCell);
        ProductByContractorCombobox pbpc = new ProductByContractorCombobox(document.getContract());
        if(value != null) pbpc.setObjectValue((ProductByContractor) value);
        return pbpc;
      } else if(ec.getJavaClass().equals(LineType.class)) {
        SingleLineDocumentWrapper sldw = (SingleLineDocumentWrapper) editableCell.getRow().getValue();
        Object value = getCellValue(editableCell);
        LineTypePreferenceListbox ltl = new LineTypePreferenceListbox(document, sldw.getExpiryDefinition());
        if(value != null) {
          //TODO: check whether is preferable to assign preferences from document line
          //((LineType) value).setContractPreference(sldw.getContractPreference());
          ltl.setObjectValue((LineType) value);
        }
        ltl.setMold("select");
        return ltl;
      } else if(ec.getJavaClass().equals(Contract.class)) {
        SingleLineDocumentWrapper sldw = (SingleLineDocumentWrapper) editableCell.getRow().getValue();
        Object value = getCellValue(editableCell);
        ContractListbox slb = new ContractListbox(
                new ContractUsualSet(storeMap.get(sldw.getExpiryDefinition().getId()), true,
                sldw.getTarget().getUsualPath() + "st:"));
        if(value != null) {
          slb.setObjectValue((Contract) value);
        }
        slb.setMold("select");
        return slb;
      } else if(ec.getJavaClass().equals(String.class) && "concept".equals(ec.getProperty())) {
        SingleLineDocumentWrapper sldw = (SingleLineDocumentWrapper) editableCell.getRow().getValue();
        Object value = getCellValue(editableCell);
        ConceptCombobox slb = new ConceptCombobox();
        slb.setObjectValue(UsualUsages.getMostUsedvalue(sldw.getTarget().getUsualPath() + "cp:"));
        slb.setDocumentDefinition(sldw.getExpiryDefinition());
        if(value != null) slb.setObjectValue((String) value);
        return slb;
      } else if("price".equals(ec.getProperty())) {
        SingleLineDocumentWrapper sldw = (SingleLineDocumentWrapper) editableCell.getRow().getValue();
        if(sldw.getTotal() == 0) {
          sldw.setPrice(getCurrentDifference());
        }
        return super.createEditor(editableCell);
      }
    }
    return super.createEditor(editableCell);
  }
 
  @Override
  protected void cellChanged(EditableCell editableCell, Object value) {
    super.cellChanged(editableCell, value);
    updateRow(editableCell.getRow());
    if(value instanceof DocumentDefinition) {
      SingleLineDocumentWrapper sldw = (SingleLineDocumentWrapper) editableCell.getRow().getValue();
      if(((DocumentDefinition) value).getId() != lastDocDef.getId()) {
        lastDocDef = (DocumentDefinition) value;
        sldw.getExpiryDefinition();
        sldw.setExpiryDefinition(lastDocDef);
        sldw.setStore(null);
        sldw.setLineType(null);
      }
    } else if(value instanceof Contract) {
      SingleLineDocumentWrapper sldw = (SingleLineDocumentWrapper) editableCell.getRow().getValue();
      lastStoreMap.put(sldw.getExpiryDefinition(), (Contract) value);
    }
  }
 
  private void addColumns() throws ClassNotFoundException {
    int fractionDigits = document.getCurrency().getDefaultFractionDigits();
    if(expiryDefinitions.size() > 1) {
      addColumn(I_.get("Document"), DocumentDefinition.class,
            "expiryDefinition", null, 0, false, false).setWidth("280px");
    }
    addColumn(I_.get("Date"), Date.class,
          "documentDate", null, 0, true, false).setWidth("100px");
    addColumn(I_.get("Number"), String.class,
          "documentNumber", null, 0, false, false).setWidth("100px");
    for(RelatedColumn dc : getDocumentColumns()) {
      if(DocumentColumn.DCOL_PRODUCT.equals(dc.getDocumentColumn())) {
        if(document.getContract().isUseContractorCode()) {
          if(ProductWrapper.hasAvailableContractorProducts(document.getContract())) {
            addColumn(I_.get("Product / Contractor"), ProductByContractor.class,
                  "productByContractor", null, 0, false, false).setHflex("10");
          }
        } else {
          if(ProductWrapper.hasAvailableProducts()) {
            addColumn(I_.get("Product"), Product.class,
                  "product", null, 0, false, false).setHflex("10");
          }
        }
      } else if(DocumentColumn.DCOL_CONCEPT.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Concept"), String.class,
                "concept", null, 0, false, false).setHflex("10");
      } else if(DocumentColumn.DCOL_QUANTITY.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Quantity"), "double",
                "quantity", null, 3, false, false).setHflex("3");
      } else if(DocumentColumn.DCOL_PRICE.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Price"), "double",
                "price", null, fractionDigits, false, false).setHflex("4");
      } else if(DocumentColumn.DCOL_MONEY_DISCOUNT.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Discount"), "double",
                "discountMoney", null, fractionDigits, false, false).setHflex("2");
      } else if(DocumentColumn.DCOL_PERCENT_DISCOUNT.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("% Dnt."), "double",
                "discountPerCent", null, 0, false, false).setHflex("2");
      } else if(DocumentColumn.DCOL_TAX.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Tax"), "double",
                "tax", null, 2, false, false).setHflex("2");
      } else if(DocumentColumn.DCOL_AMOUNT.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Amount"), "double",
                "subtotal", null, fractionDigits, false, true).setHflex("4");
      }
    }
    //if(showStoreInput) {
      addColumn(I_.get("Store"), Contract.class,
            "store", null, 0, false, false).setHflex("5");
    //}
    //if(showLineTypeInput) {
      addColumn(I_.get("Line type"), LineType.class,
              "lineType", null, 0, false, false).setHflex("5");
    //}
  }
 
  private Collection<RelatedColumn> getDocumentColumns() {
    return expiryDefinitions.iterator().next().getDocumentColumns();
  }
 
  private Double getCurrentDifference() {
    double total = 0;
    for(SingleLineDocumentWrapper sldw : getValues()) {
      total += sldw.getTotal();
    }
    return document.getTotalAmount() - total;
  }
 
}