Product.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.entity;
 
import java.util.*;
import javax.persistence.*;
import org.turro.string.Strings;
import org.turro.elephant.db.IdUtils;
import org.turro.elephant.db.WhereClause;
import org.turro.fieldit.FieldItSet;
import org.turro.fieldit.FieldItUtil;
import org.turro.fieldit.IValueItEntity;
import org.turro.fieldit.ValueItSet;
import org.turro.financials.db.FinancialsPU;
import org.turro.financials.product.IProduct;
import org.turro.financials.product.Movement;
import org.turro.groupit.GroupItUtil;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.math.Round;
import org.turro.reflection.MappingSet;
import org.turro.util.Chars;
 
@Entity
public class Product implements java.io.Serializable, IDaoEntity, IProduct, IValueItEntity {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private long id;
 
  private String productCode, description, keywords;
 
  private double price, tax;
  
  private boolean publishable, service, promoted, delivery, concept, attachments;
 
  @OneToMany(mappedBy = "product", fetch = FetchType.EAGER, cascade = CascadeType.ALL, orphanRemoval=true)
  private Set<ProductByContractor> productByContractors = new HashSet<>();
 
  public String getDescription() {
    return description;
  }
 
  public void setDescription(String description) {
    this.description = description;
  }
 
  public long getId() {
    return id;
  }
 
  public void setId(long id) {
    this.id = id;
  }
 
  public String getKeywords() {
    return keywords;
  }
 
  public void setKeywords(String keywords) {
    this.keywords = keywords;
  }
 
  public double getPrice() {
    return price;
  }
 
  public void setPrice(double price) {
    this.price = price;
  }
 
  public Set<ProductByContractor> getProductByContractors() {
    return productByContractors;
  }
 
  public void setProductByContractors(Set<ProductByContractor> productByContractors) {
    this.productByContractors = productByContractors;
  }
 
  public String getProductCode() {
    return productCode;
  }
 
  public void setProductCode(String productCode) {
    this.productCode = productCode;
  }
 
  public double getTax() {
    return tax;
  }
 
  public void setTax(double tax) {
    this.tax = tax;
  }
 
  public boolean isPublishable() {
    return publishable;
  }
 
  public void setPublishable(boolean publishable) {
    this.publishable = publishable;
  }
 
  public boolean isService() {
    return service;
  }
 
  public void setService(boolean service) {
    this.service = service;
  }
 
  public boolean isPromoted() {
    return promoted;
  }
 
  public void setPromoted(boolean promoted) {
    this.promoted = promoted;
  }
 
  public boolean isDelivery() {
    return delivery;
  }
 
  public void setDelivery(boolean delivery) {
    this.delivery = delivery;
  }
 
  public boolean isConcept() {
    return concept;
  }
 
  public void setConcept(boolean concept) {
    this.concept = concept;
  }
 
  public boolean isAttachments() {
    return attachments;
  }
 
  public void setAttachments(boolean attachments) {
    this.attachments = attachments;
  }
 
  /* IDaoEntity */
  
  @Override
  public Object entityId() {
    return id;
  }
 
  @Override
  public boolean isEmpty() {
    return Strings.isBlank(description);
  }
 
  @Override
  public void prepareSave() {
    if(Strings.isBlank(productCode)) {
      productCode = IdUtils.getNewLongIdFromString(new FinancialsPU(), "Product", "productCode") + "";
    }
  }
 
  /* Helpers */
  
  public String getDescription(boolean fields) {
    return description + 
            (Strings.isBlank(keywords) ? "" : " " + keywords) +
            (fields ? getFieldDescription() : "");
  }
 
  public String getFieldDescription() {
    String extra = getValues().getDescriptionFields();
    return Strings.isBlank(extra) ? "" : " " + extra;
  }
 
  public double getPriceWithTax(int fractions) {
    double taxable = new Round(price).decimals(fractions).value();
    return new Round((taxable * (1.0 + tax / 100.0))).decimals(fractions).value();
  }
  
