KnowledgeBaseQuery.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2016 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.kb;
 
import java.util.Collections;
import java.util.EnumSet;
import java.util.Set;
import org.turro.string.Strings;
import org.turro.action.Contacts;
import org.turro.auth.Authentication;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.Category;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.DossierStatus;
import org.turro.dossier.entity.IssueParticipantRole;
import org.turro.dossier.entity.IssueResolution;
import org.turro.dossier.entity.IssueStatus;
import org.turro.dossier.entity.IssueType;
import org.turro.elephant.db.WhereClause;
import org.turro.jpa.Dao;
import org.turro.plugin.contacts.IContact;
import org.turro.util.Chars;
 
public class KnowledgeBaseQuery {
 
  private String searchValue = "";
  private IContact byParticipant;
  private final IContact realContact;
  private Long dossierId;
  private Dossier dossier;
  private EnumSet<IssueParticipantRole> roles = EnumSet.noneOf(IssueParticipantRole.class);
  private EnumSet<IssueStatus> status = EnumSet.noneOf(IssueStatus.class);
  private EnumSet<IssueResolution> resolutions = EnumSet.noneOf(IssueResolution.class);
  private EnumSet<IssueType> types = EnumSet.noneOf(IssueType.class);
  private Category category;
  private int maxResults = 300;
  private boolean onlyTitle = false;
 
  public KnowledgeBaseQuery() {
    resetToDefault();
    realContact = Authentication.getIContact();
  }
 
  public KnowledgeBaseQuery(IContact contact) {
    resetToDefault();
    realContact = contact;
  }
 
  private void resetToDefault() {
    roles.clear();
    types.clear();
    status.clear();
    resolutions.clear();
  }
 
  public KnowledgeBaseList getResultList() {
    Dao dao = new DossierPU();
    WhereClause wc = createCriteria();
    if(wc != null) {
      return new KnowledgeBaseList(dao.getResultList(wc, maxResults), realContact);
    } else {
      return new KnowledgeBaseList(Collections.EMPTY_LIST, realContact);
    }
  }
  
  public Category getCategory() {
    return category;
  }
 
  public void setCategory(Category category) {
    this.category = category;
  }
 
  public Set<IssueResolution> getResolutions() {
    return resolutions;
  }
 
  public void setResolutions(Set<IssueResolution> resolutions) {
    this.resolutions = resolutions.isEmpty() ? EnumSet.noneOf(IssueResolution.class) : EnumSet.copyOf(resolutions);
  }
 
  public Set<IssueParticipantRole> getRoles() {
    return roles;
  }
 
  public void setRoles(Set<IssueParticipantRole> roles) {
    this.roles = EnumSet.copyOf(roles);
  }
 
  public Set<IssueStatus> getStatus() {
    return status;
  }
 
  public void setStatus(Set<IssueStatus> status) {
    this.status = status.isEmpty() ? EnumSet.noneOf(IssueStatus.class) : EnumSet.copyOf(status);
  }
 
  public Set<IssueType> getTypes() {
    return types;
  }
 
  public void setTypes(Set<IssueType> types) {
    this.types = types.isEmpty() ? EnumSet.noneOf(IssueType.class) : EnumSet.copyOf(types);
  }
 
  public void setType(IssueType type) {
    this.types = EnumSet.of(type);
  }
 
  public int getMaxResults() {
    return maxResults;
  }
 
  public void setMaxResults(int maxResults) {
    this.maxResults = maxResults;
  }
 
