    001package org.cpsolver.studentsct.constraint;
    002
    003import java.util.Set;
    004
    005import org.cpsolver.ifs.assignment.Assignment;
    006import org.cpsolver.ifs.model.GlobalConstraint;
    007import org.cpsolver.studentsct.model.CourseRequest;
    008import org.cpsolver.studentsct.model.Enrollment;
    009import org.cpsolver.studentsct.model.Request;
    010
    011
    012/**
    013 * Required restrictions constraint. This global constraint ensures that no enrollment
    014 * is violating a restriction. That is, for each student that has at least one restriction
    015 * on the requested course, the given enrollment must match at least one of the restrictions.
    016 *
    017 * @author  Tomáš Müller
    018 * @version StudentSct 1.3 (Student Sectioning)<br>
    019 *          Copyright (C) 2014 Tomáš Müller<br>
    020 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
    021 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
    022 * <br>
    023 *          This library is free software; you can redistribute it and/or modify
    024 *          it under the terms of the GNU Lesser General Public License as
    025 *          published by the Free Software Foundation; either version 3 of the
    026 *          License, or (at your option) any later version. <br>
    027 * <br>
    028 *          This library is distributed in the hope that it will be useful, but
    029 *          WITHOUT ANY WARRANTY; without even the implied warranty of
    030 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    031 *          Lesser General Public License for more details. <br>
    032 * <br>
    033 *          You should have received a copy of the GNU Lesser General Public
    034 *          License along with this library; if not see
    035 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
    036 */
    037public class RequiredRestrictions extends GlobalConstraint<Request, Enrollment> {
    038
    039    /**
    040     * A given enrollment is conflicting, if there is restriction that is not met.
    041     *
    042     * @param enrollment {@link Enrollment} that is being considered
    043     * @param conflicts all computed conflicting requests are added into this set
    044     */
    045    @Override
    046    public void computeConflicts(Assignment<Request, Enrollment> assignment, Enrollment enrollment, Set<Enrollment> conflicts) {
    047        if (inConflict(assignment, enrollment))
    048            conflicts.add(enrollment);
    049    }
    050
    051    /**
    052     * A given enrollment is conflicting, if there is restriction that is not met.
    053     *
    054     * @param enrollment {@link Enrollment} that is being considered
    055     * @return true, if the enrollment does not follow a reservation that must be used
    056     */
    057    @Override
    058    public boolean inConflict(Assignment<Request, Enrollment> assignment, Enrollment enrollment) {
    059        return enrollment.isCourseRequest() && ((CourseRequest)enrollment.getRequest()).isNotAllowed(enrollment);
    060    }
    061
    062    @Override
    063    public String toString() {
    064        return "RequiredRestrictions";
    065    }
    066}