Dossier.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.dossier.entity;
 
import java.time.Instant;
import java.util.*;
import javax.persistence.*;
import org.turro.string.Strings;
import org.turro.action.Contacts;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.dossier.DescriptorSet;
import org.turro.dossier.dossier.DescriptorValueSet;
import org.turro.dossier.dossier.DossierParticipationsList;
import org.turro.dossier.dossier.DossierStageWrapper;
import org.turro.dossier.dossier.FieldValueComparator;
import org.turro.dossier.dossier.FieldValueMap;
import org.turro.dossier.dossier.ParticipantSet;
import org.turro.dossier.dossier.WorthSet;
import org.turro.dossier.dw.DossierDWReport;
import org.turro.dossier.gantt.DossierGanttWrapper;
import org.turro.dossier.graph.html.IssueGraphModel;
import org.turro.jpa.Dao;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.plugin.contacts.IContact;
import org.turro.reflection.MappingSet;
import org.turro.related.RelatedItem;
import org.turro.util.Chars;
 
@Entity
@Table(indexes={
  @Index(name="StatusIndex", columnList="status"),
  @Index(name="PathIndex", columnList="uniquePath"),
})
public class Dossier implements java.io.Serializable, IDaoEntity {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private Long id;
 
  @Temporal(value = javax.persistence.TemporalType.TIMESTAMP)
  private java.util.Date creation;
 
  @Lob
  @Column(length=4096)
  private String description;
  
  private DossierType type;
  
  private DossierStatus status;
  
  @OneToOne(cascade = CascadeType.ALL, orphanRemoval=true)
  private Project project;
 
  @ManyToOne
  private Category category;
  
  private String uniquePath;
 
  private boolean publishable;
  
  @Lob
  @Column(length=4096)
  private String searching;
  
  @OneToMany(mappedBy = "dossier", fetch = FetchType.EAGER, cascade=CascadeType.ALL, orphanRemoval=true)
  private Set<DossierVersion> versions = new TreeSet<DossierVersion>();
 
