root/trunk/cdmlib/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/agent/Contact.java

/**
* Copyright (C) 2007 EDIT
* European Distributed Institute of Taxonomy 
* http://www.e-taxonomy.eu
* 
* The contents of this file are subject to the Mozilla Public License Version 1.1
* See LICENSE.TXT at the top of this package for the full license terms.
*/

package eu.etaxonomy.cdm.model.agent;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import javax.persistence.Embeddable;
import javax.persistence.FetchType;
import javax.persistence.OneToMany;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlSchemaType;
import javax.xml.bind.annotation.XmlType;

import org.apache.log4j.Logger;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.CascadeType;
import org.hibernate.annotations.CollectionOfElements;
import org.hibernate.envers.Audited;

import eu.etaxonomy.cdm.common.CdmUtils;
import eu.etaxonomy.cdm.model.location.Point;
import eu.etaxonomy.cdm.model.location.WaterbodyOrCountry;
import eu.etaxonomy.cdm.strategy.merge.MergeException;

/**
 * The class for information on how to approach a {@link Person person} or an {@link Institution institution}.
 * It includes telecommunication data and an electronic as well as
 * multiple postal addresses.
* <P>
 * This class corresponds to: <ul>
 * <li> ContactDetails according to the TDWG ontology
 * <li> Contact (partially) according to the ABCD schema
 * </ul>
 * 
 * @author m.doering
 * @version 1.0
 * @created 08-Nov-2007 13:06:18
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Contact", propOrder = {
    "emailAddresses",
    "urls",
    "phoneNumbers",
    "faxNumbers",
    "addresses"
})
@XmlRootElement(name = "Contact")
@Embeddable
@Audited
public class Contact implements Serializable, Cloneable {
        private static final long serialVersionUID = -1851305307069277625L;
        @SuppressWarnings("unused")
        private static final Logger logger = Logger.getLogger(Contact.class);
        
        
        public static Contact NewInstance() {
                return new Contact();
        }

        /**
         * Creates a new contact
         * @param street
         * @param postcode
         * @param locality
         * @param country
         * @param pobox
         * @param region
         * @param email
         * @param faxNumber
         * @param phoneNumber
         * @param url
         * @param location
         * @return
         */
        public static Contact NewInstance(String street, String postcode, String locality, 
                        WaterbodyOrCountry country, String pobox, String region, 
                        String email, String faxNumber, String phoneNumber, String url, Point location) {
                Contact result = new Contact();
                if (country != null || CdmUtils.isNotEmpty(locality) || CdmUtils.isNotEmpty(pobox) || CdmUtils.isNotEmpty(postcode) || 
                                CdmUtils.isNotEmpty(region) || CdmUtils.isNotEmpty(street) ){
                        Address newAddress = Address.NewInstance(country, locality, pobox, postcode, region, street, location);
                        result.addAddress(newAddress);
                }
                if (email != null){
                        result.addEmailAddress(email);
                }
                if (faxNumber != null){
                        result.addFaxNumber(faxNumber);
                }
                if (phoneNumber != null){
                        result.addPhoneNumber(phoneNumber);
                }
                if (url != null){
                        result.addUrl(url);
                }
                return result;
        }

        
        public static Contact NewInstance(Set<Address> addresses, List<String> emailAdresses,
                        List<String> faxNumbers, List<String> phoneNumbers, List<String> urls) {
                Contact result = new Contact();
                if (addresses != null){
                        result.addresses = addresses;
                }
                if (emailAdresses != null){
                        result.emailAddresses = emailAdresses;
                }
                if (faxNumbers != null){
                        result.faxNumbers = faxNumbers;
                }
                if (phoneNumbers != null){
                        result.phoneNumbers = phoneNumbers;
                }
                if (urls != null){
                        result.urls = urls;
                }
                return result;
        }

        
        /** 
         * Class constructor.
         */
        public Contact() {
        }

        @XmlElementWrapper(name = "EmailAddresses", nillable = true)
        @XmlElement(name = "EmailAddress")
        @CollectionOfElements(fetch = FetchType.LAZY)
        private List<String> emailAddresses;
        
        @XmlElementWrapper(name = "URLs", nillable = true)
        @XmlElement(name = "URL")
    @XmlSchemaType(name = "anyURI")
    @CollectionOfElements(fetch = FetchType.LAZY)
        private List<String> urls;
        
        @XmlElementWrapper(name = "PhoneNumbers", nillable = true)
        @XmlElement(name = "PhoneNumber")
        @CollectionOfElements(fetch = FetchType.LAZY)
        private List<String> phoneNumbers;
        
        @XmlElementWrapper(name = "FaxNumbers", nillable = true)
        @XmlElement(name = "FaxNumber")
        @CollectionOfElements(fetch = FetchType.LAZY)
        private List<String> faxNumbers;
        
    @XmlElementWrapper(name = "Addresses", nillable = true)
    @XmlElement(name = "Address")
    @OneToMany(fetch = FetchType.LAZY)
        @Cascade({CascadeType.SAVE_UPDATE, CascadeType.MERGE, CascadeType.DELETE_ORPHAN})
        protected Set<Address> addresses;
        
        
        public void merge(Contact contact2) throws MergeException{
                if (contact2 != null){
                        mergeList(this.getEmailAddresses(), contact2.getEmailAddresses());
                        mergeList(this.getFaxNumbers(), contact2.getFaxNumbers());
                        mergeList(this.getPhoneNumbers(), contact2.getPhoneNumbers());
                        mergeList(this.getUrls(), contact2.getUrls());
                        for (Address address : contact2.getAddresses()){
                                try {
                                        this.addresses.add((Address)address.clone());
                                } catch (CloneNotSupportedException e) {
                                        throw new MergeException("Address must implement Cloneable");
                                }               
                        }
                }
        }
        
        private void mergeList(List list1, List list2){
                for (Object obj2 : list2){
                        if (! list1.contains(obj2)){
                                list1.add(obj2);
                        }
                }
        }
    
    
        /** 
         * Returns the set of postal {@link Address addresses} belonging to <i>this</i> contact. 
         * A {@link Person person} or an {@link Institution institution} cannot have more than one contact,
         * but a contact may include several postal addresses. 
         *
         * @return      the set of postal addresses
         * @see     Address
         */
        public Set<Address> getAddresses(){
                if(this.addresses == null) {
                        this.addresses = new HashSet<Address>();
                }
                return this.addresses;
        }
        
        /** 
         * Adds a new postal {@link Address address} to the set of postal addresses of <i>this</i> contact.
         *
         * @param  address  the address to be added
         * @see                 #getAddresses()
         * @see                         Address
         */
        public void addAddress(Address address){
                if (address != null){
                        getAddresses().add(address);
                }
        }
        
        public void addAddress(String street, String postcode, String locality, 
                        WaterbodyOrCountry country, String pobox, String region, Point location){
                Address newAddress = Address.NewInstance(country, locality, pobox, postcode, region, street, location);
                getAddresses().add(newAddress);
        }
        
        /** 
         * Removes one element from the set of postal addresses of <i>this</i> contact.
         *
         * @param  address  the postal address of <i>this</i> contact which should be deleted
         * @see                 #getAddresses()
         */
        public void removeAddress(Address address){
                getAddresses().remove(address);
        }

        
        /**
         * Returns the List of strings representing the electronic mail addresses
         * included in <i>this</i> contact.
         */
        public List<String> getEmailAddresses(){
                if(this.emailAddresses == null) {
                        this.emailAddresses = new ArrayList<String>();
                }
                return this.emailAddresses;
        }

        /**
         * @see  #getEmailAddress()
         */
        public void addEmailAddress(String emailAddress){
                getEmailAddresses().add(emailAddress);
        }
        
        /** 
         * Removes one element from the list of email addresses of <i>this</i> contact.
         *
         * @param  emailAddress  the email address of <i>this</i> contact which should be deleted
         * @see                 #getEmailAddresses()
         */
        public void removeEmailAddress(String emailAddress){
                getEmailAddresses().remove(emailAddress);
        }

        /**
         * Returns the list of strings representing the "Uniform Resource Locators" (urls)
         * included in <i>this</i> contact.
         */
        public List<String> getUrls(){
                if(this.urls == null) {
                        this.urls = new ArrayList<String>();
                }
                return this.urls;
        }

        /**
         * @see  #getUrls()
         */
        public void addUrl(String url){
                getUrls().add(url);
        }
        
        /** 
         * Removes one element from the list of urls of <i>this</i> contact.
         *
         * @param  url  the url of <i>this</i> contact which should be deleted
         * @see                 #getUrls()
         */
        public void removeUrl(String url){
                getUrls().remove(url);
        }

        /**
         * Returns the list of strings representing the phone numbers
         * included in <i>this</i> contact.
         */
        public List<String> getPhoneNumbers(){
                if(this.phoneNumbers == null) {
                        this.phoneNumbers = new ArrayList<String>();
                }
                return this.phoneNumbers;
        }

        /**
         * @see  #getPhone()
         */
        public void addPhoneNumber(String phoneNumber){
                getPhoneNumbers().add(phoneNumber);
        }
        
        /** 
         * Removes one element from the list of phone numbers of <i>this</i> contact.
         *
         * @param  phoneNumber  the phone number of <i>this</i> contact which should be deleted
         * @see                 #getPhoneNumber()
         */
        public void removePhoneNumber(String phoneNumber){
                getPhoneNumbers().remove(phoneNumber);
        }

        /**
         * Returns the list of strings representing the telefax numbers
         * included in <i>this</i> contact.
         */
        public List<String> getFaxNumbers(){
                if(this.faxNumbers == null) {
                        this.faxNumbers = new ArrayList<String>();
                }
                return this.faxNumbers;
        }

        /**
         * @see  #getFaxNumbers()
         */
        public void addFaxNumber(String faxNumber){
                getFaxNumbers().add(faxNumber);
        }

        /** 
         * Removes one element from the list of telefax numbers of <i>this</i> contact.
         *
         * @param  faxNumber  the telefax number of <i>this</i> contact which should be deleted
         * @see                 #getFaxNumber()
         */
        public void removeFaxNumber(String faxNumber){
                getFaxNumbers().remove(faxNumber);
        }

//*********************** CLONE ********************************************************/
        
        /** 
         * Clones <i>this</i> Contact. This is a shortcut that enables to create
         * a new instance that differs only slightly from <i>this</i> Contact.
         *  
         * 
         * @see java.lang.Object#clone()
         */
        @Override
        public Object clone() {
                try{
                        Contact result = (Contact) super.clone();
                        result.addresses = new HashSet<Address>();
                        for (Address adr : this.addresses){
                                result.addAddress((Address)adr.clone());
                        }
                        //no changes to emailAdresses, faxNumbers, phoneNumbers, urls
                        return result;
                }catch (CloneNotSupportedException e){
                        logger.warn("Object does not implement cloneable");
                        e.printStackTrace();
                        return null;
                }
        }
}