Place.java

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package fi.insomnia.bortal.model;

import java.util.Calendar;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.JoinColumns;
import javax.persistence.Lob;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;

/**
 * 
 */
@Entity
@Table(name = "places")
@NamedQueries({
        @NamedQuery(name = "Place.findAll", query = "SELECT p FROM Place p"),
        @NamedQuery(name = "Place.findByDescription", query = "SELECT p FROM Place p WHERE p.description = :description"),
        @NamedQuery(name = "Place.findByName", query = "SELECT p FROM Place p WHERE p.name = :name"),
        @NamedQuery(name = "Place.findByMapX", query = "SELECT p FROM Place p WHERE p.mapX = :mapX"),
        @NamedQuery(name = "Place.findByMapY", query = "SELECT p FROM Place p WHERE p.mapY = :mapY"),
        @NamedQuery(name = "Place.findByDetails", query = "SELECT p FROM Place p WHERE p.details = :details"),
        @NamedQuery(name = "Place.findByCode", query = "SELECT p FROM Place p WHERE p.code = :code") })
public class Place extends GenericEventChild {

    public static final int RESERVE_MINUTES = 20;

    /**
     * 
     */
    private static final long serialVersionUID = -5314851260772328611L;

    @Lob
    @Column(name = "place_description")
    private String description;
    @Column(name = "place_name")
    private String name;
    @Column(name = "map_x")
    private int mapX = 0;
    @Column(name = "map_y")
    private int mapY = 0;
    @Column(name = "width")
    private int width = 0;
    @Column(name = "height")
    private int height = 0;
    @Column(name = "release_time")
    @Temporal(TemporalType.TIMESTAMP)
    private Calendar releaseTime;
    @Column(name = "place_details")
    @Lob
    private String details = "";
    @Column(name = "place_code")
    private String code = "";
    @OneToOne(mappedBy = "placeReservation")
    private GroupMembership placeReserver;

    @Column(name = "buyable", nullable = false)
    private boolean buyable = true;
    /**
     * Which group has bought the place
     */
    @JoinColumns({
            @JoinColumn(name = "group_id", referencedColumnName = "id", nullable=false),
            @JoinColumn(name = "event_id", referencedColumnName = "event_id", nullable = false, updatable = false, insertable = false) })
    @ManyToOne
    private PlaceGroup group;

    @ManyToOne
    @JoinColumns({
            @JoinColumn(name = "provided_role_id", referencedColumnName = "id"),
            @JoinColumn(name = "event_id", referencedColumnName = "event_id", nullable = false, updatable = false, insertable = false) })
    private Role providesRole;

    @JoinColumns({
            @JoinColumn(name = "map_id", referencedColumnName = "id", nullable = false, updatable = true, insertable = true),
            @JoinColumn(name = "event_id", referencedColumnName = "event_id", nullable = false, updatable = false, insertable = false) })
    @ManyToOne(optional = false, cascade = CascadeType.ALL)
    private EventMap map;
    /**
     * Which ticket type is this place sold as
     */
    @JoinColumns({
            @JoinColumn(name = "products_id", referencedColumnName = "id"),
            @JoinColumn(name = "event_id", referencedColumnName = "event_id", nullable = false, updatable = false, insertable = false) })
    @ManyToOne()
    private Product product;
    /**
     * Who is the current currentUser (mapped with code printed on the place) of
     * the place. Used in Vectorama currentUser tracking.
     */
    @JoinColumn(name = "current_user_id", referencedColumnName = "user_id")
    @ManyToOne
    private User currentUser;

    public Place() {
    }

    public Place(EventMap eventMap) {
        super();
        setId(new EventPk());
        getId().setEventId(eventMap.getId().getEventId());
        this.map = eventMap;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String placeDescription) {
        this.description = placeDescription;
    }

    public String getName() {
        return name;
    }

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

    public Integer getMapX() {
        return mapX;
    }

    public void setMapX(Integer mapX) {
        this.mapX = mapX;
    }

    public Integer getMapY() {
        return mapY;
    }

    public void setMapY(Integer mapY) {
        this.mapY = mapY;
    }

    public String getDetails() {
        return details;
    }

    public void setDetails(String placeDetails) {
        this.details = placeDetails;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String placeCode) {
        this.code = placeCode;
    }

    public PlaceGroup getGroup() {
        return group;
    }

