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 private final List
<String
> urls
= new ArrayList
<String
>();
85 @XmlElementWrapper(name
= "PhoneNumbers", nillable
= true)
86 @XmlElement(name
= "PhoneNumber")
87 @ElementCollection(fetch
= FetchType
.LAZY
)
88 @Column(name
= "contact_phonenumbers_element")
89 @Cascade({CascadeType
.SAVE_UPDATE
, CascadeType
.MERGE
, CascadeType
.DELETE
})
90 private List
<String
> phoneNumbers
;
92 @XmlElementWrapper(name
= "FaxNumbers", nillable
= true)
93 @XmlElement(name
= "FaxNumber")
94 @ElementCollection(fetch
= FetchType
.LAZY
)
95 @Column(name
= "contact_faxnumbers_element")
96 private List
<String
> faxNumbers
;
98 @XmlElementWrapper(name
= "Addresses", nillable
= true)
99 @XmlElement(name
= "Address")
100 @OneToMany(fetch
= FetchType
.LAZY
, orphanRemoval
=true)
101 @Cascade({CascadeType
.SAVE_UPDATE
, CascadeType
.MERGE
})
102 protected Set
<Address
> addresses
= new HashSet
<Address
>();
104 public static Contact
NewInstance() {
105 return new Contact();
109 * Creates a new contact
123 public static Contact
NewInstance(String street
, String postcode
, String locality
,
124 Country country
, String pobox
, String region
,
125 String email
, String faxNumber
, String phoneNumber
, URI url
, Point location
) {
126 Contact result
= new Contact();
127 if (country
!= null || StringUtils
.isNotBlank(locality
) || StringUtils
.isNotBlank(pobox
) || StringUtils
.isNotBlank(postcode
) ||
128 StringUtils
.isNotBlank(region
) || StringUtils
.isNotBlank(street
) ){
129 Address newAddress
= Address
.NewInstance(country
, locality
, pobox
, postcode
, region
, street
, location
);
130 result
.addAddress(newAddress
);
133 result
.addEmailAddress(email
);
135 if (faxNumber
!= null){
136 result
.addFaxNumber(faxNumber
);
138 if (phoneNumber
!= null){
139 result
.addPhoneNumber(phoneNumber
);
148 public static Contact
NewInstance(Set
<Address
> addresses
, List
<String
> emailAddresses
,
149 List
<String
> faxNumbers
, List
<String
> phoneNumbers
, List
<URI
> urls
) {
150 Contact result
= new Contact();
151 if (addresses
!= null){
152 result
.addresses
= addresses
;
154 if (emailAddresses
!= null){
155 result
.emailAddresses
= emailAddresses
;
157 if (faxNumbers
!= null){
158 result
.faxNumbers
= faxNumbers
;
160 if (phoneNumbers
!= null){
161 result
.phoneNumbers
= phoneNumbers
;
164 for (URI uri
: urls
){
165 result
.urls
.add(uri
.toString());
179 public void merge(Contact contact2
) throws MergeException
{
180 if (contact2
!= null){
181 mergeList(this.getEmailAddresses(), contact2
.getEmailAddresses());
182 mergeList(this.getFaxNumbers(), contact2
.getFaxNumbers());
183 mergeList(this.getPhoneNumbers(), contact2
.getPhoneNumbers());
184 mergeList(this.getUrls(), contact2
.getUrls());
185 for (Address address
: contact2
.getAddresses()){
187 if (this.addresses
== null){
188 this.addresses
= new HashSet
<Address
>();
190 this.addresses
.add((Address
)address
.clone());
191 } catch (CloneNotSupportedException e
) {
192 throw new MergeException("Address must implement Cloneable");
198 private void mergeList(List list1
, List list2
){
199 for (Object obj2
: list2
){
200 if (! list1
.contains(obj2
)){
208 * Returns the set of postal {@link Address addresses} belonging to <i>this</i> contact.
209 * A {@link Person person} or an {@link Institution institution} cannot have more than one contact,
210 * but a contact may include several postal addresses.
212 * @return the set of postal addresses
215 public Set
<Address
> getAddresses(){
216 return this.addresses
;
220 * Adds a new postal {@link Address address} to the set of postal addresses of <i>this</i> contact.
222 * @param address the address to be added
223 * @see #getAddresses()
226 public void addAddress(Address address
){
227 if (address
!= null){
228 getAddresses().add(address
);
232 public Address
addAddress(String street
, String postcode
, String locality
,
233 Country country
, String pobox
, String region
, Point location
){
234 Address newAddress
= Address
.NewInstance(country
, locality
, pobox
, postcode
, region
, street
, location
);
235 getAddresses().add(newAddress
);
240 * Removes one element from the set of postal addresses of <i>this</i> contact.
242 * @param address the postal address of <i>this</i> contact which should be deleted
243 * @see #getAddresses()
245 public void removeAddress(Address address
){
246 getAddresses().remove(address
);
251 * Returns the List of strings representing the electronic mail addresses
252 * included in <i>this</i> contact.
254 public List
<String
> getEmailAddresses(){
255 if(this.emailAddresses
== null) {
256 this.emailAddresses
= new ArrayList
<String
>();
258 return this.emailAddresses
;
262 * @see #getEmailAddress()
264 public void addEmailAddress(String emailAddress
){
265 getEmailAddresses().add(emailAddress
);
269 * Removes one element from the list of email addresses of <i>this</i> contact.
271 * @param emailAddress the email address of <i>this</i> contact which should be deleted
272 * @see #getEmailAddresses()
274 public void removeEmailAddress(String emailAddress
){
275 getEmailAddresses().remove(emailAddress
);
279 // * Returns the list of {@link URI URIs} representing this contact
280 // * included in <i>this</i> contact.
282 // @Transient //TODO preliminary workaround as we get LazyInit Exception in JSON #4444
283 // public List<URI> getUrls(){
284 // List<URI> result = new ArrayList<URI>();
285 // if(this.urls != null) {
286 // for (String uri : this.urls){
287 // result.add(URI.create(uri));
294 * Returns the list of {@link URI URIs} representing this contact
295 * included in <i>this</i> contact.
297 public List
<String
> getUrls(){
304 public void addUrl(URI url
){
305 this.urls
.add(url
.toString());
309 * Removes one element from the list of urls of <i>this</i> contact.
311 * @param url the url of <i>this</i> contact which should be deleted
314 public void removeUrl(URI url
){
315 this.urls
.remove(url
.toString());
320 * Returns the list of strings representing the phone numbers
321 * included in <i>this</i> contact.
323 public List
<String
> getPhoneNumbers(){
324 if(this.phoneNumbers
== null) {
325 this.phoneNumbers
= new ArrayList
<String
>();
327 return this.phoneNumbers
;
333 public void addPhoneNumber(String phoneNumber
){
334 getPhoneNumbers().add(phoneNumber
);
338 * Removes one element from the list of phone numbers of <i>this</i> contact.
340 * @param phoneNumber the phone number of <i>this</i> contact which should be deleted
341 * @see #getPhoneNumber()
343 public void removePhoneNumber(String phoneNumber
){
344 getPhoneNumbers().remove(phoneNumber
);
348 * Returns the list of strings representing the telefax numbers
349 * included in <i>this</i> contact.
351 public List
<String
> getFaxNumbers(){
352 if(this.faxNumbers
== null) {
353 this.faxNumbers
= new ArrayList
<String
>();
355 return this.faxNumbers
;
359 * @see #getFaxNumbers()
361 public void addFaxNumber(String faxNumber
){
362 getFaxNumbers().add(faxNumber
);
366 * Removes one element from the list of telefax numbers of <i>this</i> contact.
368 * @param faxNumber the telefax number of <i>this</i> contact which should be deleted
369 * @see #getFaxNumber()
371 public void removeFaxNumber(String faxNumber
){
372 getFaxNumbers().remove(faxNumber
);
375 //*********************** CLONE ********************************************************/
378 * Clones <i>this</i> Contact. This is a shortcut that enables to create
379 * a new instance that differs only slightly from <i>this</i> Contact.
382 * @see java.lang.Object#clone()
385 public Object
clone() {
387 Contact result
= (Contact
) super.clone();
388 result
.addresses
= new HashSet
<Address
>();
389 for (Address adr
: this.addresses
){
390 result
.addAddress((Address
)adr
.clone());
392 //no changes to emailAdresses, faxnumbers, phonenumbers, urls
394 }catch (CloneNotSupportedException e
){
395 logger
.warn("Object does not implement cloneable");