2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.cdm
.model
.agent
;
12 import java
.io
.Serializable
;
14 import java
.util
.ArrayList
;
15 import java
.util
.HashSet
;
16 import java
.util
.List
;
19 import javax
.persistence
.Column
;
20 import javax
.persistence
.ElementCollection
;
21 import javax
.persistence
.Embeddable
;
22 import javax
.persistence
.FetchType
;
23 import javax
.persistence
.OneToMany
;
24 import javax
.xml
.bind
.annotation
.XmlAccessType
;
25 import javax
.xml
.bind
.annotation
.XmlAccessorType
;
26 import javax
.xml
.bind
.annotation
.XmlElement
;
27 import javax
.xml
.bind
.annotation
.XmlElementWrapper
;
28 import javax
.xml
.bind
.annotation
.XmlRootElement
;
29 import javax
.xml
.bind
.annotation
.XmlSchemaType
;
30 import javax
.xml
.bind
.annotation
.XmlType
;
32 import org
.apache
.commons
.lang
.StringUtils
;
33 import org
.apache
.log4j
.Logger
;
34 import org
.hibernate
.annotations
.Cascade
;
35 import org
.hibernate
.annotations
.CascadeType
;
36 import org
.hibernate
.envers
.Audited
;
38 import eu
.etaxonomy
.cdm
.model
.location
.Country
;
39 import eu
.etaxonomy
.cdm
.model
.location
.Point
;
40 import eu
.etaxonomy
.cdm
.strategy
.merge
.MergeException
;
43 * The class for information on how to approach a {@link Person person} or an {@link Institution institution}.
44 * It includes telecommunication data and an electronic as well as
45 * multiple postal addresses.
47 * This class corresponds to: <ul>
48 * <li> ContactDetails according to the TDWG ontology
49 * <li> Contact (partially) according to the ABCD schema
54 * @created 08-Nov-2007 13:06:18
56 @XmlAccessorType(XmlAccessType
.FIELD
)
57 @XmlType(name
= "Contact", propOrder
= {
64 @XmlRootElement(name
= "Contact")
67 public class Contact
implements Serializable
, Cloneable
{
68 private static final long serialVersionUID
= -1851305307069277625L;
69 private static final Logger logger
= Logger
.getLogger(Contact
.class);
72 @XmlElementWrapper(name
= "EmailAddresses", nillable
= true)
73 @XmlElement(name
= "EmailAddress")
74 @ElementCollection(fetch
= FetchType
.LAZY
)
75 @Column(name
= "contact_emailaddresses_element")
76 private List
<String
> emailAddresses
;
78 @XmlElementWrapper(name
= "URLs", nillable
= true)
79 @XmlElement(name
= "URL")
80 @XmlSchemaType(name
= "anyURI")
81 @ElementCollection(fetch
= FetchType
.LAZY
)
82 @Column(name
= "contact_urls_element" /*, length=330 */) //length >255 does not work in InnoDB AUD tables for Key length of (REV, id, url) key
83 @Cascade({CascadeType
.SAVE_UPDATE
, CascadeType
.MERGE
, CascadeType
.DELETE
})
84 private List
<String
> urls
= new ArrayList
<String
>();
86 @XmlElementWrapper(name
= "PhoneNumbers", nillable
= true)
87 @XmlElement(name
= "PhoneNumber")
88 @ElementCollection(fetch
= FetchType
.LAZY
)
89 @Column(name
= "contact_phonenumbers_element")
90 @Cascade({CascadeType
.SAVE_UPDATE
, CascadeType
.MERGE
, CascadeType
.DELETE
})
91 private List
<String
> phoneNumbers
;
93 @XmlElementWrapper(name
= "FaxNumbers", nillable
= true)
94 @XmlElement(name
= "FaxNumber")
95 @ElementCollection(fetch
= FetchType
.LAZY
)
96 @Column(name
= "contact_faxnumbers_element")
97 private List
<String
> faxNumbers
;
99 @XmlElementWrapper(name
= "Addresses", nillable
= true)
100 @XmlElement(name
= "Address")
101 @OneToMany(fetch
= FetchType
.LAZY
, orphanRemoval
=true)
102 @Cascade({CascadeType
.SAVE_UPDATE
, CascadeType
.MERGE
})
103 protected Set
<Address
> addresses
;
106 public static Contact
NewInstance() {
107 return new Contact();
111 * Creates a new contact
125 public static Contact
NewInstance(String street
, String postcode
, String locality
,
126 Country country
, String pobox
, String region
,
127 String email
, String faxNumber
, String phoneNumber
, URI url
, Point location
) {
128 Contact result
= new Contact();
129 if (country
!= null || StringUtils
.isNotBlank(locality
) || StringUtils
.isNotBlank(pobox
) || StringUtils
.isNotBlank(postcode
) ||
130 StringUtils
.isNotBlank(region
) || StringUtils
.isNotBlank(street
) ){
131 Address newAddress
= Address
.NewInstance(country
, locality
, pobox
, postcode
, region
, street
, location
);
132 result
.addAddress(newAddress
);
135 result
.addEmailAddress(email
);
137 if (faxNumber
!= null){
138 result
.addFaxNumber(faxNumber
);
140 if (phoneNumber
!= null){
141 result
.addPhoneNumber(phoneNumber
);
150 public static Contact
NewInstance(Set
<Address
> addresses
, List
<String
> emailAdresses
,
151 List
<String
> faxNumbers
, List
<String
> phoneNumbers
, List
<URI
> urls
) {
152 Contact result
= new Contact();
153 if (addresses
!= null){
154 result
.addresses
= addresses
;
156 if (emailAdresses
!= null){
157 result
.emailAddresses
= emailAdresses
;
159 if (faxNumbers
!= null){
160 result
.faxNumbers
= faxNumbers
;
162 if (phoneNumbers
!= null){
163 result
.phoneNumbers
= phoneNumbers
;
166 for (URI uri
: urls
){
167 result
.urls
.add(uri
.toString());
181 public void merge(Contact contact2
) throws MergeException
{
182 if (contact2
!= null){
183 mergeList(this.getEmailAddresses(), contact2
.getEmailAddresses());
184 mergeList(this.getFaxNumbers(), contact2
.getFaxNumbers());
185 mergeList(this.getPhoneNumbers(), contact2
.getPhoneNumbers());
186 mergeList(this.getUrls(), contact2
.getUrls());
187 for (Address address
: contact2
.getAddresses()){
189 this.addresses
.add((Address
)address
.clone());
190 } catch (CloneNotSupportedException e
) {
191 throw new MergeException("Address must implement Cloneable");
197 private void mergeList(List list1
, List list2
){
198 for (Object obj2
: list2
){
199 if (! list1
.contains(obj2
)){
207 * Returns the set of postal {@link Address addresses} belonging to <i>this</i> contact.
208 * A {@link Person person} or an {@link Institution institution} cannot have more than one contact,
209 * but a contact may include several postal addresses.
211 * @return the set of postal addresses
214 public Set
<Address
> getAddresses(){
215 if(this.addresses
== null) {
216 this.addresses
= new HashSet
<Address
>();
218 return this.addresses
;
222 * Adds a new postal {@link Address address} to the set of postal addresses of <i>this</i> contact.
224 * @param address the address to be added
225 * @see #getAddresses()
228 public void addAddress(Address address
){
229 if (address
!= null){
230 getAddresses().add(address
);
234 public Address
addAddress(String street
, String postcode
, String locality
,
235 Country country
, String pobox
, String region
, Point location
){
236 Address newAddress
= Address
.NewInstance(country
, locality
, pobox
, postcode
, region
, street
, location
);
237 getAddresses().add(newAddress
);
242 * Removes one element from the set of postal addresses of <i>this</i> contact.
244 * @param address the postal address of <i>this</i> contact which should be deleted
245 * @see #getAddresses()
247 public void removeAddress(Address address
){
248 getAddresses().remove(address
);
253 * Returns the List of strings representing the electronic mail addresses
254 * included in <i>this</i> contact.
256 public List
<String
> getEmailAddresses(){
257 if(this.emailAddresses
== null) {
258 this.emailAddresses
= new ArrayList
<String
>();
260 return this.emailAddresses
;
264 * @see #getEmailAddress()
266 public void addEmailAddress(String emailAddress
){
267 getEmailAddresses().add(emailAddress
);
271 * Removes one element from the list of email addresses of <i>this</i> contact.
273 * @param emailAddress the email address of <i>this</i> contact which should be deleted
274 * @see #getEmailAddresses()
276 public void removeEmailAddress(String emailAddress
){
277 getEmailAddresses().remove(emailAddress
);
281 * Returns the list of strings representing the "Uniform Resource Locators" (urls)
282 * included in <i>this</i> contact.
284 public List
<URI
> getUrls(){
285 List
<URI
> result
= new ArrayList
<URI
>();
286 if(this.urls
!= null) {
287 for (String uri
: this.urls
){
288 result
.add(URI
.create(uri
));
297 public void addUrl(URI url
){
298 this.urls
.add(url
.toString());
302 * Removes one element from the list of urls of <i>this</i> contact.
304 * @param url the url of <i>this</i> contact which should be deleted
307 public void removeUrl(URI url
){
308 this.urls
.remove(url
.toString());
312 * Returns the list of strings representing the phone numbers
313 * included in <i>this</i> contact.
315 public List
<String
> getPhoneNumbers(){
316 if(this.phoneNumbers
== null) {
317 this.phoneNumbers
= new ArrayList
<String
>();
319 return this.phoneNumbers
;
325 public void addPhoneNumber(String phoneNumber
){
326 getPhoneNumbers().add(phoneNumber
);
330 * Removes one element from the list of phone numbers of <i>this</i> contact.
332 * @param phoneNumber the phone number of <i>this</i> contact which should be deleted
333 * @see #getPhoneNumber()
335 public void removePhoneNumber(String phoneNumber
){
336 getPhoneNumbers().remove(phoneNumber
);
340 * Returns the list of strings representing the telefax numbers
341 * included in <i>this</i> contact.
343 public List
<String
> getFaxNumbers(){
344 if(this.faxNumbers
== null) {
345 this.faxNumbers
= new ArrayList
<String
>();
347 return this.faxNumbers
;
351 * @see #getFaxNumbers()
353 public void addFaxNumber(String faxNumber
){
354 getFaxNumbers().add(faxNumber
);
358 * Removes one element from the list of telefax numbers of <i>this</i> contact.
360 * @param faxNumber the telefax number of <i>this</i> contact which should be deleted
361 * @see #getFaxNumber()
363 public void removeFaxNumber(String faxNumber
){
364 getFaxNumbers().remove(faxNumber
);
367 //*********************** CLONE ********************************************************/
370 * Clones <i>this</i> Contact. This is a shortcut that enables to create
371 * a new instance that differs only slightly from <i>this</i> Contact.
374 * @see java.lang.Object#clone()
377 public Object
clone() {
379 Contact result
= (Contact
) super.clone();
380 result
.addresses
= new HashSet
<Address
>();
381 for (Address adr
: this.addresses
){
382 result
.addAddress((Address
)adr
.clone());
384 //no changes to emailAdresses, faxNumbers, phoneNumbers, urls
386 }catch (CloneNotSupportedException e
){
387 logger
.warn("Object does not implement cloneable");