CreateExecutionCoursesForDegreeCurricularPlansAndExecutionPeriod.java

/**
 * 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.manager;

import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;

import org.fenixedu.academic.domain.CompetenceCourse;
import org.fenixedu.academic.domain.CurricularCourse;
import org.fenixedu.academic.domain.DegreeCurricularPlan;
import org.fenixedu.academic.domain.ExecutionCourse;
import org.fenixedu.academic.domain.ExecutionSemester;
import org.fenixedu.academic.domain.exceptions.DomainException;
import org.fenixedu.academic.util.Pair;

import pt.ist.fenixframework.Atomic;
import pt.ist.fenixframework.FenixFramework;

/**
 * @author - Shezad Anavarali (shezad@ist.utl.pt)
 * 
 */
public class CreateExecutionCoursesForDegreeCurricularPlansAndExecutionPeriod {

    @Atomic
    public static HashMap<String, Pair<Integer, String>> run(String[] degreeCurricularPlansIDs, String executionPeriodID) {
        final ExecutionSemester executionSemester = FenixFramework.getDomainObject(executionPeriodID);
        if (executionSemester == null) {
            throw new DomainException("error.selection.noPeriod");
        }
        final Set<String> existentsExecutionCoursesSiglas = readExistingExecutionCoursesSiglas(executionSemester);

        if (degreeCurricularPlansIDs.length == 0) {
            throw new DomainException("error.selection.noDegree");
        }

        HashMap<String, Pair<Integer, String>> numberExecutionCoursesPerDCP = new HashMap<String, Pair<Integer, String>>();
        for (final String degreeCurricularPlanID : degreeCurricularPlansIDs) {
            int numberExecutionCourses = 0;
            StringBuilder curricularCodes = new StringBuilder();
            final DegreeCurricularPlan degreeCurricularPlan = FenixFramework.getDomainObject(degreeCurricularPlanID);
            final Collection<CurricularCourse> curricularCourses = degreeCurricularPlan.getCurricularCoursesSet();
            for (final CurricularCourse curricularCourse : curricularCourses) {

                if (curricularCourse.isOptionalCurricularCourse()
                        || curricularCourse.getActiveDegreeModuleScopesInExecutionPeriod(executionSemester).isEmpty()) {
                    continue;
                }
                if (curricularCourse.getExecutionCoursesByExecutionPeriod(executionSemester).isEmpty()) {
                    final String originalCode = getCodeForCurricularCourse(curricularCourse);
                    if (originalCode != null) {
                        final String sigla = getUniqueSigla(existentsExecutionCoursesSiglas, originalCode);
                        final ExecutionCourse executionCourse =
                                new ExecutionCourse(curricularCourse.getName(), sigla, executionSemester, null);
                        curricularCourse.addAssociatedExecutionCourses(executionCourse);
                        numberExecutionCourses++;
                        curricularCodes.append(curricularCourse.getAcronym() + ", ");
                    }
                }
            }
            if (curricularCodes.length() > 0) {
                curricularCodes.setLength(curricularCodes.length() - 2); // trim last ", "
            }
            numberExecutionCoursesPerDCP.put(degreeCurricularPlanID,
                    new Pair<Integer, String>(Integer.valueOf(numberExecutionCourses), curricularCodes.toString()));
        }

        return numberExecutionCoursesPerDCP;
    }

    private static String getCodeForCurricularCourse(final CurricularCourse curricularCourse) {
        if (curricularCourse.getAcronym() != null) {
            return curricularCourse.getAcronym();
        }
        final CompetenceCourse competenceCourse = curricularCourse.getCompetenceCourse();
        if (competenceCourse != null) {
            return competenceCourse.getCode();
        }
        if (curricularCourse.getCode() != null) {
            return curricularCourse.getCode();
        }
        return null;
    }

    public static String getUniqueSigla(Set<String> existentsExecutionCoursesSiglas, String sigla) {
        if (existentsExecutionCoursesSiglas.contains(sigla.toUpperCase())) {
            int suffix = 1;
            while (existentsExecutionCoursesSiglas.contains((sigla + "-" + ++suffix).toUpperCase())) {
                ;
            }
            sigla = sigla + "-" + suffix;
        }
        existentsExecutionCoursesSiglas.add(sigla.toUpperCase());

        return sigla;
    }

    private static Set<String> readExistingExecutionCoursesSiglas(final ExecutionSemester executionSemester) {
        final Set<String> existingExecutionCoursesSiglas = new HashSet<String>();
        for (ExecutionCourse executionCourse : executionSemester.getAssociatedExecutionCoursesSet()) {
            existingExecutionCoursesSiglas.add(executionCourse.getSigla().toUpperCase());
        }
        return existingExecutionCoursesSiglas;
    }

}