  /* IProduct */
  
  private transient ProductByContractor productByContractor;
  private transient Double lastCost = null, lastCostTax = null,
          lastPrice = null, lastPriceTax = null;
 
  @Override
  public ProductByContractor getProductByContractor() {
    return productByContractor;
  }
 
  @Override
  public void setProductByContractor(ProductByContractor productByContractor) {
    this.productByContractor = productByContractor;
  }
  
  @Override
  public long getProductId() {
    return id;
  }
 
  @Override
  public String getProductCodeStr() {
    return productCode;
  }
 
  @Override
  public double getProductCost() {
    if(lastCost == null) {
      Object d[] = loadData(1);
      lastCost = (Double) d[0];
      lastCostTax = (Double) d[1];
    }
    return lastCost;
  }
 
  @Override
  public double getProductCostTax() {
    if(lastCost == null) {
      Object d[] = loadData(1);
      lastCost = (Double) d[0];
      lastCostTax = (Double) d[1];
    }
    return lastCostTax;
  }
 
  @Override
  public double getProductPrice() {
    if(price == 0.0d) {
      if(lastPrice == null) {
        Object d[] = loadData(-1);
        lastPrice = (Double) d[0];
        lastPriceTax = (Double) d[1];
      }
      return lastPrice;
    }
    return price;
  }
 
  @Override
  public double getProductPriceTax() {
    if(tax == 0.0d) {
      if(lastPrice == null) {
        Object d[] = loadData(-1);
        lastPrice = (Double) d[0];
        lastPriceTax = (Double) d[1];
      }
      return lastPriceTax;
    }
    return tax;
  }
 
  @Override
  public IProduct load(Object id) {
    throw new UnsupportedOperationException("Not supported yet.");
  }
 
  @Override
  public String getProductName() {
    return description;
  }
 
  @Override
  public double getProductStock(Date date, Contract store) {
    return getStock(store, date);
//    WhereClause wc = new WhereClause();
//    wc.addClause("select coalesce(sum(quantity*dl.lineType.stockCoefficient*1.0),0.0) ");
//    wc.addClause("from DocumentLine dl");
//    wc.addClause("where dl.product = :product");
//    wc.addNamedValue("product", this);
//    if(store != null) {
//      wc.addClause("and dl.store = :store");
//      wc.addNamedValue("store", store);
//    }
//    wc.addClause("and dl.lineType.stockCoefficient <> 0");
//    wc.addClause("and dl.quantity <> 0");
//    if(date != null) {
//      wc.addClause("and dl.document.receiptDate <= :date");
//      wc.addNamedValue("date", date);
//    }
//    Double stock = (Double) new FinancialsPU().getSingleResultOrNull(wc);
//    return stock == null ? 0.0 : stock;
  }
 
  @Override
  public String getProductString() {
    if(productByContractor != null && 
            productByContractor.getContract() != null &&
            productByContractor.getContract().isUseContractorCode()) {
      return "##" + productByContractor.getContractorCode() + Chars.forward().spaced() + getDescription(true);
    } else {
      return "#" + productCode + Chars.forward().spaced() + getDescription(true);
    }
  }
 
  @Override
  public boolean isUncoded() {
    return false;
  }
 
  @Override
  public Collection<Movement> getMovements() {
    WhereClause wc = new WhereClause();
    wc.addClause("select new org.turro.financials.product.Movement");
    wc.addClause("(dl.document.contract, dl.document.documentDate,");
    wc.addClause("dl.lineType.stockCoefficient,dl.quantity,dl.price,dl.concept)");
    wc.addClause("from DocumentLine dl");
    wc.addClause("where (dl.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("or dl.productByContractor = :pbc)");
    wc.addNamedValue("pbc", productByContractor);
    wc.addClause("and dl.quantity <> 0");
    wc.addClause("order by dl.document.receiptDate desc, dl.lineOrder");
    return new FinancialsPU().getResultList(wc, 100);
  }
  
