BillLine.java

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

package fi.insomnia.bortal.model;

import java.math.BigDecimal;

import javax.persistence.Column;
import javax.persistence.EmbeddedId;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.JoinColumns;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.persistence.Version;

/**
 * 
 */
@Entity
@Table(name = "bill_lines")
@NamedQueries( {
        @NamedQuery(name = "BillLine.findAll", query = "SELECT b FROM BillLine b"),

        @NamedQuery(name = "BillLine.findByProduct", query = "SELECT b FROM BillLine b WHERE b.name = :name"),
        @NamedQuery(name = "BillLine.findByQuantity", query = "SELECT b FROM BillLine b WHERE b.quantity = :quantity"),
        @NamedQuery(name = "BillLine.findByUnitPrice", query = "SELECT b FROM BillLine b WHERE b.unitPrice = :unitPrice"),
        @NamedQuery(name = "BillLine.findByVat", query = "SELECT b FROM BillLine b WHERE b.vat = :vat") })
public class BillLine implements EventChildInterface {
    private static final long serialVersionUID = 1L;
    private static final BigDecimal DEFAULT_VAT = BigDecimal.ZERO;
    @EmbeddedId
    private EventPk id;

    /**
     * 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 = 4)
    private BigDecimal unitPrice = BigDecimal.ZERO;

    /**
     * How much VAT this product contains ( 0, 0.22 ) etc
     */
    @Column(name = "vat", nullable = false, precision = 3, scale = 2)
    private BigDecimal vat = DEFAULT_VAT;

    /**
     * Which bill this bill line belongs to
     */
    @JoinColumns( {
            @JoinColumn(name = "bill_id", referencedColumnName = "id", nullable = false, updatable = false),
            @JoinColumn(name = "event_id", referencedColumnName = "event_id", nullable = false, updatable = false, insertable = false) })
    @ManyToOne
    private Bill bill;

    @Version
    @Column(nullable = false)
    private int jpaVersionField = 0;

    /**
     * Calculate the total price for the items on this line
     * 
     * @return
     */
    public BigDecimal getLinePrice() {
        BigDecimal vatMultiplicand = BigDecimal.ONE.add(getVat());
        return getLinePriceVatless().multiply(vatMultiplicand);
    }

    /**
     * Calculate the total VAT-less price for the items on this lin
     * 
     * @return
     */
    public BigDecimal getLinePriceVatless() {
        return getUnitPrice().multiply(getQuantity());
    }

    public BillLine() {
    }

    public BillLine(Event event, Bill bill) {
        this.id = new EventPk(event);
        this.bill = bill;
    }

    public BillLine(Event event, Bill bill, String product, BigDecimal units,
            BigDecimal unitPrice, BigDecimal vat) {
        this(event, bill);
        this.name = product;
        this.setQuantity(units);
        this.setUnitPrice(unitPrice);
        this.setVat(vat);
    }

    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;
    }

    @Override
    public int hashCode() {
        int hash = 0;
        hash += (id != null ? id.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object object) {
        // TODO: Warning - this method won't work in the case the id fields are
        // not set
        if (!(object instanceof BillLine)) {
            return false;
        }
        BillLine other = (BillLine) object;
        if ((this.id == null && other.id != null)
                || (this.id != null && !this.id.equals(other.id))) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "fi.insomnia.bortal.model.BillLine[id=" + id + "]";
    }

    @Override
    public void setJpaVersionField(int jpaVersionField) {
        this.jpaVersionField = jpaVersionField;
    }

    @Override
    public int getJpaVersionField() {
        return jpaVersionField;
    }

    @Override
    public EventPk getId() {
        return id;
    }

    @Override
    public void setId(EventPk id) {
        this.id = id;
    }

    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;
    }

    public void setVat(BigDecimal vat) {
        this.vat = vat;
    }

    public BigDecimal getVat() {
        return vat;
    }

}