StudentsEntities.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2019 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.entities;
 
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.turro.action.IEntityCtrl;
import org.turro.action.LinkType;
import org.turro.annotation.ElephantEntity;
import org.turro.attach.www.AttachCtrl;
import org.turro.collections.KeyValueMap;
import org.turro.command.LabelControl;
import org.turro.elephant.db.WhereClause;
import org.turro.file.util.FileAttach;
import org.turro.i18n.I_;
import org.turro.jpa.Dao;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.polls.PollsCtrl;
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.students.entities.TalentCategory;
import org.turro.students.menu.StudentsMenu;
import org.turro.www.commentit.CommentItCtrl;
import org.turro.www.describeit.DescribeItCtrl;
import org.turro.www.starit.StarItCtrl;
import org.turro.www.voteit.VoteItCtrl;
 
@ElephantEntity
public class StudentsEntities extends DefaultElephantEntity {
 
  public StudentsEntities() {
  }
 
  public StudentsEntities(String entityPath) {
    super(entityPath);
  }
 
  public StudentsEntities(Object entity) {
    super(entity);
  }
 
  @Override
  public Object getEntity() {
    if(entity == null) {
      if(getPath() != null) {
        if(isValidLongEntity()) {
          if(null != path.getRoot()) switch (path.getRoot()) {
            case "challenge":
              entity = getDao().find(Challenge.class, path.getNodeAs(1, Long.class));
              break;
            case "response":
              entity = getDao().find(Response.class, path.getNodeAs(1, Long.class));
              break;
            case "practicalwork":
              entity = getDao().find(PracticalWork.class, path.getNodeAs(1, Long.class));
              break;
            case "talent-category":
              entity = getDao().find(TalentCategory.class, path.getNodeAs(1, Long.class));
              break;
            default:
              break;
          }
        }
      }
    }
    return entity;
  }
 
  @Override
  public String getName() {
    if(getEntity() != null) {
      if(entity instanceof Challenge) {
        return ((Challenge) entity).getQuestion();
      } else if(entity instanceof Response) {
        return ((Response) entity).getChallenge().getQuestion();
      } else if(entity instanceof PracticalWork) {
        return ((PracticalWork) entity).getTitle();
      } else if(entity instanceof TalentCategory) {
        return ((TalentCategory) entity).getName();
      }
    }
    return null;
  }
 
  @Override
  public String getLabel() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "challenge":
          return I_.get("Challenge");
        case "response":
          return I_.get("Answer");
        case "practicalwork":
          return I_.get("Practical work");
        case "talent-category":
          return I_.get("Talent category");
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getDescription() {
    return null;
  }
 
  @Override
  public Object getLabelCtrl() {
    if(getEntity() != null && !(entity instanceof TalentCategory)) {
      return new LabelControl(getEntity());
    }
    return null;
  }
 
  @Override
  public String getImage() {
    if(getPath() != null) {
      String root = path.getRoot();
      if(null != root) switch (root) {
        case "challenge":
          return "/_zul/images/challenge.png";
        case "response":
          return "/_zul/images/response.png";
        case "practicalwork":
          return "/_zul/images/operator.png";
        case "talent-category":
          return "/_zul/images/group.png";
        default:
          break;
      }
    }
    return null;
  }
 
  @Override
  public String getHierarchicalPath() {
    return getPath();
  }
 
  @Override
  public IElephantEntity getParent() {
    if(getEntity() != null) {
      if(entity instanceof Challenge) {
        return ((Challenge) entity).getEntity();
      } else if(entity instanceof Response) {
        return Entities.getController(((Response) entity).getChallenge());
      }
    }
    return null;
  }
 
  @Override
  public List<IElephantEntity> getChildren() {
    if(getEntity() != null) {
      if(entity instanceof Challenge) {
        return new EntityListAdapter(((Challenge) entity).getResponses());
      }
    }
    return Collections.EMPTY_LIST;
  }
 
  @Override
  public String getExtendedPath() {
    return StudentsPU.getObjectExtendedPath(getEntity());
  }
 
  @Override
  public File getFile() {
    return null;
  }
 
  @Override
  public boolean showPath() {
    if(getPath() != null) {
      String root = path.getRoot();
    }
    return false;
  }
 
