BillLine.java

/*
 * Copyright Codecrew Ry
 * 
 * All rights reserved.
 * 
 * This license applies to any software containing a notice placed by the 
 * copyright holder. Such software is herein referred to as the Software. 
 * This license covers modification, distribution and use of the Software. 
 * 
 * Any distribution and use in source and binary forms, with or without 
 * modification is not permitted without explicit written permission from the 
 * copyright owner. 
 * 
 * A non-exclusive royalty-free right is granted to the copyright owner of the 
 * Software to use, modify and distribute all modifications to the Software in 
 * future versions of the Software. 
 * 
 */
/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

package fi.codecrew.moya.model;

import java.math.BigDecimal;
import java.math.RoundingMode;
import java.util.ArrayList;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToOne;
import javax.persistence.Table;

/**
 * 
 */
@Entity
@Table(name = "bill_lines")
public class BillLine extends GenericEntity {

    private static final long serialVersionUID = 2L;
    /**
     * Which bill this bill line belongs to
     */

    @JoinColumn(name = "bill_id", nullable = false, updatable = false)
    @ManyToOne
    private Bill bill;
    /**
     * Product name shown on the bill
     */
    @Column(name = "product_name", nullable = false)
    private String name;

    /**
     * How many quantity the of the product has been purchased eg. 14 (Entrance
     * tickets), 1.5 (l) eh.. something..
     */
    @Column(name = "quantity", nullable = false, precision = 24, scale = 4)
    private BigDecimal quantity = BigDecimal.ZERO;

    /**
     * How much one(1) unit of this product costs
     * 
     */
    @Column(name = "unit_price", nullable = false, precision = 24, scale = Bill.BILL_PRICE_SCALE)
    private BigDecimal unitPrice = Bill.BILL_SCALED_ZERO_PRICE;

    /**
     * 
     */
    @Column(name = "unit_name", nullable = false)
    private String unitName = "";

    /**
     * How much VAT this product contains ( 0, 0.22 ) etc
     */
    @Column(name = "vat", nullable = false, precision = 4, scale = Bill.VAT_SCALE)
    private BigDecimal vat = Bill.VAT_SCALED_ZERO;

    @JoinColumn(name = "lineProduct_id", referencedColumnName = "id", nullable = true, updatable = false)
    @OneToOne
    private Product lineProduct;

    @OneToOne
    @JoinColumn(name = "foodwave_id", referencedColumnName = "id", nullable = true, updatable = false)
    private FoodWave foodwave;

    /**
     * Calculate the total price for the items on this line, 
     * includes vat
     * 
     * @return
     */
    public BigDecimal getLinePrice() {
        return getUnitPrice().multiply(getQuantity());
    }

    public BigDecimal getLineVat() {
        return getLinePriceVatless().multiply(getVat());
    }

    /**
     * return the total VAT-less price for the items on this line
     * 
     * @return
     */
    public BigDecimal getLinePriceVatless() {
        BigDecimal vatMultiplicand = BigDecimal.ONE.add(getVat());
        return getLinePrice().divide(vatMultiplicand, Bill.BILL_PRICE_SCALE, RoundingMode.HALF_UP);
    }

    public BillLine() {
        super();
    }

    public BillLine(Bill bill2, Product product, BigDecimal count) {
        this(bill2, product, count, null, null);
    }

    public BillLine(Bill bill2, Product product, BigDecimal count, FoodWave foodwave, String additionalDescription) {
        super();
        this.bill = bill2;
        this.lineProduct = product;
        this.name = product.getName();

        if(additionalDescription != null && !additionalDescription.trim().isEmpty())
            this.name += ", "+ additionalDescription;

        this.setUnitName(product.getUnitName());
        this.setQuantity(count);
        this.setUnitPrice(product.getPrice().abs());
        this.setVat(product.getVat());
        this.setFoodwave(foodwave);

        if (foodwave != null) {
            if (foodwave.getBillLines() == null) {
                foodwave.setBillLines(new ArrayList<BillLine>());
            }
            if (!foodwave.getBillLines().contains(this)) {
                foodwave.getBillLines().add(this);
            }
        }
    }

    /**
     * Discounttia luotaessa lasketaan productin hinnasta jokin kiva
     * miinuspuolinen rivi discountin mukaan?
     * 
     * Kommentteja plz!
     * 
     * @param bill2
     * @param product
     * @param disc
     * @param count
     */
    public BillLine(Bill bill2, Product product, Discount disc, BigDecimal count) {
        super();
        this.bill = bill2;
        BigDecimal unitPrice = product.getPrice().subtract(product.getPrice().multiply(disc.getPercentage())).negate().setScale(Bill.BILL_PRICE_SCALE, RoundingMode.HALF_UP);

        this.name = disc.getShortdesc();
        this.unitName = product.getUnitName();
        this.quantity = count;
        this.unitPrice = unitPrice;
        this.vat = product.getVat();
    }

    public String getName() {
        return name;
    }

    public void setName(String product) {
        this.name = product;
    }

    public Bill getBill() {
        return bill;
    }

    public void setBill(Bill billsId) {
        this.bill = billsId;
    }

    public void setQuantity(BigDecimal units) {
        this.quantity = units;
    }

    public BigDecimal getQuantity() {
        return quantity;
    }

    public void setUnitPrice(BigDecimal price) {
        this.unitPrice = price;
    }

    public BigDecimal getUnitPrice() {
        return unitPrice;
    }

    /** 
     * Set vat-% for this line, value betveen 0 and 1
     * @param vat
     */
    public void setVat(BigDecimal vat) {
        this.vat = vat;
    }

    /** 
     * Return vat percent for this line
     * @return vat-%, value  between 0.00 and 0.99
     */
    public BigDecimal getVat() {
        return vat;
    }

    public void setUnitName(String unitName) {
        this.unitName = unitName;
    }

    public String getUnitName() {
        return unitName;
    }

    public void setLineProduct(Product lineProduct) {
        this.lineProduct = lineProduct;
    }

    public Product getLineProduct() {
        return lineProduct;
    }

    public FoodWave getFoodwave() {
        return foodwave;
    }

    public void setFoodwave(FoodWave foodwave) {
        this.foodwave = foodwave;
    }

}