Event.java

/**
 * Copyright 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 com.fasterxml.jackson.annotation.JsonInclude;
import com.webcohesion.enunciate.metadata.Facet;
import com.webcohesion.enunciate.metadata.qname.XmlQNameEnumRef;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.gedcomx.common.*;
import org.gedcomx.links.Link;
import org.gedcomx.rt.GedcomxConstants;
import org.gedcomx.rt.GedcomxModelVisitor;
import org.gedcomx.rt.json.JsonElementWrapper;
import org.gedcomx.source.SourceDescription;
import org.gedcomx.source.SourceReference;
import org.gedcomx.types.ConfidenceLevel;
import org.gedcomx.types.EventType;

import javax.xml.bind.annotation.*;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;


/**
 * A historical event.
 *
 * @author Ryan Heaton
 */
@XmlRootElement
@JsonElementWrapper (name = "events")
@XmlType ( name = "Event", propOrder = { "date", "place", "roles" } )
@Facet ( GedcomxConstants.FACET_FS_FT_UNSUPPORTED )
@JsonInclude ( JsonInclude.Include.NON_NULL )
public class Event extends Subject implements HasDateAndPlace {

  private URI type;
  private Date date;
  private PlaceReference place;
  private List<EventRole> roles;

  /**
   * 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, PlaceReference place) {
    setKnownType(EventType);
    setDate(date);
    setPlace(place);
  }

  @Override
  public Event id(String id) {
    return (Event) super.id(id);
  }

  @Override
  public Event extensionElement(Object element) {
    return (Event) super.extensionElement(element);
  }

  @Override
  public Event link(String rel, URI href) {
    return (Event) super.link(rel, href);
  }

  @Override
  public Event link(Link link) {
    return (Event) super.link(link);
  }

  @Override
  public Event lang(String lang) {
    return (Event) super.lang(lang);
  }

  @Override
  public Event confidence(URI confidence) {
    return (Event) super.confidence(confidence);
  }

  @Override
  public Event confidence(ConfidenceLevel confidence) {
    return (Event) super.confidence(confidence);
  }

  @Override
  public Event source(SourceReference sourceReference) {
    return (Event) super.source(sourceReference);
  }

  @Override
  public Event source(SourceDescription source) {
    return (Event) super.source(source);
  }

  @Override
  public Event note(Note note) {
    return (Event) super.note(note);
  }

  @Override
  public Event analysis(ResourceReference analysis) {
    return (Event) super.analysis(analysis);
  }

  @Override
  public Event attribution(Attribution attribution) {
    return (Event) super.attribution(attribution);
  }

  @Override
  public Event analysis(Document analysis) {
    return (Event) super.analysis(analysis);
  }

  @Override
  public Event analysis(URI analysis) {
    return (Event) super.analysis(analysis);
  }

  @Override
  public Event extracted(Boolean extracted) {
    return (Event) super.extracted(extracted);
  }

  @Override
  public Event identifier(Identifier identifier) {
    return (Event) super.identifier(identifier);
  }

  @Override
  public Event evidence(EvidenceReference evidence) {
    return (Event) super.evidence(evidence);
  }

  @Override
  public Event sortKey(String sortKey) {
    return (Event) super.sortKey(sortKey);
  }

  public Event evidence(Event evidence) {
    if (evidence.getId() == null) {
      throw new IllegalArgumentException("Unable to add event as evidence: no id.");
    }
    return (Event) super.evidence(new EvidenceReference(URI.create("#" + evidence.getId())));
  }

  @Override
  public Event media(SourceReference media) {
    return (Event) super.media(media);
  }

  @Override
  public Event media(SourceDescription media) {
    return (Event) super.media(media);
  }

  /**
   * The type of the event.
   *
   * @return The type of the event.
   */
  @XmlAttribute
  @XmlQNameEnumRef (org.gedcomx.types.EventType.class)
  public URI getType() {
    return type;
  }

  /**
   * The type of the event.
   *
   * @param type The type of the event.
   */
  public void setType(URI type) {
    this.type = type;
  }

  /**
   * Build up this event with a type.
   *
   * @param type The type of the event.
   * @return this.
   */
  public Event type(URI type) {
    setType(type);
    return this;
  }

  /**
   * Build up this event with a type.
   *
   * @param type The type of the event.
   * @return this.
   */
  public Event type(org.gedcomx.types.EventType type) {
    setKnownType(type);
    return this;
  }

  /**
   * 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 @org.codehaus.jackson.annotate.JsonIgnore
  public org.gedcomx.types.EventType getKnownType() {
    return getType() == null ? null : EventType.fromQNameURI(getType());
  }

  /**
   * Set the type of this event from a known enumeration of event types.
   *
   * @param knownType the event type.
   */
  @JsonIgnore @org.codehaus.jackson.annotate.JsonIgnore
  public void setKnownType(org.gedcomx.types.EventType knownType) {
    setType(knownType == null ? null : knownType.toQNameURI());
  }

  /**
   * The date of this event.
   *
   * @return The date of this event.
   */
  @Override
  public Date getDate() {
    return date;
  }

  /**
   * The date of this event.
   *
   * @param date The date of this event.
   */
  @Override
  public void setDate(Date date) {
    this.date = date;
  }

  /**
   * Build up this event with a date.
   *
   * @param date The date.
   * @return this.
   */
  public Event date(Date date) {
    setDate(date);
    return this;
  }

  /**
   * The place of this event.
   *
   * @return The place of this event.
   */
  @Override
  public PlaceReference getPlace() {
    return place;
  }

  /**
   * The place of this event.
   *
   * @param place The place of this event.
   */
  @Override
  public void setPlace(PlaceReference place) {
    this.place = place;
  }

  /**
   * Build up this event with a place.
   *
   * @param place The place.
   * @return this.
   */
  public Event place(PlaceReference place) {
    setPlace(place);
    return this;
  }

  /**
   * The roles played in this event.
   *
   * @return The roles played in this event.
   */
  @XmlElement (name="role")
  @JsonProperty ("roles") @org.codehaus.jackson.annotate.JsonProperty ("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;
  }

  /**
   * Build up this event with a role.
   *
   * @param role The role.
   * @return this.
   */
  public Event role(EventRole role) {
    addRole(role);
    return this;
  }

  /**
   * Add a role to the list of roles played in this event.
   *
   * @param role The role to be added.
   */
  public void addRole(EventRole role) {
    if (role != null) {
      if (roles == null) {
        roles = new LinkedList<EventRole>();
      }
      roles.add(role);
    }
  }

  /**
   * Accept a visitor.
   *
   * @param visitor The visitor.
   */
  public void accept(GedcomxModelVisitor visitor) {
    visitor.visitEvent(this);
  }

  /**
   * Embed another event.
   *
   * @param event The event to embed.
   */
  public void embed(Event event) {
    this.type = this.type == null ? event.type : this.type;
    this.date = this.date == null ? event.date : this.date;
    this.place = this.place == null ? event.place : this.place;
    if (event.roles != null) {
      this.roles = this.roles == null ? new ArrayList<EventRole>() : this.roles;
      this.roles.addAll(event.roles);
    }
    super.embed(event);
  }
}