Merge pull request #134 from FamilySearch/shared-events

Relationships are N-Squared: Provide for Shared Events

gedcomx-common/src/main/java/org/gedcomx/types/RelationshipRole.java → gedcomx-common/src/main/java/org/gedcomx/types/EventRoleType.java

@@ -20,22 +20,17 @@
 import org.gedcomx.common.URI;
 
 /**
- * Enumeration of standard relationship roles.
+ * Enumeration of standard event roles.
  */
 @XmlQNameEnum (
   base = XmlQNameEnum.BaseType.URI
 )
-public enum RelationshipRole {
+public enum EventRoleType {
 
-  Spouse,
-  Parent,
-  Child,
-  Grandparent,
-  Grandchild,
-  Ancestor,
-  Descendant,
-  Cousin,
-  InLaw,
+  Principal,
+  Participant,
+  Official,
+  Witness,
   @XmlUnknownQNameEnumValue
   OTHER;
 
@@ -54,8 +49,8 @@ public URI toQNameURI() {
    * @param qname The qname.
    * @return The enumeration.
    */
-  public static RelationshipRole fromQNameURI(URI qname) {
-    return org.codehaus.enunciate.XmlQNameEnumUtil.fromURIValue(qname.toString(), RelationshipRole.class);
+  public static EventRoleType fromQNameURI(URI qname) {
+    return org.codehaus.enunciate.XmlQNameEnumUtil.fromURIValue(qname.toString(), EventRoleType.class);
   }
 
 }

gedcomx-common/src/main/java/org/gedcomx/types/EventType.java

@@ -0,0 +1,90 @@
+/**
+ * Copyright 2011-2012 Intellectual Reserve, Inc.
+ *
+ * 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.gedcomx.types;
+
+import org.codehaus.enunciate.qname.XmlQNameEnum;
+import org.codehaus.enunciate.qname.XmlUnknownQNameEnumValue;
+import org.gedcomx.common.URI;
+
+/**
+ * Enumeration of standard event types.
+ */
+@XmlQNameEnum (
+  base = XmlQNameEnum.BaseType.URI
+)
+public enum EventType {
+
+  Adoption,
+  AdultChristening,
+  Annulment,
+  Arrival,
+  Baptism,
+  BarMitzvah,
+  BatMitzvah,
+  Birth,
+  Blessing,
+  Burial,
+  Census,
+  Christening,
+  Circumcision,
+  Confirmation,
+  Cremation,
+  Death,
+  Departure,
+  Divorce,
+  DivorceFiling,
+  Education,
+  Engagement,
+  Emigration,
+  Excommunication,
+  FirstCommunion,
+  Funeral,
+  Graduation,
+  Immigration,
+  Interment,
+  Marriage,
+  MilitaryAward,
+  MilitaryDischarge,
+  Mission,
+  Move,
+  Ordinance,
+  Ordination,
+  Retirement,
+
+
+  @XmlUnknownQNameEnumValue
+  OTHER;
+
+  /**
+   * Return the QName value for this enum.
+   *
+   * @return The QName value for this enum.
+   */
+  public URI toQNameURI() {
+    return URI.create(org.codehaus.enunciate.XmlQNameEnumUtil.toURIValue(this));
+  }
+
+  /**
+   * Get the enumeration from the QName.
+   *
+   * @param qname The qname.
+   * @return The enumeration.
+   */
+  public static EventType fromQNameURI(URI qname) {
+    return org.codehaus.enunciate.XmlQNameEnumUtil.fromURIValue(qname.toString(), EventType.class);
+  }
+
+}

gedcomx-common/src/test/java/org/gedcomx/types/TypesTest.java

@@ -23,7 +23,7 @@ public void testToQNameURI() throws Exception {
     NameType.Formal.toQNameURI();
     PlacePartType.Address.toQNameURI();
     RecordType.Census.getBaseType();
-    RelationshipRole.Ancestor.toQNameURI();
+    EventRoleType.Participant.toQNameURI();
     RelationshipType.Couple.toQNameURI();
   }
 }

gedcomx-conclusion/src/main/java/org/gedcomx/conclusion/Event.java

@@ -0,0 +1,221 @@
+/**
+ * Copyright 2011-2012 Intellectual Reserve, Inc.
+ *
+ * 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.gedcomx.conclusion;
+
+import org.codehaus.enunciate.json.JsonName;
+import org.codehaus.jackson.annotate.JsonIgnore;
+import org.codehaus.jackson.annotate.JsonProperty;
+import org.codehaus.jackson.annotate.JsonTypeInfo;
+import org.codehaus.jackson.map.annotate.JsonTypeIdResolver;
+import org.gedcomx.common.GenealogicalResource;
+import org.gedcomx.common.URI;
+import org.gedcomx.rt.CommonModels;
+import org.gedcomx.rt.JsonElementWrapper;
+import org.gedcomx.rt.XmlTypeIdResolver;
+import org.gedcomx.types.EventType;
+import org.gedcomx.types.TypeReference;
+
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlTransient;
+import javax.xml.bind.annotation.XmlType;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A historical event.
+ *
+ * @author Ryan Heaton
+ */
+@XmlRootElement
+@JsonElementWrapper (name = "events")
+@JsonTypeInfo ( use =JsonTypeInfo.Id.CUSTOM, property = XmlTypeIdResolver.TYPE_PROPERTY_NAME)
+@JsonTypeIdResolver ( XmlTypeIdResolver.class )
+@XmlType ( name = "Event", propOrder = { "type", "date", "place", "roles", "sources" } )
+public class Event extends GenealogicalResource implements ReferencesSources {
+
+  @XmlElement (namespace = CommonModels.RDF_NAMESPACE)
+  @JsonProperty
+  private TypeReference<EventType> type;
+  private Date date;
+  private Place place;
+  private List<EventRole> roles;
+  private List<SourceReference> sources;
+
+  /**
+   * Create an event.
+   */
+  public Event() {
+  }
+
+  /**
+   * Create an event with the passed in type and values.
+   *
+   * @param EventType the event type.
+   */
+  public Event(EventType EventType) {
+    setKnownType(EventType);
+  }
+
+  /**
+   * Create a date/place event with the passed in type and values.
+   *
+   * @param EventType the event type.
+   * @param date The date of applicability of this event.
+   * @param place The place of applicability of this event.
+   */
+  public Event(EventType EventType, Date date, Place place) {
+    setKnownType(EventType);
+    setDate(date);
+    setPlace(place);
+  }
+
+  /**
+   * The type of the event.
+   *
+   * @return The type of the event.
+   */
+  @XmlTransient
+  @JsonIgnore
+  public URI getType() {
+    return this.type == null ? null : this.type.getType();
+  }
+
+  /**
+   * The type of the event.
+   *
+   * @param type The type of the event.
+   */
+  @JsonIgnore
+  public void setType(URI type) {
+    this.type = type == null ? null : new TypeReference<EventType>(type);
+  }
+
+  /**
+   * The enum referencing the known type of the event, or {@link org.gedcomx.types.EventType#OTHER} if not known.
+   *
+   * @return The enum referencing the known type of the event, or {@link org.gedcomx.types.EventType#OTHER} if not known.
+   */
+  @XmlTransient
+  @JsonIgnore
+  public org.gedcomx.types.EventType getKnownType() {
+    return this.type == null ? null : EventType.fromQNameURI(this.type.getType());
+  }
+
+  /**
+   * Set the type of this event from a known enumeration of event types.
+   *
+   * @param knownType the event type.
+   */
+  @JsonIgnore
+  public void setKnownType(org.gedcomx.types.EventType knownType) {
+    this.type = knownType == null ? null : new TypeReference<EventType>(knownType);
+  }
+
+  /**
+   * The date of this event.
+   *
+   * @return The date of this event.
+   */
+  public Date getDate() {
+    return date;
+  }
+
+  /**
+   * The date of this event.
+   *
+   * @param date The date of this event.
+   */
+  public void setDate(Date date) {
+    this.date = date;
+  }
+
+  /**
+   * The place of this event.
+   *
+   * @return The place of this event.
+   */
+  public Place getPlace() {
+    return place;
+  }
+
+  /**
+   * The place of this event.
+   *
+   * @param place The place of this event.
+   */
+  public void setPlace(Place place) {
+    this.place = place;
+  }
+
+  /**
+   * The roles played in this event.
+   *
+   * @return The roles played in this event.
+   */
+  @XmlElement (name="role")
+  @JsonProperty ("roles")
+  @JsonName ("roles")
+  public List<EventRole> getRoles() {
+    return roles;
+  }
+
+  /**
+   * The roles played in this event.
+   *
+   * @param roles The roles played in this event.
+   */
+  public void setRoles(List<EventRole> roles) {
+    this.roles = roles;
+  }
+
+  /**
+   * The source references for this event.
+   *
+   * @return The source references for this event.
+   */
+  @XmlElement (name="source")
+  @JsonProperty ("sources")
+  @JsonName ("sources")
+  public List<SourceReference> getSources() {
+    return sources;
+  }
+
+  /**
+   * The source references for this event.
+   *
+   * @param sources The source references for this event.
+   */
+  @JsonProperty("sources")
+  public void setSources(List<SourceReference> sources) {
+    this.sources = sources;
+  }
+
+  /**
+   * Add a sourceReference.
+   *
+   * @param sourceReference The sourceReference to be added.
+   */
+  public void addSource(SourceReference sourceReference) {
+    if (sourceReference != null) {
+      if (sources == null) {
+        sources = new ArrayList<SourceReference>();
+      }
+      sources.add(sourceReference);
+    }
+  }
+
+}