DossierIndicator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2020 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.indicator;
 
import java.time.Duration;
import java.time.Instant;
import java.util.Date;
import java.util.stream.Stream;
import org.turro.string.Strings;
import org.turro.annotation.ElephantIndicator;
import org.turro.dossier.db.DossierPU;
import org.turro.dossier.entity.DescriptorValue;
import org.turro.dossier.entity.Dossier;
import org.turro.dossier.entity.IssueParticipantRole;
import org.turro.elephant.db.WhereClause;
import org.turro.jpa.Dao;
import org.turro.matching.ContactSiblings;
import org.turro.matching.GenericMatching;
import org.turro.matching.GenericSiblings;
import org.turro.matching.IMatching;
import org.turro.ranking.GenericRanking;
import org.turro.ranking.IRanking;
 
@ElephantIndicator
public class DossierIndicator extends AbstractIndicator {
 
  public DossierIndicator() {
    root = "dossier";
  }
 
  @Override
  protected void initVariables() {
    addVariable("participation", true, VariableType.BOTH_VARIABLE);
    addVariable("categoryParticipation", true, VariableType.BOTH_VARIABLE);
    addVariable("daysCreation", VariableType.RANKING_VARIABLE);
    addVariable("daysActivity", VariableType.RANKING_VARIABLE);
    addVariable("words", VariableType.RANKING_VARIABLE);
    addVariable("issues", true, VariableType.BOTH_VARIABLE);
    addVariable("issueActivity", true, VariableType.BOTH_VARIABLE);
    addVariable("issueResponsible", true, VariableType.RANKING_VARIABLE, "dossier");
    addVariable("issueReporter", true, VariableType.RANKING_VARIABLE, "dossier");
    addVariable("issueQA", true, VariableType.RANKING_VARIABLE, "dossier");
    addVariable("issueAssistant", true, VariableType.RANKING_VARIABLE, "dossier");
    addVariable("siblings", true, VariableType.MATCHING_VARIABLE);
    addVariable("siblingsCategory", true, VariableType.MATCHING_VARIABLE);
  }
  
  @Override
  protected void initExternalVariables() {
    addExternalVariable("student", "challenges");
    addExternalVariable("student", "responses");
    addExternalVariable("generic", "stars");
    addExternalVariable("generic", "comments");
    addExternalVariable("attach", "attachments");
    addExternalVariable("forum", "topics");
    addExternalVariable("forum", "posts");
    addExternalVariable("commons", "followed");
    addExternalVariable("commons", "seen");
    addExternalVariable("commons", "like");
  }
 
  @Override
  public void generateSiblings() {
    getDao().executeNativeUpdate("truncate table " + ContactSiblings.class.getSimpleName());
    try(Stream<GenericSiblings> siblings = Indicators.getIndicator("generic").getSiblingPaths("contact")) {
      siblings.forEach(s -> getDao().poolObject(s.copyTo(new ContactSiblings()), 1000));
    }
    getDao().finishPool();
  }
  
  @Override
  protected Dao createDao() {
    return new DossierPU();
  }
 
  @Override
  public double getValue(IndicatorVariable variable, Object entity) {
    if((entity instanceof Dossier) && itsMine(variable)) {
      Dossier dossier = (Dossier) entity;
      switch(variable.getName()) {
        case "daysCreation":
          return dossier.getCreation() != null ? Duration.between(dossier.getCreation().toInstant(), Instant.now()).toDays() : 9999.9;
        case "daysActivity":
          return getDaysLastActivity(dossier);
        case "words":
          return countWords(dossier);
      }
    }
    return 0.0;
  }
 
