Contact.java

/*******************************************************************************
 * Copyright 2012 Christian Ternes and Thorsten Volland
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package org.businessmanager.domain;

import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Lob;
import javax.persistence.OneToMany;

import org.apache.commons.collections.Predicate;
import org.apache.commons.lang3.StringUtils;
import org.businessmanager.domain.Address.AddressType;
import org.businessmanager.i18n.ResourceBundleAccessor;
import org.businessmanager.util.CollectionUtil;
import org.businessmanager.util.DefaultItemPredicate;
import org.hibernate.search.annotations.Analyze;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.Indexed;
import org.hibernate.search.annotations.IndexedEmbedded;
import org.hibernate.search.annotations.Store;

@Entity
@Indexed
public class Contact extends AbstractEntity {

	public enum Salutation {
		MR("salutation_mr"), MRS("salutation_mrs");

		private String label;

		private Salutation(String label) {
			this.label = label;
		}

		public String getLabel() {
			return ResourceBundleAccessor.getString(label);
		}
	}

	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	private Long id;

	@Column
	@Field(index = Index.YES, analyze = Analyze.NO, store = Store.NO)
	private String firstname;

	@Column
	@Field(index = Index.YES, analyze = Analyze.NO, store = Store.NO)
	private String lastname;

	@Column(length = 100)
	private String title;

	@Column(length = 100)
	@Field(index = Index.YES, analyze = Analyze.NO, store = Store.NO)
	private String jobTitle;

	@Column
	@Field(index = Index.YES, analyze = Analyze.NO, store = Store.NO)
	private String company;

	@Column(length = 20)
	@Enumerated(EnumType.STRING)
	private Salutation salutation = Salutation.MR;

	@Column
	private Calendar birthday;

	@Column
	private String instantMessenger;

	@IndexedEmbedded
	@OneToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL, mappedBy = "contact", orphanRemoval = true)
	private List<ContactItem> contactItems = new ArrayList<ContactItem>();

	@IndexedEmbedded
	@OneToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL, mappedBy = "contact")
	private List<Address> addresses = new ArrayList<Address>();

	@OneToMany(fetch = FetchType.LAZY, mappedBy = "contact")
	private List<Invoice> invoices = new ArrayList<Invoice>();

	@Column
	@Lob
	private String notes;
	
	@Column
	@Lob
	private byte[] image;
	
	@Column
	private String imageType;

	Contact() {
	}

	public Contact(String firstname, String lastname) {
		this.firstname = firstname;
		this.lastname = lastname;
	}

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public String getFirstname() {
		return firstname;
	}

	public void setFirstname(String firstname) {
		this.firstname = firstname;
	}

	public String getLastname() {
		return lastname;
	}

	public void setLastname(String lastname) {
		this.lastname = lastname;
	}

	public String getTitle() {
		return title;
	}

	public void setTitle(String title) {
		this.title = title;
	}

	public String getJobTitle() {
		return jobTitle;
	}

	public void setJobTitle(String jobTitle) {
		this.jobTitle = jobTitle;
	}

	public String getCompany() {
		return company;
	}

	public void setCompany(String company) {
		this.company = company;
	}

	public Salutation getSalutation() {
		return salutation;
	}

	public void setSalutation(Salutation salutation) {
		this.salutation = salutation;
	}

	public List<Invoice> getInvoices() {
		return invoices;
	}

	public void setInvoices(List<Invoice> invoices) {
		this.invoices = invoices;
	}

	public List<Address> getAddresses() {
		return addresses;
	}

	public void setAddresses(List<Address> addresses) {
		this.addresses = addresses;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + ((company == null) ? 0 : company.hashCode());
		result = prime * result
				+ ((firstname == null) ? 0 : firstname.hashCode());
		result = prime * result + ((id == null) ? 0 : id.hashCode());
		result = prime * result + ((image == null) ? 0 : image.hashCode());
		result = prime * result
				+ ((lastname == null) ? 0 : lastname.hashCode());
		result = prime * result
				+ ((salutation == null) ? 0 : salutation.hashCode());
		result = prime * result + ((title == null) ? 0 : title.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		Contact other = (Contact) obj;
		if (company == null) {
			if (other.company != null)
				return false;
		} else if (!company.equals(other.company))
			return false;
		if (firstname == null) {
			if (other.firstname != null)
				return false;
		} else if (!firstname.equals(other.firstname))
			return false;
		if (id == null) {
			if (other.id != null)
				return false;
		} else if (!id.equals(other.id))
			return false;
		if (image == null) {
			if (other.image != null)
				return false;
		} else if (!image.equals(other.image))
			return false;
		if (lastname == null) {
			if (other.lastname != null)
				return false;
		} else if (!lastname.equals(other.lastname))
			return false;
		if (salutation == null) {
			if (other.salutation != null)
				return false;
		} else if (!salutation.equals(other.salutation))
			return false;
		if (title == null) {
			if (other.title != null)
				return false;
		} else if (!title.equals(other.title))
			return false;
		return true;
	}

	public List<ContactItem> getContactItemList() {
		return contactItems;
	}

	public void setContactItemList(List<ContactItem> contactItems) {
		this.contactItems = contactItems;
	}

	/**
	 * Returns list of e-mail addresses of contact. List is read-only! Please
	 * use {@link #setContactItems(List)} to modify contact items.
	 * 
	 * @return list of e-mail addresses
	 */
	public List<Email> getEmailList() {
		return CollectionUtil.typedUnmodifiableSubList(getContactItemList(),
				Email.class);
	}

	/**
	 * Returns list of phone numbers of contact. List is read-only! Please use
	 * {@link #setContactItems(List)} to modify contact items.
	 * 
	 * @return list of phone numbers
	 */
	public List<Phone> getPhoneList() {
		return CollectionUtil.typedUnmodifiableSubList(getContactItemList(),
				Phone.class);
	}

	/**
	 * Returns list of fax numbers of contact. List is read-only! Please use
	 * {@link #setContactItems(List)} to modify contact items.
	 * 
	 * @return list of fax numbers
	 */
	public List<Fax> getFaxList() {
		return CollectionUtil.typedUnmodifiableSubList(getContactItemList(),
				Fax.class);
	}

	/**
	 * Returns list of fax numbers of contact. List is read-only! Please use
	 * {@link #setContactItems(List)} to modify contact items.
	 * 
	 * @return list of website urls
	 */
	public List<Website> getWebsiteList() {
		return CollectionUtil.typedUnmodifiableSubList(getContactItemList(),
				Website.class);
	}

	public Email getDefaultEmail() {
		List<ContactItem> result = CollectionUtil.predicateUnmodifiableSubList(
				getContactItemList(), new DefaultItemPredicate(Email.class));

		if (result.size() > 0) {
			return (Email) result.get(0);
		}
		return null;
	}

	public Phone getDefaultPhone() {
		List<ContactItem> result = CollectionUtil.predicateUnmodifiableSubList(
				getContactItemList(), new DefaultItemPredicate(Phone.class));

		if (result.size() > 0) {
			return (Phone) result.get(0);
		}
		return null;
	}

	public Fax getDefaultFax() {
		List<ContactItem> result = CollectionUtil.predicateUnmodifiableSubList(
				getContactItemList(), new DefaultItemPredicate(Fax.class));

		if (result.size() > 0) {
			return (Fax) result.get(0);
		}
		return null;
	}

	public Website getDefaultWebsite() {
		List<ContactItem> result = CollectionUtil.predicateUnmodifiableSubList(
				getContactItemList(), new DefaultItemPredicate(Website.class));

		if (result.size() > 0) {
			return (Website) result.get(0);
		}
		return null;
	}

	public Address getDefaultBillingAddress() {
		List<Address> result = CollectionUtil.predicateUnmodifiableSubList(
				getAddresses(), new DefaultItemPredicate(Address.class,
						new Predicate() {

							@Override
							public boolean evaluate(Object paramObject) {
								if (paramObject instanceof Address) {
									Address address = (Address) paramObject;
									return AddressType.BILLING.equals(address
											.getScope());
								}
								return false;
							}
						}));

		if (result.size() > 0) {
			return result.get(0);
		}
		return null;
	}

	public Address getDefaultShippingAddress() {
		List<Address> result = CollectionUtil.predicateUnmodifiableSubList(
				getAddresses(), new DefaultItemPredicate(Address.class,
						new Predicate() {

							@Override
							public boolean evaluate(Object paramObject) {
								if (paramObject instanceof Address) {
									Address address = (Address) paramObject;
									return AddressType.SHIPPING.equals(address
											.getScope());
								}
								return false;
							}
						}));

		if (result.size() > 0) {
			return result.get(0);
		}
		return null;
	}

	public String getDisplayName() {
		StringBuilder sb = new StringBuilder();
		appendToString(sb, title);
		appendToString(sb, firstname);
		appendToString(sb, lastname);

		return sb.toString();
	}

	private void appendToString(StringBuilder sb, String value) {
		if (!StringUtils.isEmpty(value)) {
			sb.append(value);
			sb.append(" ");
		}
	}

	public void setBirthday(Calendar birthday) {
		this.birthday = birthday;
	}

	public Calendar getBirthday() {
		return birthday;
	}

	public void setNotes(String notes) {
		this.notes = notes;
	}

	public String getNotes() {
		return notes;
	}

	public void setInstantMessenger(String instantMessenger) {
		this.instantMessenger = instantMessenger;
	}

	public String getInstantMessenger() {
		return instantMessenger;
	}
	
	public String getFullname() {
		return firstname + " " + lastname;
	}

	public byte[] getImage() {
		return image;
	}

	public void setImage(byte[] image) {
		this.image = image;
	}

	public String getImageType() {
		return imageType;
	}

	public void setImageType(String imageType) {
		this.imageType = imageType;
	}
	
}