  public WhereClause createCriteria() {
    WhereClause wc = new WhereClause();
    wc.addClause("select distinct issue from Issue as issue");
    wc.addClause("left outer join issue.participants participant");
    wc.addClause("left outer join issue.comments comment");
    wc.addClause("where issue.publishable = TRUE");
    
    boolean asParticipant = false;
    
    if(byParticipant != null && byParticipant.isValid()) {
      asParticipant = roles.isEmpty() ||
            roles.contains(IssueParticipantRole.ISSUE_REPORTER) ||
            roles.contains(IssueParticipantRole.ISSUE_RESPONSIBLE) ||
            roles.contains(IssueParticipantRole.ISSUE_QA) ||
            roles.contains(IssueParticipantRole.ISSUE_ASSISTANT);
    }
 
    if(Strings.isEmpty(searchValue)) {
      return null;
    }
 
    try {
      long id = Long.valueOf(searchValue);
      if(id > 0) {
        wc.addClause("and issue.id = :id");
        wc.addNamedValue("id", id);
        return wc;
      }
    } catch(Exception ex) {}
 
    if(onlyTitle) {
      wc.addLikeFields(new String[] {
                "issue.description"
                }, (searchValue == null ? "" : searchValue.replaceAll("\\*", "%")));
    } else {
      wc.addLikeFields(new String[] {
                "issue.description",
                "comment.comment"
                }, (searchValue == null ? "" : searchValue.replaceAll("\\*", "%")));
    }
 
    if(asParticipant) {
      String sep = "";
      wc.addClause("and (");
      if(roles.isEmpty()) {
        wc.addClause("(");
        wc.addClause("participant.idContact = :idContact");
        wc.addNamedValue("idContact", byParticipant.getId());
        wc.addClause(")");
      } else {
        for(IssueParticipantRole ii : roles) {
          wc.addClause(sep);
          sep = "or";
          wc.addClause("(");
          wc.addClause("participant.idContact = :idContact");
          wc.addNamedValue("idContact", byParticipant.getId());
          wc.addClause("and participant.role = :" + ii.toString());
          wc.addNamedValue(ii.toString(), ii);
          wc.addClause(")");
        }
      }
      wc.addClause(")");
    }
    
    if(!status.isEmpty()) {
      String sep = "";
      wc.addClause("and (");
      for(IssueStatus ii : status) {
        wc.addClause(sep);
        sep = "or";
        wc.addClause("issue.status = :" + ii.toString());
        wc.addNamedValue(ii.toString(), ii);
      }
      wc.addClause(")");
    }
    
    if(!resolutions.isEmpty()) {
      String sep = "";
      wc.addClause("and (");
      for(IssueResolution ii : resolutions) {
        wc.addClause(sep);
        sep = "or";
        wc.addClause("issue.resolution = :" + ii.toString());
        wc.addNamedValue(ii.toString(), ii);
      }
      wc.addClause(")");
    }
 
    if(!types.isEmpty()) {
      String sep = "";
      wc.addClause("and (");
      for(IssueType ii : types) {
        wc.addClause(sep);
        sep = "or";
        wc.addClause("issue.type = :" + ii.toString());
        wc.addNamedValue(ii.toString(), ii);
      }
      wc.addClause(")");
    }
 
    if(dossier != null) {
      wc.addClause("and issue.dossier = :dossier");
      wc.addNamedValue("dossier", dossier);
    } else if(dossierId != null && dossierId > 0) {
      wc.addClause("and issue.dossier.id = :dossierId");
      wc.addNamedValue("dossierId", dossierId);
    } else {
      wc.addClause("and issue.dossier.status = :dstatus");
      wc.addNamedValue("dstatus", DossierStatus.DOSSIER_OPENED);
    }
    
    if(category != null) {
      wc.addClause("and (");
      wc.addClause("issue.dossier.category.fullDescription = :fullCatDesc");
      wc.addClause("or issue.dossier.category.fullDescription like concat(:fullCatDesc, '" + Chars.backward().spaced() + "%')");
      wc.addNamedValue("fullCatDesc", category.getFullDescription());
      wc.addClause(")");
    }
    
    wc.addClause("order by issue.modification desc");
    
    return wc;
  }
 
  public Dossier getDossier() {
    return dossier;
  }
 
  public void setDossier(Dossier dossier) {
    this.dossier = dossier;
  }
 
  public Long getDossierId() {
    return dossierId;
  }
 
  public void setDossierId(Long dossierId) {
    this.dossierId = dossierId;
  }
 
  public String getSearchValue() {
    return searchValue;
  }
 
  public void setSearchValue(String searchValue) {
    this.searchValue = searchValue;
  }
 
  public boolean isOnlyTitle() {
    return onlyTitle;
  }
 
  public void setOnlyTitle(boolean onlyTitle) {
    this.onlyTitle = onlyTitle;
  }
 
  public IContact getByParticipant() {
    return byParticipant;
  }
 
  public void setByParticipant(IContact byParticipant) {
    this.byParticipant = byParticipant;
  }
 
  public void setByParticipantId(String id) {
    this.byParticipant = Contacts.getContactById(id);
  }
 
}