net.sourceforge.fenixedu.dataTransferObject.inquiries.InquiryGroupQuestionBean.java Source code

Introduction

Here is the source code for net.sourceforge.fenixedu.dataTransferObject.inquiries.InquiryGroupQuestionBean.java

Source

/**
 * Copyright  2002 Instituto Superior Tcnico
 *
 * This file is part of FenixEdu Core.
 *
 * FenixEdu Core 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 Core 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 Core.  If not, see <http://www.gnu.org/licenses/>.
 */
package net.sourceforge.fenixedu.dataTransferObject.inquiries;

import java.io.Serializable;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;

import net.sourceforge.fenixedu.domain.inquiries.InquiryAnswer;
import net.sourceforge.fenixedu.domain.inquiries.InquiryGroupQuestion;
import net.sourceforge.fenixedu.domain.inquiries.InquiryQuestion;
import net.sourceforge.fenixedu.domain.inquiries.MandatoryCondition;
import net.sourceforge.fenixedu.domain.inquiries.QuestionCondition;
import net.sourceforge.fenixedu.domain.inquiries.StudentInquiryRegistry;

import org.apache.commons.beanutils.BeanComparator;
import org.apache.commons.lang.StringUtils;

import pt.utl.ist.fenix.tools.util.i18n.MultiLanguageString;

public class InquiryGroupQuestionBean implements Serializable {

    private static final long serialVersionUID = 1L;

    private StudentInquiryRegistry studentInquiryRegistry;
    private InquiryGroupQuestion inquiryGroupQuestion;
    private SortedSet<InquiryQuestionDTO> inquiryQuestions;
    private Integer order;
    private boolean joinUp;
    private boolean isVisible;
    private String[] conditionValues;

    public InquiryGroupQuestionBean(InquiryGroupQuestion groupQuestion,
            StudentInquiryRegistry studentInquiryRegistry) {
        initGroup(groupQuestion);
        setStudentInquiryRegistry(studentInquiryRegistry);
        setConditionOptions(studentInquiryRegistry);
        for (InquiryQuestion inquiryQuestion : groupQuestion.getInquiryQuestionsSet()) {
            getInquiryQuestions().add(new InquiryQuestionDTO(inquiryQuestion, studentInquiryRegistry));
        }
    }

    public InquiryGroupQuestionBean(InquiryGroupQuestion inquiryGroupQuestion, InquiryAnswer inquiryAnswer) {
        initGroup(inquiryGroupQuestion);
        setVisible(true);
        for (InquiryQuestion inquiryQuestion : inquiryGroupQuestion.getInquiryQuestionsSet()) {
            getInquiryQuestions().add(new InquiryQuestionDTO(inquiryQuestion, inquiryAnswer));
        }
    }

    public InquiryGroupQuestionBean(InquiryGroupQuestion inquiryGroupQuestion) {
        initGroup(inquiryGroupQuestion);
        setVisible(true);
        for (InquiryQuestion inquiryQuestion : inquiryGroupQuestion.getInquiryQuestionsSet()) {
            getInquiryQuestions().add(new InquiryQuestionDTO(inquiryQuestion));
        }
    }

    private void initGroup(InquiryGroupQuestion groupQuestion) {
        setInquiryGroupQuestion(groupQuestion);
        setInquiryQuestions(new TreeSet<InquiryQuestionDTO>(new BeanComparator("inquiryQuestion.questionOrder")));
        setOrder(groupQuestion.getGroupOrder());
        setJoinUp(false);
    }

    private void setConditionOptions(StudentInquiryRegistry studentInquiryRegistry) {
        setVisible(getInquiryGroupQuestion().isVisible(studentInquiryRegistry));
        setConditionValues(getInquiryGroupQuestion().getConditionValues(studentInquiryRegistry));
    }

    //TODO validao para parte curricular do aluno, qd depender de resultados de respostas tem q se adaptar isto
    public String validate(Set<InquiryBlockDTO> inquiryBlocks) {
        if (isVisible()) {
            Set<InquiryQuestionDTO> questions = getInquiryQuestions();
            boolean isGroupFilledIn = false;
            for (InquiryQuestionDTO inquiryQuestionDTO : questions) {
                InquiryQuestion inquiryQuestion = inquiryQuestionDTO.getInquiryQuestion();
                if (StringUtils.isEmpty(inquiryQuestionDTO.getResponseValue())) {
                    if (inquiryQuestion.getRequired()) {
                        return Boolean.toString(false);
                    }
                    String questionConditionsValidation = validateQuestionConditions(inquiryQuestion,
                            inquiryBlocks);
                    if (questionConditionsValidation != null) {
                        return questionConditionsValidation;
                    }
                } else {
                    isGroupFilledIn = true;
                }
            }
            if (getInquiryGroupQuestion().getRequired() && !isGroupFilledIn) {
                return Boolean.toString(false);
            }
            String groupConditionsValidation = validateGroupConditions(inquiryBlocks, isGroupFilledIn);
            if (groupConditionsValidation != null) {
                return groupConditionsValidation;
            }
        }
        return Boolean.toString(true);
    }