  @Override
  public boolean showEntity() {
    if(getEntity() != null) {
      if(entity instanceof Challenge) {
        StudentsMenu.showChallenge(((Challenge) entity).getId());
        return true;
      }
    }
    return false;
  }
 
  @Override
  public boolean canEdit(IContact contact) {
    if(getEntity() != null) {
    }
    return false;
  }
 
  @Override
  public boolean canPublish(IContact contact) {
    if(getEntity() != null) {
      return true;
    }
    return false;
  }
 
  @Override
  public boolean canShowInContext(IContact contact, Object relatedEntity) {
    return true;
  }
 
  @Override
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    list.addAll(searchChallenges(search, maxResults, kvm));
    list.addAll(searchCategories(search, maxResults, kvm));
    return list;
  }
 
  @Override
  public Collection getEntitites(String root, String search, int maxResults, KeyValueMap kvm) {
    ArrayList<Object> list = new ArrayList<>();
    if(null != root) switch (root) {
      case "challenge":
        list.addAll(searchChallenges(search, maxResults, kvm));
        break;
      case "talent-category":
        list.addAll(searchCategories(search, maxResults, kvm));
        break;
      default:
        break;
    }
    return list;
  }
 
  @Override
  public Object configureCtrl(Object ctrl, IContact contact) {
    if(ctrl instanceof VoteItCtrl) {
      VoteItCtrl ictrl = (VoteItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof StarItCtrl) {
      StarItCtrl ictrl = (StarItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof CommentItCtrl) {
      CommentItCtrl ictrl = (CommentItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof AttachCtrl) {
      AttachCtrl ictrl = (AttachCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      ictrl.setPublicOnly(true);
      return ictrl;
    } else if(ctrl instanceof FileAttach) {
      FileAttach ictrl = (FileAttach) ctrl;
      return ictrl;
    } else if(ctrl instanceof DescribeItCtrl) {
      DescribeItCtrl ictrl = (DescribeItCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof PollsCtrl) {
      PollsCtrl ictrl = (PollsCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    } else if(ctrl instanceof IEntityCtrl) {
      IEntityCtrl ictrl = (IEntityCtrl) ctrl;
      ictrl.setEntityPath(getPath());
      return ictrl;
    }
    return ctrl;
  }
 
  @Override
  public String getExtendedWebPath() {
    return null;
  }
 
  @Override
  public String getUserContext() {
    return "challenge".equals(getRoot()) ?
            "/user/" + getLinkRoot() + "s" :
            "/user/my" + getLinkRoot() + "s";
  }
 
  @Override
  protected Dao createDao() {
    return new StudentsPU();
  }
 
  @Override
  protected boolean itsMine(Object entity) {
    return (entity instanceof Challenge) || (entity instanceof Response) ||
           (entity instanceof PracticalWork) || (entity instanceof TalentCategory);
  }
 
  @Override
  public Collection<String> getAllowedRoots() {
    return Arrays.asList("challenge", "response", "practicalwork", "talent-category");
  }
 
  @Override
  protected IElephantEntity createInstance(String entityPath) {
    return new StudentsEntities(entityPath);
  }
 
  @Override
  protected IElephantEntity createInstance(Object entity) {
    return new StudentsEntities(entity);
  }
 
  @Override
  protected Path createPath() {
    return new Path(StudentsPU.getObjectPath(entity));
  }
 
  private List<Object> searchChallenges(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from Challenge c");
    wc.addClause("where c.question like :search");
    wc.addClause("order by c.question");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  private List<Object> searchCategories(String search, int maxResults, KeyValueMap kvm) {
    WhereClause wc = new WhereClause();
    wc.addClause("select c from TalentCategory c");
    wc.addClause("where c.name like :search");
    wc.addClause("order by c.name");
    wc.addNamedValue("search", "%" + search + "%");
    return getDao().getResultList(wc, maxResults);
  }
 
  @Override
  public String getEntityUrl(LinkType type, String contextPath) {
    if("response".equals(getRoot())) {
      return getParent().getEntityUrl(type, contextPath);
    }
    return super.getEntityUrl(type, contextPath);
  }
 
}