  @Override
  protected void processRankingVariable(Dao dao, IPreprocessor preprocessor, IndicatorVariable variable, String entityRoot) {
    WhereClause wc = null;
    if("dossier".equals(entityRoot)) {
      switch(variable.getName()) {
        case "participation":
          wc = PreprocessClause.load("Participant")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/dossier/',dossier.id)")
                  .setVariable(variable)
                  .setAggregate("count(id)")
                  .getClause();
          break;
        case "categoryParticipation":
          wc = PreprocessClause.load("Dossier d, CategoryParticipant cp")
                  .addCondition("and d.category.fullDescription like concat(cp.category.fullDescription, '%')")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/dossier/',d.id)")
                  .setVariable(variable)
                  .setAggregate("count(cp.id)")
                  .getClause();
          break;
        case "issues":
          wc = PreprocessClause.load("Issue")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/dossier/',dossier.id)")
                  .setVariable(variable)
                  .setAggregate("count(id)")
                  .getClause();
          break;
        case "issueActivity":
          wc = PreprocessClause.load("IssueComment")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/dossier/',issue.dossier.id)")
                  .setVariable(variable)
                  .setAggregate("count(id)")
                  .getClause();
          break;
      }
    } else if("contact".equals(entityRoot)) {
      switch(variable.getName()) {
        case "participation":
          wc = PreprocessClause.load("Participant")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/', idContact)")
                  .setVariable(variable)
                  .setAggregate("count(id)")
                  .getClause();
          break;
        case "categoryParticipation":
          wc = PreprocessClause.load("CategoryParticipant")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/', idContact)")
                  .setVariable(variable)
                  .setAggregate("count(id)")
                  .getClause();
          break;
        case "issueResponsible":
          wc = PreprocessClause.load("IssueParticipant")
                  .addCondition("and role = :role")
                  .addNamedValue("role", IssueParticipantRole.ISSUE_RESPONSIBLE)
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/', idContact)")
                  .setVariable(variable)
                  .setAggregate("count(distinct issue.id)")
                  .getClause();
          break;
        case "issueReporter":
          wc = PreprocessClause.load("IssueParticipant")
                  .addCondition("and role = :role")
                  .addNamedValue("role", IssueParticipantRole.ISSUE_REPORTER)
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/', idContact)")
                  .setVariable(variable)
                  .setAggregate("count(distinct issue.id)")
                  .getClause();
          break;
        case "issueQA":
          wc = PreprocessClause.load("IssueParticipant")
                  .addCondition("and role = :role")
                  .addNamedValue("role", IssueParticipantRole.ISSUE_QA)
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/', idContact)")
                  .setVariable(variable)
                  .setAggregate("count(distinct issue.id)")
                  .getClause();
          break;
        case "issueAssistant":
          wc = PreprocessClause.load("IssueParticipant")
                  .addCondition("and role = :role")
                  .addNamedValue("role", IssueParticipantRole.ISSUE_ASSISTANT)
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/', idContact)")
                  .setVariable(variable)
                  .setAggregate("count(distinct issue.id)")
                  .getClause();
          break;
      }
    }
    if(wc != null) {
      try(Stream<GenericRanking> stream = dao.stream(GenericRanking.class, wc, 1000)) {
        stream.forEach(r -> {
          preprocessor.poolInstance(r.copyTo((IRanking) preprocessor.createInstance()));
        });
        preprocessor.finishPreprocessor();
      }
    }
  }
 
  @Override
  protected void processMatchingVariable(Dao dao, IPreprocessor preprocessor, IndicatorVariable variable, String entityRoot, String relatedRoot) {
    WhereClause wc = null;
    if("dossier".equals(entityRoot)) {
      if("contact".equals(relatedRoot)) {
        switch(variable.getName()) {
          case "participation":
            wc = PreprocessClause.load("Participant p")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("concat('/dossier/', p.dossier.id)")
                    .setMatchingField("p.idContact")
                    .setVariable(variable)
                    .setAggregate("count(p.id)")
                    .getClause();
            break;
          case "categoryParticipation":
            wc = PreprocessClause.load("Dossier d, CategoryParticipant cp")
                    .addCondition("and d.category.fullDescription like concat(cp.category.fullDescription, '%')")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("concat('/dossier/', d.id)")
                    .setMatchingField("cp.idContact")
                    .setVariable(variable)
                    .setAggregate("count(cp.id)")
                    .getClause();
            break;
          case "issues":
            wc = PreprocessClause.load("IssueParticipant p")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("concat('/dossier/', p.issue.dossier.id)")
                    .setMatchingField("p.idContact")
                    .setVariable(variable)
                    .setAggregate("count(distinct p.issue.id)")
                    .getClause();
            break;
          case "issueActivity":
            wc = PreprocessClause.load("IssueComment c")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("concat('/dossier/', c.issue.dossier.id)")
                    .setMatchingField("c.idContact")
                    .setVariable(variable)
                    .setAggregate("count(c.id)")
                    .getClause();
            break;
          case "siblings":
            wc = PreprocessClause.load("Participant p")
                    .addJoin("join ContactSiblings cs on cs.entityPath = concat('/contact/', p.idContact)")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("concat('/dossier/', p.dossier.id)")
                    .setMatchingField("cs.siblingPath")
                    .setMatchingIsPath()
                    .setVariable(variable)
                    .setAggregate("count(p.id)")
                    .getClause();
            break;
          case "siblingsCategory":
            wc = PreprocessClause.load("Dossier d, CategoryParticipant cp, ContactSiblings cs")
                    .addCondition("and d.category.fullDescription like concat(cp.category.fullDescription, '%')")
                    .addCondition("and concat('/contact/', cp.idContact) = cs.entityPath")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("concat('/dossier/', d.id)")
                    .setMatchingField("cs.siblingPath")
                    .setMatchingIsPath()
                    .setVariable(variable)
                    .setAggregate("count(cp.id)")
                    .getClause();
            break;
        }
      }
    }
    if(wc != null) {
      try(Stream<GenericMatching> stream = dao.stream(GenericMatching.class, wc, 1000)) {
        stream.forEach(r -> {
          preprocessor.poolInstance(r.copyTo((IMatching) preprocessor.createInstance()));
        });
        preprocessor.finishPreprocessor();
      }
    }
  }
 
  private double countWords(Dossier dossier) {
    double count = 0;
    if(dossier.getProject() != null) {
      count += Strings.countWords(dossier.getProject().getGoal());
    }
    for(DescriptorValue dv :dossier.getDescriptors()) {
      count += Strings.countWords(dv.getWiki());
    }
    return count;
  }
 
  private double getDaysLastActivity(Dossier dossier) {
    Date last = dossier.getLastActivity();
    return last != null ? Duration.between(last.toInstant(), Instant.now()).toDays() : 0.0;
  }
 
}