    public String validateMandatoryConditions(Set<InquiryBlockDTO> inquiryBlocks) {
        if (isVisible()) {
            boolean isGroupFilledIn = false;
            for (InquiryQuestionDTO inquiryQuestionDTO : getInquiryQuestions()) {
                InquiryQuestion inquiryQuestion = inquiryQuestionDTO.getInquiryQuestion();
                if (StringUtils.isEmpty(inquiryQuestionDTO.getResponseValue())) {
                    String questionConditionsValidation = validateQuestionConditions(inquiryQuestion,
                            inquiryBlocks);
                    if (questionConditionsValidation != null) {
                        return questionConditionsValidation;
                    }
                } else {
                    isGroupFilledIn = true;
                }
            }
            String groupQuestionsValidation = validateGroupConditions(inquiryBlocks, isGroupFilledIn);
            if (groupQuestionsValidation != null) {
                return groupQuestionsValidation;
            }
        }
        return Boolean.toString(true);
    }

    private String validateQuestionConditions(InquiryQuestion inquiryQuestion, Set<InquiryBlockDTO> inquiryBlocks) {
        for (QuestionCondition questionCondition : inquiryQuestion.getQuestionConditionsSet()) {
            if (questionCondition instanceof MandatoryCondition) {
                MandatoryCondition condition = (MandatoryCondition) questionCondition;
                InquiryQuestionDTO inquiryDependentQuestionBean = getInquiryQuestionBean(
                        condition.getInquiryDependentQuestion(), inquiryBlocks);
                boolean isMandatory = condition.getConditionValuesAsList()
                        .contains(inquiryDependentQuestionBean.getFinalValue());
                if (isMandatory) {
                    return getQuestionIdentifier(inquiryQuestion.getLabel());
                }
            }
        }
        return null;
    }

    private String validateGroupConditions(Set<InquiryBlockDTO> inquiryBlocks, boolean isGroupFilledIn) {
        for (QuestionCondition questionCondition : getInquiryGroupQuestion().getQuestionConditionsSet()) {
            if (questionCondition instanceof MandatoryCondition) {
                MandatoryCondition condition = (MandatoryCondition) questionCondition;
                InquiryQuestionDTO inquiryDependentQuestionBean = getInquiryQuestionBean(
                        condition.getInquiryDependentQuestion(), inquiryBlocks);
                boolean isMandatory = condition.getConditionValuesAsList()
                        .contains(inquiryDependentQuestionBean.getFinalValue());
                if (isMandatory && !isGroupFilledIn) {
                    return getQuestionIdentifier(getInquiryGroupQuestion().getInquiryQuestionHeader().getTitle());
                }
            }
        }
        return null;
    }

    private String getQuestionIdentifier(MultiLanguageString label) {
        if (label != null) {
            int endIndex = label.toString().indexOf(" ");
            return label.toString().substring(0, endIndex);
        }
        return StringUtils.EMPTY;
    }

    private InquiryQuestionDTO getInquiryQuestionBean(InquiryQuestion inquiryQuestion,
            Set<InquiryBlockDTO> inquiryBlocks) {
        for (InquiryBlockDTO blockDTO : inquiryBlocks) {
            for (InquiryGroupQuestionBean groupQuestionBean : blockDTO.getInquiryGroups()) {
                for (InquiryQuestionDTO inquiryQuestionDTO : groupQuestionBean.getInquiryQuestions()) {
                    if (inquiryQuestionDTO.getInquiryQuestion() == inquiryQuestion) {
                        return inquiryQuestionDTO;
                    }
                }
            }
        }
        return null;
    }

    public SortedSet<InquiryQuestionDTO> getInquiryQuestions() {
        return inquiryQuestions;
    }

    public void setInquiryQuestions(SortedSet<InquiryQuestionDTO> inquiryQuestions) {
        this.inquiryQuestions = inquiryQuestions;
    }

    public void setInquiryGroupQuestion(InquiryGroupQuestion inquiryGroupQuestion) {
        this.inquiryGroupQuestion = inquiryGroupQuestion;
    }

    public InquiryGroupQuestion getInquiryGroupQuestion() {
        return inquiryGroupQuestion;
    }

    public void setJoinUp(boolean joinUp) {
        this.joinUp = joinUp;
    }

    public boolean isJoinUp() {
        return joinUp;
    }

    public void setOrder(Integer order) {
        this.order = order;
    }

    public Integer getOrder() {
        return order;
    }

    public void setStudentInquiryRegistry(StudentInquiryRegistry studentInquiryRegistry) {
        this.studentInquiryRegistry = studentInquiryRegistry;
    }

    public StudentInquiryRegistry getStudentInquiryRegistry() {
        return studentInquiryRegistry;
    }

    public void setVisible(boolean isVisible) {
        this.isVisible = isVisible;
    }

    public boolean isVisible() {
        return isVisible;
    }

    public void setConditionValues(String[] conditionValues) {
        this.conditionValues = conditionValues;
    }

    public String[] getConditionValues() {
        return conditionValues;
    }
}