  @Override
  public Collection<Movement> getMovements(Date from, Date to, Contract store) {
    WhereClause wc = new WhereClause();
    wc.addClause("select new org.turro.financials.product.Movement");
    wc.addClause("('Accumulated',coalesce(sum(dl.quantity*dl.lineType.stockCoefficient),0.0),coalesce(sum(dl.quantity*dl.price*dl.lineType.stockCoefficient),0.0))");
    wc.addClause("from DocumentLine dl");
    wc.addClause("where (dl.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("or dl.productByContractor = :pbc)");
    wc.addNamedValue("pbc", productByContractor);
    if(store != null) {
      wc.addClause("and dl.store = :store");
      wc.addNamedValue("store", store);
    }
    wc.addClause("and dl.quantity <> 0");
    wc.addClause("and dl.document.receiptDate < :from2");
    wc.addNamedValue("from2", from);
    Collection<Movement> movs = new FinancialsPU().getResultList(wc);
    wc = new WhereClause();
    wc.addClause("select new org.turro.financials.product.Movement");
    wc.addClause("(dl.document.contract, dl.document.documentDate,");
    wc.addClause("dl.lineType.stockCoefficient,dl.quantity,dl.price,dl.concept)");
    wc.addClause("from DocumentLine dl");
    wc.addClause("where (dl.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("or dl.productByContractor = :pbc)");
    wc.addNamedValue("pbc", productByContractor);
    if(store != null) {
      wc.addClause("and dl.store = :store");
      wc.addNamedValue("store", store);
    }
    wc.addClause("and dl.quantity <> 0");
    wc.addClause("and dl.document.receiptDate >= :from2");
    wc.addNamedValue("from2", from);
    if(to != null) {
      wc.addClause("and dl.document.receiptDate <= :to2");
      wc.addNamedValue("to2", to);
    }
    wc.addClause("order by dl.document.receiptDate asc, dl.lineOrder");
    movs.addAll(new FinancialsPU().getResultList(wc));
    return movs;
  }
 
