001package org.cpsolver.studentsct.filter;
002
003import org.cpsolver.studentsct.model.Student;
004import org.cpsolver.studentsct.model.Student.StudentPriority;
005
006/**
007 * This student filter only accepts students that are flagged as priority students.
008 * 
009 * @version StudentSct 1.3 (Student Sectioning)<br>
010 *          Copyright (C) 2007 - 2014 Tomáš Müller<br>
011 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
012 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
013 * <br>
014 *          This library is free software; you can redistribute it and/or modify
015 *          it under the terms of the GNU Lesser General Public License as
016 *          published by the Free Software Foundation; either version 3 of the
017 *          License, or (at your option) any later version. <br>
018 * <br>
019 *          This library is distributed in the hope that it will be useful, but
020 *          WITHOUT ANY WARRANTY; without even the implied warranty of
021 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
022 *          Lesser General Public License for more details. <br>
023 * <br>
024 *          You should have received a copy of the GNU Lesser General Public
025 *          License along with this library; if not see
026 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
027 */
028public class PriortyStudentFilter implements StudentFilter  {
029    StudentPriority iPriority = StudentPriority.Priority;
030    boolean iIncludeHigherPriority = true;
031    
032    public PriortyStudentFilter(StudentPriority priority, boolean includeHigherPriority) {
033        iPriority = priority; iIncludeHigherPriority = includeHigherPriority;
034    }
035
036    @Override
037    public boolean accept(Student student) {
038        if (student.isDummy()) return false;
039        if (iIncludeHigherPriority) {
040            return iPriority.isSameOrHigher(student);
041        } else {
042            return iPriority.isSame(student);
043        }
044    }
045    
046    @Override
047    public String getName() {
048        return iPriority.name() + (iIncludeHigherPriority ? "+" : "");
049    }
050
051}