BalanceReportSemesterCreator.java

/*
 * This file is part of the aidGer project.
 *
 * Copyright (C) 2010-2013 The aidGer Team
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package de.aidger.model.reports;

import java.util.ArrayList;
import java.util.List;

import de.aidger.model.models.Course;
import de.aidger.utils.reports.BalanceHelper;
import de.aidger.view.UI;
import siena.SienaException;

/**
 * This class manages the BalanceReportSemesterViewer which calls it. It adds
 * groups to the viewer's panel.
 * 
 * @author aidGer Team
 */
public class BalanceReportSemesterCreator {

    /**
     * The calculation method to be used for this balance report.
     */
    private int calculationMethod = 0;

    /**
     * The vector containing the balanceReportGroupCreators and the names of
     * their groups.
     */
    private final ArrayList<ArrayList<Object>> balanceReportGroupCreators = new ArrayList<ArrayList<Object>>();

    /**
     * The balance helper used to filter the courses in this creator.
     */
    private BalanceHelper balanceHelper = null;

    /**
     * Initializes this BalanceReportSemesterCreator and adds the groups of the
     * given semester.
     * 
     * @param semester
     *            The semester of which the groups shall be added.
     */
    public BalanceReportSemesterCreator(String semester, BalanceFilter filters,
            int calculationMethod) {
        this.calculationMethod = calculationMethod;
        balanceHelper = new BalanceHelper();
        addGroups(semester, filters);
    }

    /**
     * Adds the groups to the semester viewer.
     * 
     * @param semester
     *            The semester of which to add the groups.
     */
    private void addGroups(String semester, BalanceFilter filters) {
        List<Course> courses = null;
        try {
            if (semester != null) {
                courses = (new Course()).getCoursesBySemester(semester);
            } else {
                courses = new ArrayList<Course>();
                List<Course> unsortedCourses = new Course().getAll();
                for (Course course : unsortedCourses) {
                    if (course.getSemester() == null) {
                        courses.add(new Course(course));
                    }
                }
            }
        } catch (SienaException e) {
            UI.displayError(e.toString());
        }
        List<Course> filteredCourses = balanceHelper.filterCourses(courses,
            filters);
        for (Course course : filteredCourses) {
            if (balanceReportGroupCreators.isEmpty()) {
                /*
                 * If there are no groups in the semester yet, add a new one.
                 */
                createGroup(course);
            } else {
                boolean foundGroup = false;
                for (int i = 0; i <= balanceReportGroupCreators.size() - 1; i++) {
                    if ((balanceReportGroupCreators.get(i)).get(1).equals(
                        course.getGroup())) {
                        /*
                         * If the course group already exists in this semester,
                         * add another row to it with this course.
                         */
                        ((BalanceReportGroupCreator) (balanceReportGroupCreators
                            .get(i)).get(0)).addCourse(course);
                        foundGroup = true;
                        break;
                    }
                }
                if (!foundGroup) {
                    /*
                     * If the course group wasn't in the semester yet, add a new
                     * group.
                     */
                    createGroup(course);
                }
            }
        }
    }

    /**
     * Creates a new group and adds it to the balanceReportGroupCreators vector.
     * Also adds the first course of the group to the group.
     * 
     * @param course
     *            The first course, which the group contains.
     */
    private void createGroup(Course course) {
        BalanceReportGroupCreator balanceReportGroupCreator = new BalanceReportGroupCreator(
            course, calculationMethod);
        balanceReportGroupCreators.add(new ArrayList<Object>());
        int i = balanceReportGroupCreators.size() - 1;
        /*
         * Add the group creator of this course's group as the first entry of
         * the vector.
         */
        (balanceReportGroupCreators.get(i)).add(balanceReportGroupCreator);
        /*
         * Add the name of the group as the second entry of the vector.
         */
        (balanceReportGroupCreators.get(i)).add(course.getGroup());
    }

    /**
     * Returns all of the group creators of this semester.
     * 
     * @return The group creators.
     */
    public ArrayList<ArrayList<Object>> getGroupCreators() {
        return balanceReportGroupCreators;
    }
}