/**
* Copyright © 2002 Instituto Superior Técnico
*
* This file is part of FenixEdu Academic.
*
* FenixEdu Academic is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FenixEdu Academic 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FenixEdu Academic. If not, see <http://www.gnu.org/licenses/>.
*/
package org.fenixedu.academic.service.services.person;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.TreeSet;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.Predicate;
import org.apache.commons.lang.StringUtils;
import org.fenixedu.academic.domain.Degree;
import org.fenixedu.academic.domain.Department;
import org.fenixedu.academic.domain.Person;
import org.fenixedu.academic.domain.StudentCurricularPlan;
import org.fenixedu.academic.domain.Teacher;
import org.fenixedu.academic.domain.accounting.PaymentCode;
import org.fenixedu.academic.domain.degree.DegreeType;
import org.fenixedu.academic.domain.person.IDDocumentType;
import org.fenixedu.academic.domain.person.RoleType;
import org.fenixedu.academic.domain.student.Registration;
import org.fenixedu.academic.domain.student.Student;
import org.fenixedu.commons.StringNormalizer;
import pt.ist.fenixframework.Atomic;
import pt.ist.fenixframework.FenixFramework;
import pt.utl.ist.fenix.tools.util.CollectionPager;
public class SearchPerson implements Serializable {
public static class SearchParameters implements Serializable {
private String email, username, documentIdNumber;
private IDDocumentType idDocumentType;
private String name;
private String[] nameWords;
private RoleType role;
private Degree degree;
private Department department;
private DegreeType degreeType;
private Boolean activePersons;
private Integer studentNumber;
private String paymentCode;
public SearchParameters() {
}
public SearchParameters(String name, String email, String username, String documentIdNumber, String idDocumentType,
String roleType, String degreeTypeString, String degreeId, String departmentId, Boolean activePersons,
Integer studentNumber) {
this(name, email, username, documentIdNumber, idDocumentType, roleType, degreeTypeString, degreeId, departmentId,
activePersons, studentNumber, (String) null);
}
public SearchParameters(String name, String email, String username, String documentIdNumber, String idDocumentType,
String roleType, String degreeTypeString, String degreeId, String departmentId, Boolean activePersons,
Integer studentNumber, String paymentCode) {
this();
setActivePersons(activePersons);
setName(name);
setEmail(email);
setUsername(username);
setDocumentIdNumber(documentIdNumber);
if (!StringUtils.isEmpty(idDocumentType)) {
setIdDocumentType(IDDocumentType.valueOf(idDocumentType));
}
setStudentNumber(studentNumber);
setPaymentCode(paymentCode);
if (roleType != null && roleType.length() > 0) {
role = RoleType.valueOf(roleType);
}
if (!StringUtils.isEmpty(degreeId)) {
degree = FenixFramework.getDomainObject(degreeId);
}
if (degreeTypeString != null && degreeTypeString.length() > 0) {
degreeType = DegreeType.valueOf(degreeTypeString);
}
if (!StringUtils.isEmpty(departmentId)) {
department = FenixFramework.getDomainObject(departmentId);
}
}
public boolean emptyParameters() {
return StringUtils.isEmpty(this.email) && StringUtils.isEmpty(this.username)
&& StringUtils.isEmpty(this.documentIdNumber) && this.role == null && this.degree == null
&& this.department == null && this.degreeType == null && this.nameWords == null && this.studentNumber == null
&& this.idDocumentType == null && StringUtils.isEmpty(this.getPaymentCode());
}
private static String[] getNameWords(String name) {
String[] nameWords = null;
if (name != null && !StringUtils.isEmpty(name.trim())) {
nameWords = StringNormalizer.normalize(name).trim().split(" ");
}
return nameWords;
}
public Degree getDegree() {
return degree;
}
public DegreeType getDegreeType() {
return degreeType;
}
public Department getDepartment() {
return department;
}
public String getDocumentIdNumber() {
return documentIdNumber;
}
public IDDocumentType getIdDocumentType() {
return idDocumentType;
}
public String getEmail() {
return email;
}
public String[] getNameWords() {
return nameWords;
}
public String getName() {
return name;
}
public RoleType getRole() {
return role;
}
public String getUsername() {
return username;
}
public Boolean getActivePersons() {
return activePersons;
}
public Integer getStudentNumber() {
return studentNumber;
}
public void setEmail(String email) {
this.email = (email != null && !email.equals("")) ? StringNormalizer.normalize(email.trim()) : null;
}
public void setUsername(String username) {
this.username = (username != null && !username.equals("")) ? StringNormalizer.normalize(username.trim()) : null;
}
public void setDocumentIdNumber(String documentIdNumber) {
this.documentIdNumber = (documentIdNumber != null && !documentIdNumber.equals("")) ? documentIdNumber.trim() : null;
}
public void setIdDocumentType(IDDocumentType idDocumentType) {
this.idDocumentType = idDocumentType;
}
public void setName(String name) {
this.name = (name != null && !name.equals("")) ? name : null;
this.nameWords = (name != null && !name.equals("")) ? getNameWords(name) : null;
}
public void setRole(RoleType role) {
this.role = role;
}
public void setDegree(Degree degree) {
this.degree = degree;
}
public void setDepartment(Department department) {
this.department = department;
}
public void setDegreeType(DegreeType degreeType) {
this.degreeType = degreeType;
}
public void setActivePersons(Boolean activePersons) {
this.activePersons = activePersons;
}
public void setStudentNumber(Integer studentNumber) {
this.studentNumber = studentNumber;
}
public String getPaymentCode() {
return this.paymentCode;
}
public void setPaymentCode(final String paymentCode) {
this.paymentCode = paymentCode;
}
}
public CollectionPager<Person> run(SearchParameters searchParameters, Predicate predicate) {
if (searchParameters.emptyParameters()) {
return new CollectionPager<Person>(new ArrayList<Person>(), 25);
}
final Collection<Person> persons;
if (searchParameters.getUsername() != null && searchParameters.getUsername().length() > 0) {
final Person person = Person.readPersonByUsername(searchParameters.getUsername());
persons = new ArrayList<Person>();
if (person != null) {
persons.add(person);
}
} else if (searchParameters.getDocumentIdNumber() != null && searchParameters.getDocumentIdNumber().length() > 0) {
persons = Person.findPersonByDocumentID(searchParameters.getDocumentIdNumber());
} else if (searchParameters.getStudentNumber() != null) {
final Student student = Student.readStudentByNumber(searchParameters.getStudentNumber());
persons = new ArrayList<Person>();
if (student != null) {
persons.add(student.getPerson());
}
} else if (searchParameters.getEmail() != null && searchParameters.getEmail().length() > 0) {
final Person person = Person.readPersonByEmailAddress(searchParameters.getEmail());
persons = new ArrayList<Person>();
if (person != null) {
persons.add(person);
}
} else if (searchParameters.getName() != null) {
persons = new ArrayList<Person>();
persons.addAll(Person.findPerson(searchParameters.getName()));
final RoleType roleBd = searchParameters.getRole();
if (roleBd != null) {
for (final Iterator<Person> peopleIterator = persons.iterator(); peopleIterator.hasNext();) {
final Person person = peopleIterator.next();
if (!person.hasRole(roleBd)) {
peopleIterator.remove();
}
}
final Department department = searchParameters.getDepartment();
if (department != null) {
for (final Iterator<Person> peopleIterator = persons.iterator(); peopleIterator.hasNext();) {
final Person person = peopleIterator.next();
final Teacher teacher = person.getTeacher();
if (teacher == null || teacher.getDepartment() != department) {
peopleIterator.remove();
}
}
}
}
} else if (!StringUtils.isEmpty(searchParameters.getPaymentCode())) {
persons = new ArrayList<Person>();
PaymentCode paymentCode = PaymentCode.readByCode(searchParameters.getPaymentCode());
if (paymentCode != null && paymentCode.getPerson() != null) {
persons.add(paymentCode.getPerson());
}
} else {
persons = new ArrayList<Person>(0);
}
TreeSet<Person> result = new TreeSet<Person>(Person.COMPARATOR_BY_NAME_AND_ID);
result.addAll(CollectionUtils.select(persons, predicate));
return new CollectionPager<Person>(result, 25);
}
public static class SearchPersonPredicate implements Predicate {
private final SearchParameters searchParameters;
public SearchPersonPredicate(SearchParameters searchParameters) {
this.searchParameters = searchParameters;
}
@Override
public boolean evaluate(Object arg0) {
Person person = (Person) arg0;
return verifyActiveState(searchParameters.getActivePersons(), person)
&& verifySimpleParameter(person.getDocumentIdNumber(), searchParameters.getDocumentIdNumber())
&& verifyUsernameEquality(searchParameters.getUsername(), person)
&& verifyNameEquality(searchParameters.getNameWords(), person)
&& verifyAnyEmailAddress(searchParameters.getEmail(), person)
&& verifyDegreeType(searchParameters.getDegree(), searchParameters.getDegreeType(), person)
&& verifyStudentNumber(searchParameters.getStudentNumber(), person)
&& verifyPaymentCodes(searchParameters.getPaymentCode(), person);
}
protected boolean verifyAnyEmailAddress(final String email, final Person person) {
return email == null || email.trim().isEmpty() || person.hasEmailAddress(email);
}
protected boolean verifyIdDocumentType(IDDocumentType idDocumentType, Person person) {
return (idDocumentType == null || person.getIdDocumentType() == idDocumentType);
}
protected boolean verifyStudentNumber(Integer studentNumber, Person person) {
return (studentNumber == null || (person.getStudent() != null && person.getStudent().getNumber()
.equals(studentNumber)));
}
protected boolean verifyActiveState(Boolean activePersons, Person person) {
return (activePersons == null || person.hasRole(RoleType.PERSON).equals(activePersons));
}
protected boolean verifyUsernameEquality(String usernameToSearch, Person person) {
if (usernameToSearch == null) {
return true;
}
String normalizedUsername = StringNormalizer.normalize(usernameToSearch.trim());
String normalizedAlias = StringNormalizer.normalize(person.getUsername());
return normalizedAlias.indexOf(normalizedUsername) != 1;
}
protected boolean verifyDegreeType(final Degree degree, final DegreeType degreeType, final Person person) {
return degreeType == null || verifyDegreeType(degree, person.getStudentByType(degreeType));
}
private boolean verifyDegreeType(final Degree degree, final Registration registrationByType) {
return registrationByType != null && (degree == null || verifyDegree(degree, registrationByType));
}
private boolean verifyDegree(final Degree degree, final Registration registrationByType) {
final StudentCurricularPlan studentCurricularPlan = registrationByType.getActiveStudentCurricularPlan();
return (studentCurricularPlan != null && degree == studentCurricularPlan.getDegreeCurricularPlan().getDegree());
}
protected boolean verifySimpleParameter(String parameter, String searchParameter) {
return (searchParameter == null) || (parameter != null && simpleNnormalizeAndCompare(parameter, searchParameter));
}
private boolean verifyParameter(String parameter, String searchParameter) {
return (searchParameter == null) || (parameter != null && normalizeAndCompare(parameter, searchParameter));
}
private boolean simpleNnormalizeAndCompare(String parameter, String searchParameter) {
String personParameter = parameter;
return (personParameter.indexOf(searchParameter) == -1) ? false : true;
}
private boolean normalizeAndCompare(String parameter, String searchParameter) {
String personParameter = StringNormalizer.normalize(parameter.trim());
return (personParameter.indexOf(searchParameter) == -1) ? false : true;
}
protected static boolean verifyNameEquality(String[] nameWords, Person person) {
return person.verifyNameEquality(nameWords);
}
protected static boolean verifyPaymentCodes(String paymentCode, final Person person) {
return StringUtils.isEmpty(paymentCode) || person.getPaymentCodeBy(paymentCode) != null;
}
public SearchParameters getSearchParameters() {
return searchParameters;
}
}
// Service Invokers migrated from Berserk
private static final SearchPerson serviceInstance = new SearchPerson();
@Atomic
public static CollectionPager<Person> runSearchPerson(SearchParameters searchParameters, Predicate predicate) {
return serviceInstance.run(searchParameters, predicate);
}
}