document/DocumentLinesGrid.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.Collection;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.elephant.context.ElephantContext;
import org.turro.financials.contract.ContractListbox;
import org.turro.financials.contract.logic.ContractWrapper;
import org.turro.financials.entity.*;
import org.turro.financials.linetype.LineTypePreferenceListbox;
import org.turro.financials.model.contract.ContractUsualSet;
import org.turro.financials.model.document.DocumentDefinitionWrapper;
import org.turro.financials.model.product.ProductWrapper;
import org.turro.financials.product.IProduct;
import org.turro.financials.product.ProductExtendedCombobox;
import org.turro.financials.product.ProductFactory;
import org.turro.i18n.I_;
import org.turro.math.Zero;
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.turro.zkoss.input.CollectionListbox;
import org.zkoss.zk.ui.HtmlBasedComponent;
import org.zkoss.zul.Row;
 
public class DocumentLinesGrid extends CollectionGrid<DocumentLine> {
 
  private Document document;
  private Collection<Contract> stores;
  private ContractUsualSet usualStores;
  private Contract lastStore = null;
  private final boolean hasProducts;
  private double lastTax, lastReq, lastRet;
 
  public DocumentLinesGrid() {
    super();
    hasProducts = ProductWrapper.hasAvailableProducts();
  }
 
  public Document getDocument() {
    return document;
  }
 
  public void setDocument(Document document) {
    this.document = document;
    if(document == null || !document.isValid()) return;
    document.clearEmpties();
    setCollection(document.getDocumentLines());
    stores = new DocumentDefinitionWrapper(document.getDocumentDefinition())
            .getRelatedStores(document.getContract());
    if(stores.isEmpty()) {
      stores = new DocumentDefinitionWrapper(document.getDocumentDefinition())
            .getRelatedStores();
    }
    ContractWrapper.clearInactives(stores);
    usualStores = new ContractUsualSet(stores, true, document.getUsualPath() + "st:");
//    if(!stores.isEmpty()) {
//      lastStore = stores.iterator().next();
//    }
  }
 
  public void updateDocument(Document document) {
    clearTable();
    setDocument(document);
    afterCompose();
  }
 
  public void updateLines() {
    clearRows();
    setDocument(document);
    super.afterCompose();
  }
 
  public Collection<Contract> getStores() {
    return stores;
  }
 
  @Override
  protected void initiateRow(Row row, DocumentLine value) {
    if(value == null) {
      value = new DocumentLine();
      value.setDocument(document);
      value.setLineType(document.getDefaultLineType());
      if(value.getLineType() != null) {
        value.setContractPreference(value.getLineType().getContractPreference());
      }
      value.setStore(lastStore);
      // avoid equalities
      value.setLineOrder(document.getDocumentLines().size() + 90001);
      document.getDocumentLines().add(value);
    }
    row.setValue(value);
  }
 
  @Override
  protected boolean deleteRow(Row row) {
    document.getDocumentLines().remove((DocumentLine) row.getValue());
    return true;
  }
 
  @Override
  protected boolean isValid(DocumentLine v) {
    return !v.isEmpty();
  }
 
