StudentIndicator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2021 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.stream.Stream;
import org.turro.annotation.ElephantIndicator;
import org.turro.assistant.ParticipationInfo;
import org.turro.contacts.Contact;
import org.turro.contacts.JobBoard;
import org.turro.elephant.db.WhereClause;
import org.turro.entities.Entities;
import org.turro.entities.IElephantEntity;
import org.turro.entities.Students;
import org.turro.jpa.Dao;
import org.turro.matching.GenericMatching;
import org.turro.matching.IMatching;
import org.turro.participation.ParticipationReason;
import org.turro.ranking.GenericRanking;
import org.turro.ranking.IRanking;
import org.turro.students.db.StudentsPU;
import org.turro.students.entities.Challenge;
import org.turro.students.entities.PracticalWork;
import org.turro.students.entities.Response;
import org.turro.zipcode.ZipCodeAPI;
import org.zkoss.lang.Strings;
 
@ElephantIndicator
public class StudentIndicator extends AbstractIndicator {
 
  public StudentIndicator() {
    root = "student";
  }
 
  @Override
  protected void initVariables() {
    addVariable("challenges", true, VariableType.RANKING_VARIABLE);
    addVariable("responses", VariableType.RANKING_VARIABLE);
    addVariable("responsesLike", VariableType.RANKING_VARIABLE);
    addVariable("daysCreation", VariableType.RANKING_VARIABLE);
    addVariable("distance", VariableType.MATCHING_VARIABLE);
  }
 
  @Override
  protected void initExternalVariables() {
    addExternalVariable("commons", "followed");
    addExternalVariable("commons", "like");
    addExternalVariable("commons", "apply");
  }
  
  @Override
  protected Dao createDao() {
    return new StudentsPU();
  }
 
  @Override
  public double getValue(IndicatorVariable variable, Object entity) {
    if((entity instanceof Challenge) && itsMine(variable)) {
      Challenge challenge = (Challenge) entity;
      switch(variable.getName()) {
        case "responses":
          return getResponsesFor(challenge);
        case "responsesLike":
          return getResponsesLikeFor(challenge);
        case "daysCreation":
          return challenge.getCreation() != null ? Duration.between(challenge.getCreation().toInstant(), Instant.now()).toDays() : 9999.9;
      }
    } else if((entity instanceof Contact) && itsMine(variable)) {
      Contact contact = (Contact) entity;
      switch(variable.getName()) {
        case "responses":
          return getResponsesFor(contact);
        case "responsesLike":
          return getResponsesLikeFor(contact);
      }
    } else if((entity instanceof PracticalWork) && itsMine(variable)) {
      PracticalWork practicalWork = (PracticalWork) entity;
      switch(variable.getName()) {
        case "daysCreation":
          return practicalWork.getCreation() != null ? Duration.between(practicalWork.getCreation().toInstant(), Instant.now()).toDays() : 9999.9;
      }
    } else {
      switch(variable.getName()) {
        case "responses":
          return getResponsesFor(entity);
        case "responsesLike":
          return getResponsesLikeFor(entity);
      }
    }
    return 0.0;
  }
 
  @Override
  public double getValue(IndicatorVariable variable, Object entity, String relatedPath) {
    if((entity instanceof PracticalWork) && itsMine(variable)) {
      PracticalWork practicalWork = (PracticalWork) entity;
      IElephantEntity related = Entities.getController(relatedPath);
      if("contact".equals(related.getRoot())) {
        switch(variable.getName()) {
          case "distance":
            if(!Strings.isBlank(practicalWork.getZipCode())) {
              Contact crelated = (Contact) related.getEntity();
              JobBoard jobBoard = crelated.getJobBoard();
              if(jobBoard != null && !Strings.isBlank(jobBoard.getZipCode())) {
                return ZipCodeAPI.distanceOrZero(practicalWork.getZipCode(), jobBoard.getZipCode());
              }
            }
        }
      }
    }
    return 0.0;
  }
 
  @Override
  protected void processRankingVariable(Dao dao, IPreprocessor preprocessor, IndicatorVariable variable, String entityRoot) {
    WhereClause wc = null;
    if("contact".equals(entityRoot)) {
      switch(variable.getName()) {
        case "challenges":
          wc = PreprocessClause.load("Challenge")
                  .setRankingRoot(entityRoot)
                  .setRankingField("concat('/contact/',idChallenger)")
                  .setVariable(variable)
                  .setAggregate("count(id)")
                  .getClause();
          break;
      }
    } else {
      switch(variable.getName()) {
        case "challenges":
          wc = PreprocessClause.load("Challenge")
                  .setRankingRoot(entityRoot)
                  .setRankingField("entityPath")
                  .setVariable(variable)
                  .setAggregate("count(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("contact".equals(relatedRoot)) {
      if("contact".equals(entityRoot)) {
        switch(variable.getName()) {
        }
      } else if("praticalwork".equals(entityRoot)) {
        switch(variable.getName()) {
        }
      } else {
        switch(variable.getName()) {
          case "challenges":
            wc = PreprocessClause.load("Challenge")
                    .setRankingRoot(entityRoot)
                    .setMatchingRoot(relatedRoot)
                    .setRankingField("entityPath")
                    .setMatchingField("idChallenger")
                    .setVariable(variable)
                    .setAggregate("count(c.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 getResponsesFor(Challenge challenge) {
    return Students.getResponseCountFrom(getDao(), challenge);
  }
 
  private double getResponsesFor(Contact contact) {
    double count = 0.0;
    if(contact.getProfile().isStudent()) {
      count += Students.getResponseCountFrom(contact.getId());
    }
    return count;
  }
 
  private double getResponsesFor(Object entity) {
    return Students.getResponseCountFromEntity(entity);
  }
  
  private double getResponsesLikeFor(Challenge challenge) {
    return Students.getResponsesFrom(getDao(), challenge).stream()
            .map(r -> (double) new ParticipationInfo(r, null, ParticipationReason.REASON_LIKE).getCount())
            .reduce(0.0, (subtotal, count) -> subtotal + count);
  }
 
  private double getResponsesLikeFor(Contact contact) {
    double count = 0.0;
    if(contact.getProfile().isStudent()) {
      for(Response response : Students.getResponsesFrom(contact.getId())) {
        count += new ParticipationInfo(response, null, ParticipationReason.REASON_LIKE).getCount();
      }    
    }
    return count;
  }
 
  private double getResponsesLikeFor(Object entity) {
    double count = 0.0;
    for(Response response : Students.getResponsesFromEntity(entity)) {
      count += new ParticipationInfo(response, null, ParticipationReason.REASON_LIKE).getCount();
    }
    return count;
  }
  
}