package eu.etaxonomy.cdm.model.agent;
+import javax.persistence.Entity;
+import javax.persistence.ManyToOne;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlIDREF;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlSchemaType;
+import javax.xml.bind.annotation.XmlTransient;
+import javax.xml.bind.annotation.XmlType;
-import eu.etaxonomy.cdm.model.location.WaterbodyOrCountry;
-import eu.etaxonomy.cdm.model.location.Point;
-import eu.etaxonomy.cdm.model.common.VersionableEntity;
import org.apache.log4j.Logger;
-import java.util.*;
-import javax.persistence.*;
+
+import eu.etaxonomy.cdm.model.common.VersionableEntity;
+import eu.etaxonomy.cdm.model.location.Point;
+import eu.etaxonomy.cdm.model.location.WaterbodyOrCountry;
/**
- * Representation of an atomized postal address.
- * <p>
- * See also the <a href="http://rs.tdwg.org/ontology/voc/ContactDetails#Address">TDWG Ontology</a>
+ * This class represents atomized postal addresses.
+ * <P>
+ * This class corresponds to: <ul>
+ * <li> Address according to the TDWG ontology
+ * <li> Address according to the TCS
+ * <li> Address according to the ABCD schema
+ * </ul>
*
* @author m.doering
* @version 1.0
* @created 08-Nov-2007 13:06:09
*/
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "", propOrder = {
+ "pobox",
+ "street",
+ "postcode",
+ "locality",
+ "region",
+ "country",
+ "location",
+ "contact"
+})
+@XmlRootElement(name = "Address")
@Entity
public class Address extends VersionableEntity {
+
static Logger logger = Logger.getLogger(Address.class);
+
+ @XmlElement(name = "POBox")
private String pobox;
+
+ @XmlElement(name = "Street")
private String street;
+
+ @XmlElement(name = "Postcode")
private String postcode;
+
+ @XmlElement(name = "Locality", required = true)
private String locality;
+
+ @XmlElement(name = "Region")
private String region;
+
+ @XmlElement(name = "Country")
+ @XmlIDREF
+ @XmlSchemaType(name = "IDREF")
private WaterbodyOrCountry country;
+
+ @XmlElement(name = "Location")
private Point location;
+
//Bidirectional only private
+ @XmlElement(name = "Contact")
private Contact contact;
+ /**
+ * Returns the {@link Contact contact} (of a {@link Person person} or of an {@link Institution institution})
+ * to which <i>this</i> address belongs.
+ * Both kinds of agents cannot have more than one contact, but a contact may include
+ * several postal addresses.
+ *
+ * @return the contact <i>this</i> postal address belongs to
+ * @see Contact
+ */
@ManyToOne
public Contact getContact() {
return contact;
}
+
+
/**
- * Assigns this postal address to a new contact.
- * This method also updates the sets of postal addresses
- * which belong to the two contacts (the new one and the substituted one).
+ * Adds <i>this</i> postal address to the set of addresses of a {@link Contact contact}.
+ * The same address instance cannot be assigned to different persons
+ * or institutions (if they do have the same postal address several
+ * address instances must be created). If <i>this</i> address already belongs to a
+ * contact this method shifts it from this contact to a new one.
+ * Therefore <i>this</i> address will be removed from the set of addresses of the old
+ * contact and added to the set of the new one.
*
- * @param newContact the new contact to which this postal address should belong
+ * @param newContact the new contact to which <i>this</i> postal address should belong
* @see Contact#addAddress(Address)
* @see Contact#removeAddress(Address)
*/
protected void setContact(Contact newContact) {
- // Hibernate bidirectional cascade hack:
- // http://opensource.atlassian.com/projects/hibernate/browse/HHH-1054
- if(this.contact == newContact) return;
- if (contact != null) {
- contact.addresses.remove(this);
- }
- if (newContact!= null) {
- newContact.addresses.add(this);
- }
this.contact = newContact;
}
+ /**
+ * Returns the {@link WaterbodyOrCountry country} involved in <i>this</i> postal address.
+ *
+ * @return the country
+ */
@ManyToOne
public WaterbodyOrCountry getCountry(){
return this.country;
}
/**
- * Assigns a country to this postal address.
- *
- * @param country the (waterbody or) country
+ * @see #getCountry()
*/
public void setCountry(WaterbodyOrCountry country){
this.country = country;
}
+ /**
+ * Returns the geophysical {@link Point location} (coordinates) of <i>this</i> postal address.
+ * The location can be useful for instance to visualize the address on a map.
+ *
+ * @return the point corresponding to <i>this</i> address
+ * @see eu.etaxonomy.cdm.model.location.Point
+ */
+ @XmlTransient
public Point getLocation(){
return this.location;
}
/**
- * Assigns a geophysical location to this postal address.
- *
- * @param location the point corresponding to this address
- * @see location.Point
+ * @see #getLocation()
*/
public void setLocation(Point location){
this.location = location;
}
+ /**
+ * Returns a string corresponding to the post office box
+ * involved in <i>this</i> postal address.
+ *
+ * @return the post office box string
+ */
public String getPobox(){
return this.pobox;
}
/**
- * Assigns a post office box to this postal address.
- *
- * @param pobox string describing a post office box
+ * @see #getPobox()
*/
public void setPobox(String pobox){
this.pobox = pobox;
}
+ /**
+ * Returns the street name and number involved in <i>this</i> postal address.
+ * Street numbers are part of the street string.
+ *
+ * @return the string composed of street name and number
+ */
public String getStreet(){
return this.street;
}
/**
- * Assigns a street name and number to this postal address.
- *
- * @param street string containing a street name and a street number
+ * @see #getStreet()
*/
public void setStreet(String street){
this.street = street;
}
+ /**
+ * Returns the post code number involved in <i>this</i> postal address.
+ *
+ * @return the post code number string
+ */
public String getPostcode(){
return this.postcode;
}
/**
- * Assigns a post code number to this postal address.
- *
- * @param postcode string representing a post code
+ * @see #getPostcode()
*/
public void setPostcode(String postcode){
this.postcode = postcode;
}
+ /**
+ * Returns the town (possibly with locality or suburb) involved in <i>this</i> postal address.
+ *
+ * @return the string representing a town
+ */
public String getLocality(){
return this.locality;
}
/**
- * Assigns a town (possibly with locality or suburb) to this postal address.
- *
- * @param locality string representing a town (may include locality or suburb)
+ * @see #getLocality()
*/
public void setLocality(String locality){
this.locality = locality;
}
+ /**
+ * Returns the region or state involved in <i>this</i> postal address.
+ *
+ * @return the string representing a region or a state
+ */
public String getRegion(){
return this.region;
}
/**
- * Assigns a region or state to this postal address.
- *
- * @param region string representing a region or a state
+ * @see #getRegion()
*/
public void setRegion(String region){
this.region = region;
BGBM BDI Projects / cdmlib.git / blobdiff