001package org.cpsolver.exam.reports;
002
003import java.text.DecimalFormat;
004import java.util.List;
005
006import org.cpsolver.exam.model.Exam;
007import org.cpsolver.exam.model.ExamModel;
008import org.cpsolver.exam.model.ExamPlacement;
009import org.cpsolver.exam.model.ExamStudent;
010import org.cpsolver.ifs.assignment.Assignment;
011import org.cpsolver.ifs.util.CSVFile;
012import org.cpsolver.ifs.util.CSVFile.CSVField;
013
014
015/**
016 * Export student direct conflicts between pairs of exams into a CSV file. <br>
017 * <br>
018 * Usage:
019 * <pre><code>
020 * &nbsp;&nbsp;&nbsp;&nbsp;new ExamStudentDirectConflicts(model).report().save(file);
021 * </code></pre>
022 * <br>
023 * 
024 * @author  Tomáš Müller
025 * @version ExamTT 1.3 (Examination Timetabling)<br>
026 *          Copyright (C) 2008 - 2014 Tomáš Müller<br>
027 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
028 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
029 * <br>
030 *          This library is free software; you can redistribute it and/or modify
031 *          it under the terms of the GNU Lesser General Public License as
032 *          published by the Free Software Foundation; either version 3 of the
033 *          License, or (at your option) any later version. <br>
034 * <br>
035 *          This library is distributed in the hope that it will be useful, but
036 *          WITHOUT ANY WARRANTY; without even the implied warranty of
037 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
038 *          Lesser General Public License for more details. <br>
039 * <br>
040 *          You should have received a copy of the GNU Lesser General Public
041 *          License along with this library; if not see
042 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
043 */
044public class ExamStudentDirectConflicts {
045    private ExamModel iModel = null;
046
047    /**
048     * Constructor
049     * 
050     * @param model
051     *            examination timetabling model
052     */
053    public ExamStudentDirectConflicts(ExamModel model) {
054        iModel = model;
055    }
056
057    /**
058     * generate report
059     * @param assignment current assignment
060     * @return resultant report
061     */
062    public CSVFile report(Assignment<Exam, ExamPlacement> assignment) {
063        CSVFile csv = new CSVFile();
064        csv.setHeader(new CSVField[] { new CSVField("Exam 1"), new CSVField("Enrl 1"), new CSVField("Period 1"),
065                new CSVField("Date 1"), new CSVField("Time 1"), new CSVField("Exam 2"), new CSVField("Enrl 2"),
066                new CSVField("Direct"), new CSVField("Direct [%]") });
067        DecimalFormat df = new DecimalFormat("0.0");
068        for (Exam ex1 : iModel.variables()) {
069            ExamPlacement p1 = assignment.getValue(ex1);
070            if (p1 == null)
071                continue;
072            for (Exam ex2 : iModel.variables()) {
073                if (ex1.getId() >= ex2.getId())
074                    continue;
075                ExamPlacement p2 = assignment.getValue(ex2);
076                if (p2 == null || !p2.getPeriod().equals(p1.getPeriod()))
077                    continue;
078                List<ExamStudent> students = ex1.getJointEnrollments().get(ex2);
079                if (students == null || students.isEmpty())
080                    continue;
081                csv.addLine(new CSVField[] {
082                        new CSVField(ex1.getName()),
083                        new CSVField(ex1.getStudents().size()),
084                        new CSVField(p1.getPeriod().getIndex() + 1),
085                        new CSVField(p1.getPeriod().getDayStr()),
086                        new CSVField(p1.getPeriod().getTimeStr()),
087                        new CSVField(ex2.getName()),
088                        new CSVField(ex2.getStudents().size()),
089                        new CSVField(students.size()),
090                        new CSVField(df.format(100.0 * students.size()
091                                / Math.min(ex1.getStudents().size(), ex2.getStudents().size()))) });
092            }
093        }
094        return csv;
095    }
096}