  @Override
  public void afterCompose() {
    if(document != null && document.isValid()) {
      setReadOnly(false);
      try {
        addColumns();
        invalidate();
      } catch (ClassNotFoundException ex) {
        Logger.getLogger(DocumentLinesGrid.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
      }
    } else {
      setReadOnly(true);
    }
    super.afterCompose();
  }
 
  @Override
  protected Object getEditorValue(EditableCell editableCell) {
    HtmlBasedComponent hbc = (HtmlBasedComponent) editableCell.getEditor();
    if(hbc instanceof ProductExtendedCombobox) {
      DocumentLine dl = (DocumentLine) editableCell.getRow().getValue();
      IProduct prod = ((ProductExtendedCombobox) hbc).getObjectValue();
      if(prod != null) {
        ProductFactory.setPriceTax(dl, prod);
        if(prod.isUncoded()) {
          dl.setConcept(prod.getProductString());
          return null;
        }
        dl.setProductByContractor(prod.getProductByContractor());
      } else {
        dl.setProductByContractor(null);
      }
      return prod;
    }
    return super.getEditorValue(editableCell);
  }
 
  @Override
  protected String formatCell(EditableCell editableCell, Object value) {
//    if(value instanceof Product) {
//      Product p = ((Product) value);
//      setValuesFrom(p, (DocumentLine) editableCell.getRow().getFieldValue());
//      return "#" + p.getProductCodeStr() + " " + p.getDescription();
//    } else if(value instanceof ProductByContractor) {
//      ProductByContractor pbp = ((ProductByContractor) value);
//      setValuesFrom(pbp, (DocumentLine) editableCell.getRow().getFieldValue());
//      return "#" + pbp.getContractorCode() + " " + pbp.getProduct().getDescription();
    if(value instanceof Product) {
      Product p = ((Product) value);
      DocumentLine dl = (DocumentLine) editableCell.getRow().getValue();
      ProductFactory.setPriceTax(dl, p);
      p.setProductByContractor(dl.getProductByContractor());
      return p.getProductString();
    } 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(Product.class)) {
        Object value = getCellValue(editableCell);
        DocumentLine dl = (DocumentLine) editableCell.getRow().getValue();
        /*
        ProductCombobox pc = new ProductCombobox();
        if(value != null) pc.setObjectValue((Product) value);
        return pc;
         */
        ProductExtendedCombobox pc = new ProductExtendedCombobox();
        pc.setContractorId(document.getContract().getId());
        IProduct prod = (IProduct) value;
        if(prod == null && dl.getProductByContractor() != null) {
          prod = dl.getProductByContractor().getProduct();
        }
        if(prod != null) {
          prod.setProductByContractor(dl.getProductByContractor());
          pc.setObjectValue(prod);
        }
        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)) {
        DocumentLine dl = (DocumentLine) editableCell.getRow().getValue();
        Object value = getCellValue(editableCell);
        LineTypePreferenceListbox ltl = new LineTypePreferenceListbox(document);
        //TODO: check whether is preferable to assign preferences from document line
        //((LineType) value).setContractPreference(dl.getContractPreference());
        if(value != null) ltl.setObjectValue((LineType) value);
        ltl.setMold("select");
        return ltl;
      } else if(ec.getJavaClass().equals(Contract.class)) {
        DocumentLine dl = (DocumentLine) editableCell.getRow().getValue();
        Object value = getCellValue(editableCell);
        ContractListbox slb = new ContractListbox(usualStores);
        if(value != null) slb.setObjectValue((Contract) value);
        slb.setMold("select");
        return slb;
      } else if(ec.getJavaClass().equals(String.class) && "concept".equals(ec.getProperty())) {
        DocumentLine dl = (DocumentLine) editableCell.getRow().getValue();
        Object value = getCellValue(editableCell);
        ConceptCombobox slb = new ConceptCombobox();
        slb.setDocumentDefinition(document.getDocumentDefinition());
        if(value != null) {
          slb.setObjectValue((String) value);
        } else if(!hasProducts) {
          slb.setObjectValue(UsualUsages.getMostUsedvalue(document.getUsualPath() + "cp:"));
        }
        return slb;
      } else if("tax".equals(ec.getProperty())) {
        HtmlBasedComponent hbc = new ContractWrapper(document.getContract()).getTaxCtrl();
        Object value = getCellValue(editableCell);
        if(hbc != null) {
          if(hbc instanceof CollectionListbox) {
            if(!Zero.near((double) value, 2)) {
              ((CollectionListbox) hbc).setObjectValue(value);
            } else {
              ((CollectionListbox) hbc).setObjectValue(lastTax);
            }
          }
          return hbc;
        } else {
          setCellValue(editableCell, !Zero.near((double) value, 2) ? value : lastTax);
        }
      } else if("equivalenceSurcharge".equals(ec.getProperty())) {
        HtmlBasedComponent hbc = new ContractWrapper(document.getContract()).getReqCtrl();
        Object value = getCellValue(editableCell);
        if(hbc != null) {
          if(hbc instanceof CollectionListbox) {
            if(value != null) {
              ((CollectionListbox) hbc).setObjectValue(value);
            } else {
              ((CollectionListbox) hbc).setObjectValue(lastReq);
            }
          }
          return hbc;
        } else {
          setCellValue(editableCell, !Zero.near((double) value, 2) ? value : lastReq);
        }
      } else if("retention".equals(ec.getProperty())) {
        HtmlBasedComponent hbc = new ContractWrapper(document.getContract()).getRetentionCtrl();
        Object value = getCellValue(editableCell);
        if(hbc != null) {
          if(hbc instanceof CollectionListbox) {
            if(value != null) ((CollectionListbox) hbc).setObjectValue(value);
          }
          return hbc;
        } else {
          setCellValue(editableCell, !Zero.near((double) value, 2) ? value : lastRet);
        }
      }
    }
    return super.createEditor(editableCell);
  }
 
  @Override
  protected void cellChanged(EditableCell editableCell, Object value) {
    super.cellChanged(editableCell, value);
    updateRow(editableCell.getRow());
    EditableColumn ec = (EditableColumn) editableCell.getColumn();
    if(value instanceof Contract) {
      lastStore = (Contract) value;
    } else if("tax".equals(ec.getProperty())) {
      lastTax = (Double) value;
    } else if("equivalenceSurcharge".equals(ec.getProperty())) {
      lastReq = (Double) value;
    } else if("retention".equals(ec.getProperty())) {
      lastRet = (Double) value;
    }
  }
 
  private void addColumns() throws ClassNotFoundException {
    int fractionDigits = document.getCurrency().getDefaultFractionDigits();
    for(RelatedColumn dc : document.getDocumentDefinition().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).setWidth("300px");
//          }
//        } else {
//          if(ProductWrapper.hasAvailableProducts()) {
//            addColumn(I_.get("Product"), Product.class,
//                  "product", null, 0, false, false).setWidth("300px");
//          }
//        }
        if(hasProducts) {
          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, 10, 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 + 2, 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", "#.##", 2, 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(document.getContract().isEquivalenceSurcharge() && DocumentColumn.DCOL_REQ.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("EqSur."), "double",
                "equivalenceSurcharge", null, 2, false, false).setHflex("2");
      } else if(DocumentColumn.DCOL_RETENTION.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("% Ret."), "double",
                "retention", null, 2, false, false).setHflex("2");
      } else if(DocumentColumn.DCOL_AMOUNT.equals(dc.getDocumentColumn())) {
        addColumn(I_.get("Amount"), "double",
                "taxable", null, fractionDigits, false, true).setHflex("4");
      }
    }
    //if(stores.size() > 1) {
      addColumn(I_.get("Store"), Contract.class,
            "store", null, 0, false, false).setHflex("5");
    //}
    //if(document.getDocumentDefinition().getRelatedLineTypes().size() > 1) {
      addColumn(I_.get("Line type"), LineType.class,
              "lineType", null, 0, false, false).setHflex("5");
    //}
  }
 
}