    public void setGroup(PlaceGroup group) {
        if (group != null && group.getId().getEventId() != getId().getEventId()) {
            throw new RuntimeException("Can not set Group from different Event to Place!");
        }
        this.group = group;
    }

    public EventMap getMap() {
        return map;
    }

    public void setMap(EventMap map) {
        if (map.getId().getEventId() != getId().getEventId()) {
            throw new RuntimeException("Can not set Map from different Event to Place!");
        }
        this.map = map;
        // this.mapId = map.getId().getId();
    }

    public Product getProduct() {
        return product;
    }

    public void setProduct(Product productsId) {
        this.product = productsId;
    }

    public User getCurrentUser() {
        return currentUser;
    }

    public void setCurrentUser(User usersId) {
        this.currentUser = usersId;
    }

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

    public void setPlaceReserver(GroupMembership placeReserver) {
        this.placeReserver = placeReserver;
    }

    public GroupMembership getPlaceReserver() {
        return placeReserver;
    }

    /**
     * @return the height
     */
    public Integer getHeight() {
        return height;
    }

    /**
     * @param height
     *            the height to set
     */
    public void setHeight(Integer height) {
        this.height = height;
    }

    /**
     * @return the width
     */
    public Integer getWidth() {
        return width;
    }

    /**
     * @param width
     *            the width to set
     */
    public void setWidth(Integer width) {
        this.width = width;
    }

    public boolean isCoordinateInPlace(int x, int y) {
        if (x > mapX
                && x < (mapX + width)
                && y > mapY
                && y < (mapY + height)) {
            return true;
        }

        return false;
    }

    public boolean isTaken() {

        return (getReleaseTime() != null || getGroup() != null);
    }

    /**
     * 
     * @return Is the place reserved ( not bought for user)
     */
    public boolean isReservedFor(User u) {
        return (u.equals(getCurrentUser()) && getGroup() == null);
    }

    /**
     * Reserve the place for user. This reservation will timeout after a while
     * buy() method should be called after this when buying place;
     * 
     * Remember to merge afterwards!
     * 
     * @param user
     * @return true when successfull. On any error false.
     */
    public boolean reserve(User user) {
        if (!isBuyable() || getCurrentUser() != null || getGroup() != null) {
            return false;
        }

        setCurrentUser(user);
        setReleaseTime(Calendar.getInstance());
        getReleaseTime().add(Calendar.MINUTE, RESERVE_MINUTES);

        return true;
    }

    /**
     * Release reservation from user
     * 
     * Remember to merge afterwards!
     * 
     * @param user
     * @return true when successfull, on any erroro false.
     */
    public boolean release(User user) {
        if (getGroup() != null || getCurrentUser() == null || !getCurrentUser().equals(user)) {
            return false;
        }
        setCurrentUser(null);
        setReleaseTime(null);
        return true;
    }

    /**
     * Reserve this place for the group permanently. reserve method has to be
     * called before this method!!
     * 
     * Remember to merge afterwards!
     * 
     * @param group
     * @return true when successfull. On any error false.
     */
    public boolean buy(PlaceGroup group) {
        if (!isBuyable() || getCurrentUser() == null || getGroup() != null || !group.getCreator().equals(getCurrentUser())) {
            return false;
        }
        setReleaseTime(null);
        setGroup(group);
        // Current user temporarily used at place reservation. When buying
        // release field for its original use.
        setCurrentUser(null);

        return true;

    }

    /**
     * Check if the places releasetime has expired and it should be released for
     * shopping
     * 
     * @return If the status of thie entity changed and it should be merged.
     */
    public boolean checkReleased() {
        boolean ret = false;
        if (getGroup() == null && getReleaseTime() != null && Calendar.getInstance().after(getReleaseTime())) {
            setCurrentUser(null);
            setReleaseTime(null);
            ret = true;
        }
        return ret;
    }

    public void setBuyable(boolean buyable) {
        this.buyable = buyable;
    }

    public boolean isBuyable() {
        return buyable;
    }

    public void setReleaseTime(Calendar releaseTime) {
        this.releaseTime = releaseTime;
    }

    public Calendar getReleaseTime() {
        return releaseTime;
    }

    public void setProvidesRole(Role providesRole) {
        this.providesRole = providesRole;
    }

    public Role getProvidesRole() {
        return providesRole;
    }

}