Poll.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2018 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.elephant.entities.db;
 
import java.util.Date;
import java.util.List;
import java.util.Objects;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Lob;
import javax.persistence.Temporal;
import org.turro.string.Strings;
import org.turro.assistant.AssistantConstants;
import org.turro.assistant.AssistantSet;
import org.turro.assistant.Assistants;
import org.turro.auth.Authentication;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.ElephantContext;
import org.turro.elephant.db.ElephantPU;
import org.turro.elephant.db.WhereClause;
import org.turro.elephant.impl.util.Parser;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.parser.wiki.WikiCompiler;
import org.turro.plugin.contacts.IContact;
import org.turro.util.CompareUtil;
 
@Entity
public class Poll implements java.io.Serializable, IDaoEntity, Comparable<Poll> {
 
  @Id
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  @Column(name="IDENTIFIER")
  private Long id;
  
  private String title, location, entityPath;
  
  @Temporal(javax.persistence.TemporalType.TIMESTAMP)
  private Date deadline;
 
  @Lob
  @Column(length=4096)
  private String wiki, text;
  
  private int maxPerOption, maxVotedOptions;
  
  private boolean showParticipants, showVotes, allowInsertions, allowNegatives;
  
  private String optionClass, optionStart, optionEnd;
 
  public Long getId() {
    return id;
  }
 
  public void setId(Long id) {
    this.id = id;
  }
 
  public String getTitle() {
    return title;
  }
 
  public void setTitle(String title) {
    this.title = title;
  }
 
  public String getLocation() {
    return location;
  }
 
  public void setLocation(String location) {
    this.location = location;
  }
 
  public String getEntityPath() {
    return entityPath;
  }
 
  public void setEntityPath(String entityPath) {
    this.entityPath = entityPath;
  }
 
  public Date getDeadline() {
    return deadline;
  }
 
  public void setDeadline(Date deadline) {
    this.deadline = deadline;
  }
 
  public String getWiki() {
    return wiki;
  }
 
  public void setWiki(String wiki) {
    this.wiki = wiki;
    text = WikiCompiler.source(wiki).html();
  }
 
  public String getText() {
    return text == null ? null : text.replaceAll("\\{site\\}", ElephantContext.getSiteName());
  }
 
  public void setText(String text) {
    this.text = text;
  }
 
  public int getMaxPerOption() {
    return maxPerOption;
  }
 
  public void setMaxPerOption(int maxPerOption) {
    this.maxPerOption = maxPerOption;
  }
 
  public int getMaxVotedOptions() {
    return maxVotedOptions;
  }
 
  public void setMaxVotedOptions(int maxVotedOptions) {
    this.maxVotedOptions = maxVotedOptions;
  }
 
  public boolean isShowParticipants() {
    return showParticipants;
  }
 
  public void setShowParticipants(boolean showParticipants) {
    this.showParticipants = showParticipants;
  }
 
  public boolean isShowVotes() {
    return showVotes;
  }
 
  public void setShowVotes(boolean showVotes) {
    this.showVotes = showVotes;
  }
 
  public boolean isAllowInsertions() {
    return allowInsertions;
  }
 
  public void setAllowInsertions(boolean allowInsertions) {
    this.allowInsertions = allowInsertions;
  }
 
  public boolean isAllowNegatives() {
    return allowNegatives;
  }
 
  public void setAllowNegatives(boolean allowNegatives) {
    this.allowNegatives = allowNegatives;
  }
 
  public String getOptionClass() {
    return optionClass;
  }
 
  public void setOptionClass(String optionClass) {
    this.optionClass = optionClass;
  }
 
  public String getOptionStart() {
    return optionStart;
  }
 
  public void setOptionStart(String optionStart) {
    this.optionStart = optionStart;
  }
 
  public String getOptionEnd() {
    return optionEnd;
  }
 
  public void setOptionEnd(String optionEnd) {
    this.optionEnd = optionEnd;
  }
  
  /* IDaoEntity */
  
  @Override
  public Object entityId() {
    return id;
  }
 
  @Override
  public boolean isEmpty() {
    return Strings.isBlank(title) || deadline == null; 
  }
  
  /* Helpers */
  
  public boolean canVote() {
    return !isEmpty() && deadline.after(new Date());
  }
  
  public IElephantEntity getEntity() {
    return Entities.getController(entityPath);
  }
  
  public List<PollOption> getOptions() {
    WhereClause wc = new WhereClause();
    wc.addClause("select opt from PollOption opt");
    wc.addClause("where opt.idPoll = :idPoll");
    wc.addNamedValue("idPoll", this.getId());
    wc.addClause("order by opt.ordering, opt.pollData");
    return new ElephantPU().getResultList(wc);
  }
  
  public List<PollVote> getVotes() {
    WhereClause wc = new WhereClause();
    wc.addClause("select vote from PollVote vote");
    wc.addClause("where vote.idPoll = :idPoll");
    wc.addNamedValue("idPoll", this.getId());
    wc.addClause("order by vote.idPoll, vote.pollData");
    return new ElephantPU().getResultList(wc);
  }
  
  public List<PollVote> getVotes(IContact contact) {
    WhereClause wc = new WhereClause();
    wc.addClause("select vote from PollVote vote");
    wc.addClause("where vote.idPoll = :idPoll");
    wc.addNamedValue("idPoll", this.getId());
    wc.addClause("and vote.idContact = :contact");
    wc.addNamedValue("contact", contact.getId());
    wc.addClause("order by vote.idPoll, vote.pollData");
    return new ElephantPU().getResultList(wc);
  }
  
  /* Participants */
  
  private transient AssistantSet assistantSet;
  
  public AssistantSet getParticipants() {
    if(assistantSet == null) {
      assistantSet = new AssistantSet();
      Assistants.addAssistants(entityPath, true, assistantSet, AssistantConstants.all());
    }
    return assistantSet;
  }
  
  public boolean isParticipant() {
    return isParticipant(Authentication.getIContact());
  }
 
  public boolean isParticipant(IContact contact) {
    return getParticipants().exists(contact);
  }
 
  public boolean isFullyVoted() {
    return isFullyVoted(Authentication.getIContact());
  }
  
  public boolean isFullyVoted(IContact contact) {
    for(PollOption po : getOptions()) {
      if(po.getPollVote(contact) == null) {
        return false;
      }
    }
    return true;
  }
  
  /* Set */
  
  @Override
  public int hashCode() {
    int hash = 5;
    hash = 17 * hash + Objects.hashCode(this.id);
    return hash;
  }
 
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final Poll other = (Poll) obj;
    if (!Objects.equals(this.id, other.id)) {
      return false;
    }
    return true;
  }
 
  @Override
  public int compareTo(Poll o) {
    int result = CompareUtil.compare(o.deadline, deadline);
    if(result == 0) {
      CompareUtil.compare(o.id, id);
    }
    return result;
  }
  
}