  @OneToMany(mappedBy = "dossier", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  @OrderBy(value="name")
  private Set<Participant> participants = new HashSet<Participant>();
 
  @OneToMany(mappedBy = "dossier", fetch = FetchType.EAGER, cascade=CascadeType.ALL, orphanRemoval=true)
  @org.hibernate.annotations.SortComparator(FieldValueComparator.class)
  private Set<FieldValue> fieldValues = new TreeSet<FieldValue>(new FieldValueComparator());
 
  @OneToMany(mappedBy = "dossier", fetch = FetchType.LAZY, orphanRemoval=true)
  @OrderBy(value="issueDate")
  private Set<Issue> issues = new HashSet<Issue>();
 
  @OneToMany(mappedBy = "dossier", fetch = FetchType.LAZY, cascade=CascadeType.ALL, orphanRemoval=true)
  private Set<DescriptorValue> descriptors = new HashSet<DescriptorValue>();
 
  @OneToMany(mappedBy = "dossier", fetch = FetchType.LAZY, orphanRemoval=true)
  private Set<WorthValue> worths = new HashSet<WorthValue>();
 
  @OneToMany(mappedBy = "dossier", fetch = FetchType.LAZY, orphanRemoval=true)
  private Set<DossierOffer> offers = new HashSet<DossierOffer>();
 
  private final transient RelatedItem related = new RelatedItem();
 
  public Category getCategory() {
    return category;
  }
 
  public void setCategory(Category category) {
    this.category = category;
  }
 
  public String getUniquePath() {
    return uniquePath;
  }
 
  public void setUniquePath(String uniquePath) {
    this.uniquePath = uniquePath;
  }
 
  public Project getProject() {
    return project;
  }
 
  public void setProject(Project project) {
    this.project = project;
  }
 
  public Date getCreation() {
    return creation;
  }
 
  public void setCreation(Date creation) {
    this.creation = creation;
  }
 
  public String getDescription() {
    return description;
  }
 
  public void setDescription(String description) {
    this.description = description;
  }
 
  public Set<FieldValue> getFieldValues() {
    return fieldValues;
  }
 
  public void setFieldValues(Set<FieldValue> fieldValues) {
    this.fieldValues = fieldValues;
  }
 
  public Long getId() {
    return id;
  }
 
  public void setId(Long id) {
    this.id = id;
  }
 
  public Set<Issue> getIssues() {
    return issues;
  }
 
  public void setIssues(Set<Issue> issues) {
    this.issues = issues;
  }
 
  public Set<Participant> getParticipants() {
    Dao dao = new DossierPU();
    if(id != null && id > 0 && dao.isNotLoaded(participants)) {
      participants = dao.lazyLoader(Dossier.class, this, "participants").participants;
    }
    return participants;
  }
 
  public void setParticipants(Set<Participant> participants) {
    this.participants = participants;
  }
 
  public RelatedItem getRelated() {
    return related;
  }
 
  public DossierStatus getStatus() {
    return status;
  }
 
  public void setStatus(DossierStatus status) {
    this.status = status;
  }
 
  public boolean isPublishable() {
    return publishable;
  }
 
  public void setPublishable(boolean publishable) {
    this.publishable = publishable;
  }
 
  public DossierType getType() {
    return type;
  }
 
  public void setType(DossierType type) {
    this.type = type;
  }
 
  public Set<DossierVersion> getVersions() {
    return versions;
  }
 
  public String getSearching() {
    return searching;
  }
 
  public void setSearching(String searching) {
    this.searching = searching;
  }
 
  public void setVersions(Set<DossierVersion> versions) {
    this.versions = versions;
  }
 
  public Set<DescriptorValue> getDescriptors() {
    Dao dao = new DossierPU();
    if(id != null && id > 0 && dao.isNotLoaded(descriptors)) {
      descriptors = dao.lazyLoader(Dossier.class, this, "descriptors").descriptors;
    }
    return descriptors;
  }
 
  public void setDescriptors(Set<DescriptorValue> descriptors) {
    this.descriptors = descriptors;
  }
 
  public Set<WorthValue> getWorths() {
    Dao dao = new DossierPU();
    if(id != null && id > 0 && dao.isNotLoaded(worths)) {
      worths = dao.lazyLoader(Dossier.class, this, "worths").worths;
    }
    return worths;
  }
 
  public void setWorths(Set<WorthValue> worths) {
    this.worths = worths;
  }
 
  public Set<DossierOffer> getOffers() {
    Dao dao = new DossierPU();
    if(id != null && id > 0 && dao.isNotLoaded(offers)) {
      offers = dao.lazyLoader(Dossier.class, this, "offers").offers;
    }
    return offers;
  }
 
  public void setOffers(Set<DossierOffer> offers) {
    this.offers = offers;
  }
 
  /* Versions helper */
  
  public Set<DossierVersion> getActiveVersions() {
    TreeSet<DossierVersion> tdv = new TreeSet<>();
    for(DossierVersion dv : versions) {
      if(dv.isActive()) {
        tdv.add(dv);
      }
    }
    return tdv;
  }
  
  /* Issues Helper */
  
  public Collection<Issue> getAllIssues() {
    return getAllIssues(false);
  }
  
  public Collection<Issue> getAllPublishableIssues() {
    return getAllIssues(true);
  }
  
  public Collection<Issue> getAllIssues(boolean publicOnly) {
    Dao dao = new DossierPU();
    return dao.getResultList(
            "select issue from Issue as issue " +
            "where issue.dossier = ? " +
            (publicOnly ? "and issue.publishable = TRUE " : "") +
            "order by issue.issueDate",
            new Object[] {
              this
            }
    );
  }
  
  public Collection<Issue> getOpenIssues() {
    return getOpenIssues(false);
  }
  
  public Collection<Issue> getOpenPublishableIssues() {
    return getOpenIssues(true);
  }
  
  public Collection<Issue> getOpenIssues(boolean publicOnly) {
    Dao dao = new DossierPU();
    return dao.getResultList(
            "select issue from Issue as issue " +
            "where issue.dossier = ? " +
            (publicOnly ? "and issue.publishable = TRUE " : "") +
            "and (issue.status = ? " +
            "or issue.status = ? " +
            "or issue.status = ? " +
            "or issue.status = ? " +
            "or issue.status = ? " +
            "or issue.status = ?) " +
            "order by issue.issueDate",
            new Object[] {
              this,
              IssueStatus.STATUS_NEW, 
              IssueStatus.STATUS_INCOMPLETE, 
              IssueStatus.STATUS_STARTED, 
              IssueStatus.STATUS_REOPENED, 
              IssueStatus.STATUS_REUNION, 
              IssueStatus.STATUS_FROZEN
            }
    );
  }
  
  public Collection<Issue> getClosedIssues() {
    return getClosedIssues(false);
  }
  
  public Collection<Issue> getClosedPublishableIssues() {
    return getClosedIssues(false);
  }
  
  public Collection<Issue> getClosedIssues(boolean publicOnly) {
    Dao dao = new DossierPU();
    return dao.getResultList(
            "select issue from Issue as issue " +
            "where issue.dossier = ? " +
            (publicOnly ? "and issue.publishable = TRUE " : "") +
            "and (issue.status = ? " +
            "or issue.status = ? " +
            "or issue.status = ?) " +
            "order by issue.issueDate",
            new Object[] {
              this,
              IssueStatus.STATUS_RESOLVED, 
              IssueStatus.STATUS_VERIFIED, 
              IssueStatus.STATUS_CLOSED
            }
    );
  }
  
  public Collection<Issue> getIssuesByType(IssueType type) {
    Dao dao = new DossierPU();
    return dao.getResultList(
            "select i " +
            "from Issue i " +
            "where i.dossier = ? " +
            "and i.type = ?",
            new Object[] { this, type });
  }
  
  /* Grouping */
  
  public Collection<String> getGroupings() {
    Dao dao = new DossierPU();
    return dao.getResultList(
            "select distinct i.grouping " +
            "from Issue i " +
            "where i.dossier = ?",
            new Object[] { this });
  }
  
  public Collection<Issue> getIssuesByGrouping(String grouping) {
    Dao dao = new DossierPU();
    return dao.getResultList(
            "select i " +
            "from Issue i " +
            "where i.dossier = ? " +
            "and i.grouping = ?",
            new Object[] { this, grouping });
  }
  
  /* End grouping */
  
  /* Participants helper */
 
  private transient ParticipantSet<IDossierParticipant> _participants;
  
  public ParticipantSet<IDossierParticipant> getFullParticipants() {
    if(_participants == null) {
      _participants = new ParticipantSet<>(getParticipants());
      if(category != null) {
        _participants.addAll(category.getFullParticipants());
      }
    }
    return _participants;
  }
 
  public void resetParticipants() {
    _participants = null;
  }
  
  public boolean existsParticipant(IDossierParticipant participant) {
    for(Participant p : getParticipants()) {
      if(!Strings.isBlank(p.getIdContact()) && p.getIdContact().equals(participant.getIdContact())) {
        return true;
      }
    }
    return false;
  }
 
  public List<IDossierParticipant> getRoleParticipants() {
    return new ParticipantSet<IDossierParticipant>(getParticipants()).stream().filter(p -> p.hasRole()).toList();
  }
 
  public List<IDossierParticipant> getFullRoleParticipants() {
    return getFullParticipants().stream().filter(p -> p.hasRole()).toList();
  }
 
  /* End participants */
  
  /* Participations helper */
 
  private transient DossierParticipationsList _participations;
  
  public DossierParticipationsList getParticipationsList() {
    if(_participations == null) {
      _participations = new DossierParticipationsList(this);
    }
    return _participations;
  }
 
  public void resetParticipations() {
    _participations = null;
  }
  
  /* End participations */
  
  public Collection<String> getPossibleDiscriminators() {
    Dao dao = new DossierPU();
    return dao.getResultList("select distinct discriminator from Participant");
  }
 
  /* Fields helper */
 
  transient Map fieldMap = null;
 
  public Map<String, Object> getFieldMap() {
    if(fieldMap == null) {
      fieldMap = new FieldValueMap(this);
    }
    return fieldMap;
  }
 
  /* Description helper */
 
  public String getFullDescription() {
    return getFullDescription(true);
  }
 
  public String getFullDescription(boolean withSubject) {
    Participant subject = withSubject ? getSubject() : null;
    StringBuilder sb = new StringBuilder();
    if(subject != null) {
      sb.append(subject.getName());
      sb.append(Chars.forward().spaced());
    }
    sb.append(description);
    if(category != null) {
      sb.append(Chars.forward().spaced());
      sb.append(category.getFullDescription());
    }
    return sb.toString();
  }
 
  public String getExtraDescription() {
    String s = "";
    for(FieldValue fv : getFieldValues()) {
      if(!Strings.isEmpty(fv.getValue()) && fv.getFieldDef().isDescription()) {
        if(s.length() != 0) s += ", ";
        s += fv.getObjectString(false).trim();
      }
    }
    return s;
  }
 
  public String getPublishableDescription() {
    String s = "";
    for(FieldValue fv : getFieldValues()) {
      if(!Strings.isEmpty(fv.getValue()) && 
              fv.getFieldDef().isDescription() &&
              fv.getFieldDef().isPublishable()) {
        if(s.length() != 0 && !s.endsWith(", ")) s += ", ";
        s += fv.getObjectString(false).trim();
      }
    }
    return s;
  }
 
  public String getLabeledPublishableDescription() {
    String s = "";
    for(FieldValue fv : getFieldValues()) {
      if(!Strings.isEmpty(fv.getValue()) && 
              fv.getFieldDef().isDescription() &&
              fv.getFieldDef().isPublishable()) {
        if(s.length() != 0 && !s.endsWith(", ")) s += ", ";
        s += fv.getLabeledObjectString().trim();
      }
    }
    return s;
  }
 
  /* Owner helper */
  
  public Participant addOwner(IContact contact) {
    if(contact == null) return null;
    Participant p = new Participant();
    p.setDossier(this);
    p.setCreation(new Date());
    p.setIdContact(contact.getId());
    p.setName(contact.getName());
    p.setRole(ParticipantRole.PARTICIPANT_OWNER);
    getParticipants().add(p);
    return p;
  }
 
  public void addSubject(IContact contact) {
    if(contact == null) return;
    Participant p = new Participant();
    p.setDossier(this);
    p.setCreation(new Date());
    p.setIdContact(contact.getId());
    p.setName(contact.getName());
    p.setRole(ParticipantRole.PARTICIPANT_SUBJECT);
    getParticipants().add(p);
  }
 
  public Participant addAssistant(IContact contact) {
    if(contact == null) return null;
    Participant p = new Participant();
    p.setDossier(this);
    p.setCreation(new Date());
    p.setIdContact(contact.getId());
    p.setName(contact.getName());
    p.setRole(ParticipantRole.PARTICIPANT_ASSISTANT);
    getParticipants().add(p);
    return p;
  }
 
  public Participant addOrReturnAssistant(IContact contact) {
    for(Participant p : getParticipants()) {
      if(p.getIdContact().equals(contact.getId())) {
        return p;
      }
    }
    return addAssistant(contact);
  }
 
  public boolean isDirectOwner(IContact contact) {
    for(IDossierParticipant p : getDirectOwners()) {
      if(p.getRole().equals(ParticipantRole.PARTICIPANT_OWNER)) {
        if(contact.getId().equals(p.getIdContact())) {
          return true;
        }
      }
    }
    return category.isDirectOwner(contact);
  }
  
  public boolean isBranchAdmin(IContact contact) {
    for(IDossierParticipant p : getParticipationsList()) {
      if(p.getRole().equals(ParticipantRole.PARTICIPANT_OWNER) && 
              contact.getId().equals(p.getIdContact()) &&
              p.isAdmin()) {
        return true;
      }
    }
    return false;
  }
  
  public List<IDossierParticipant> getDirectOwners() {
    List<IDossierParticipant> list = new ArrayList<>();
    for(Participant p : getParticipants()) {
      if(p.getRole().equals(ParticipantRole.PARTICIPANT_OWNER)) {
        list.add(p);
      }
    }
    list.addAll(category.getDirectOwners());
    return list;
  }
  
  public Participant getSubject() {
    for(Participant p : getParticipants()) {
      if(p.getRole().equals(ParticipantRole.PARTICIPANT_SUBJECT)) {
        return p;
      }
    }
    return null;
  }
 
  public void setSubject(IContact subject) {
    Participant p = getSubject();
    if(p != null) {
      p.setIdContact(subject.getId());
    } else {
      addSubject(subject);
    }
  }
 
  public IContact getDefaultResponsible() {
    for(Participant p : getParticipants()) {
      if(p.getRole().equals(ParticipantRole.PARTICIPANT_OWNER)) {
        return Contacts.getContactById(p.getIdContact());
      }
    }
    if(getCategory() != null) {
      IContact contact = getCategory().getDefaultResponsible(ParticipantRole.PARTICIPANT_OWNER);
      if(contact != null && contact.isValid()) {
        return contact;
      }
    }
    for(Participant p : getParticipants()) {
      if(p.getRole().equals(ParticipantRole.PARTICIPANT_ASSISTANT)) {
        return Contacts.getContactById(p.getIdContact());
      }
    }
    if(getCategory() != null) {
      IContact contact = getCategory().getDefaultResponsible(ParticipantRole.PARTICIPANT_ASSISTANT);
      if(contact != null && contact.isValid()) {
        return contact;
      }
    }
    return null;
  }
  
  /* Descriptors helpers */
  
  transient DescriptorSet _descriptors;
  
  public DescriptorSet getDescriptorSet() {
    if(_descriptors == null) {
      _descriptors = new DescriptorSet(this);
    } 
    return _descriptors;
  }
 
  transient DescriptorValueSet _descriptorValues;
  
  public DescriptorValueSet getDescriptorValueSet() {
    if(_descriptorValues == null) {
      _descriptorValues = new DescriptorValueSet(this);
    } 
    return _descriptorValues;
  }
 
  /* Worth helpers */
  
  transient WorthSet _worths;
  
  public WorthSet getWorthSet() {
    if(_worths == null) {
      _worths = new WorthSet(this);
    } 
    return _worths;
  }
 
  /* Report helper */
  
  transient DossierDWReport _report;
  
  public DossierDWReport getReport() {
    if(_report == null) {
      _report = new DossierDWReport();
      _report.setReportValues(this);
    }
    return _report;
  }
 
  public String getDossierURL() {
    String path = null;
    if(getStatus().isOpen()) {
      path = (String) getFieldMap().get("dossierOpenUrl");
    } else {
      path = (String) getFieldMap().get("dossierClosedUrl");
    }
    return path == null ? null : path + getId();
  }
 
  /* Milestones */
  
  public IssueGraphModel getIssueGraphModel(boolean onlyMilestones, boolean onlyOpen) {
    return new IssueGraphModel(this, onlyMilestones, onlyOpen);
  }
  
  public DossierGanttWrapper getIssueGantt() {
    return new DossierGanttWrapper(this);
  }
  
  /* IDaoEntity */
  
  @Override
  public Object entityId() {
    return id;
  }
 
  @Override
  public boolean isEmpty() {
    return Strings.isBlank(description) || category == null;
  }
    
  /* Helpers */
  
  public boolean isKnowledgeBase() {
    if(category != null) {
      return category.isKnowledgeBase();
    }
    return false;
  }
  
  public DossierStageWrapper getStageWrapper() {
    if(status == null) {
      status = DossierStatus.DOSSIER_OPENED;
    }
    return new DossierStageWrapper(this);
  }
  
  /* Dates */
  
  public Date getLastActivity() {
    Date last = getCreation();
    if(project != null) {
      last = assignLast(project.getStartDate(), last);
      last = assignLast(project.getApprovedDate(), last);
      last = assignLast(project.getChangePhase(), last);
      last = assignLast(project.getEndDate(), last);
      last = assignLast(project.getOppositingEndDate(), last);
    }
    return last;
  }
  
  private Date assignLast(Date date, Date last) {
    if(last == null || (date != null && date.after(last) && !Instant.now().isAfter(date.toInstant()))) {
      return date;
    }
    return last;
  }
 
  /* XML Serializer */
  
  public MappingSet getSerializerMappings() {
    MappingSet set = new MappingSet();
    set.addMapping(Dossier.class, 1, 
            new String[] { "id", "description", "creation", "type", "status", "publishable" }, 
            new String[] { "category", "versions", "participants", "fieldValues", 
              "project", "descriptors" });
    set.addMapping(Category.class, 2,
            new String[] { "id", "description" }, 
            null);
    set.addMapping(DossierVersion.class, 2,
            new String[] { "versionId", "releaseDate", "active" }, 
            null);
    set.addMapping(Participant.class, 2,
            new String[] { "name", "idContact", "role", "showAllAttachments", "showParticipants", 
              "showAllIssues", "receiveAllEmails", "bindingVote", "discriminator", "driver", "coordinator", 
              "beneficiary", "offerer", "research", "funding", "support", "consortium", "admin" }, 
            null);
    set.addMapping(FieldValue.class, 2,
            new String[] { "value" }, 
            null);
    set.addMapping(Project.class, 2,
            new String[] { "projectCode", "projectTitle", "phase", "estimatedBudget", 
              "assignedBudget", "startDate", "approvedDate", "oppositingEndDate", "endDate", "goal" }, 
            new String[] { "matchCriteria" });
    set.addMapping(GrantMatchCriteria.class, 3,
            new String[] { "hiring", "idi", "investment", "startUp" }, 
            null);
    set.addMapping(DescriptorValue.class, 2,
            new String[] { "wiki" }, 
            null);
    return set;
  }
 
}