  public ProductRegulation getLastInventory(Dao dao, Contract store, Date date) {
    WhereClause wc = new WhereClause();
    wc.addClause("select pr from ProductRegulation pr");
    wc.addClause("where pr.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("and pr.store = :store");
    wc.addNamedValue("store", store);
    wc.addClause("and pr.type = :type");
    wc.addNamedValue("type", RegulationType.INVENTORY);
    wc.addClause("and pr.regulationDate = ");
    wc.addClause("(select max(pr2.regulationDate) from ProductRegulation pr2");
    wc.addClause("where pr2.product = pr.product");
    wc.addClause("and pr2.regulationDate <= :date");
    wc.addNamedValue("date", date);
    wc.addClause("and pr2.store = pr.store");
    wc.addClause("and pr2.type = pr.type)");
    return (ProductRegulation) dao.getSingleResultOrNull(wc);
  }
  
  public double getStock(Contract store, Date date) {
    Dao dao = new FinancialsPU();
    ProductRegulation pr = getLastInventory(dao, store, date);
    double stock = pr == null ? 0.0 : pr.getQuantity();
    WhereClause wc = new WhereClause();
    wc.addClause("select coalesce(sum(dl.quantity*dl.lineType.stockCoefficient),0.0)");
    wc.addClause("from DocumentLine dl");
    wc.addClause("where dl.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("and dl.store = :store");
    wc.addNamedValue("store", store);
    wc.addClause("and dl.quantity <> 0");
    wc.addClause("and dl.document.receiptDate <= :date");
    wc.addNamedValue("date", date);
    if(pr != null) {
      wc.addClause("and dl.document.receiptDate >= :from");
      wc.addNamedValue("from", pr.getRegulationDate());
    }
    Double result = (Double) dao.getSingleResultOrNull(wc);
    stock += result == null ? 0.0 : result;
    wc = new WhereClause();
    wc.addClause("select sum(quantity)");
    wc.addClause("from ProductRegulation pr");
    wc.addClause("where pr.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("and pr.store = :store");
    wc.addNamedValue("store", store);
    wc.addClause("and pr.type <> :type");
    wc.addNamedValue("type", RegulationType.INVENTORY);
    wc.addClause("and pr.regulationDate <= :date");
    wc.addNamedValue("date", date);
    if(pr != null) {
      wc.addClause("and pr.regulationDate >= :from");
      wc.addNamedValue("from", pr.getRegulationDate());
    }
    result = (Double) dao.getSingleResultOrNull(wc);
    stock += result == null ? 0.0 : result;
    return stock;
  }
  
  public static List<Product> getProducts() {
    return getProducts(null, false);
  }
  
  public static Product getProductByCode(String code) {
    WhereClause wc = new WhereClause();
    wc.addClause("select prod from Product prod where productCode = :code");
    wc.addNamedValue("code", code);
    return (Product) new FinancialsPU().getSingleResultOrNull(wc);
  }
  
  public static List<Product> getProducts(String concept, boolean equality) {
    WhereClause wc = new WhereClause();
    wc.addClause("select prod");
    getDescriptionQuery(wc, concept, equality);
    List<Product> list = new FinancialsPU().getResultList(wc);
    return list;
  }
  
  private static void getDescriptionQuery(WhereClause wc, String description, boolean equality) {
    wc.addClause("from Product prod");
    if(!Strings.isBlank(description)) {
      wc.addClause("where 1=1");
      if(equality) {
        wc.addClause("and prod.description = :desc");
        wc.addNamedValue("desc", description);
      } else {
        wc.addLikeFields(new String[] { "prod.description" }, description);
      }
    } else {
      wc.addClause("where 1=2");
    }
    wc.addClause("order by prod.description");
  }
 
  private Object[] loadData(double coefficient) {
    WhereClause wc = new WhereClause();
    wc.addClause("select dl.price, dl.tax");
    wc.addClause("from DocumentLine dl");
    wc.addClause("where dl.product = :product");
    wc.addNamedValue("product", this);
    wc.addClause("or dl.productByContractor = :pbc");
    wc.addNamedValue("pbc", productByContractor);
    wc.addClause("and dl.lineType.stockCoefficient = :coef");
    wc.addNamedValue("coef", coefficient);
    wc.addClause("and dl.quantity <> 0");
    wc.addClause("order by dl.document.receiptDate desc, dl.lineOrder");
    List l = new FinancialsPU().getResultList(wc, 1);
    Object d[];
    if(!l.isEmpty()) {
      d = (Object[]) l.get(0);
    } else {
      d = new Double[] { 0.0, 0.0 };
    }
    return d;
  }
  
  /* Fields */
  
  @Override
  public FieldItSet getFields() {
    return GroupItUtil.getFields(FinancialsPU.getObjectPath(this));
  }
  
  @Override
  public ValueItSet getValues() {
    return GroupItUtil.getValues(FinancialsPU.getObjectPath(this));
  }
 
  @Override
  public Object getFieldValue(String label) {
    return FieldItUtil.getFieldValue(label, FinancialsPU.getObjectPath(this));
  }
 
  @Override
  public Collection<IValueItEntity> getRelated() {
    Collection<String> paths = FieldItUtil.related(FinancialsPU.getObjectPath(this));
    return new ArrayList<>();
  }
  
  /* XML Serializer */
  
  public MappingSet getSerializerMappings() {
    MappingSet set = new MappingSet();
    set.addMapping(Product.class, 1, 
            new String[] { "id", "productCode", "description", "keywords", "price", "tax",
                           "publishable", "service", "promoted", "delivery", "concept", "attachments" }, 
            new String[] { "productByContractors" });
    set.addMapping(ProductByContractor.class, 2,
            new String[] { "contractorCode", "price", "tax" }, 
            new String[] { "contract" });
    set.addMapping(Contract.class, 3,
            new String[] { "id", "name" }, 
            null);
    return set;
  }
 
}