EquivalencyPlanEntryCurriculumModuleWrapper.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.domain.studentCurricularPlan.equivalencyPlan;

import java.text.Collator;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Set;
import java.util.TreeSet;

import org.fenixedu.academic.domain.DomainObjectUtil;
import org.fenixedu.academic.domain.EquivalencePlanEntry;
import org.fenixedu.academic.domain.degreeStructure.DegreeModule;
import org.fenixedu.academic.domain.studentCurriculum.CurriculumModule;

public class EquivalencyPlanEntryCurriculumModuleWrapper {

    private static final Comparator<EquivalencyPlanEntryCurriculumModuleWrapper> COMPARATOR_BY_DEGREE_MODULE_NAME =
            new Comparator<EquivalencyPlanEntryCurriculumModuleWrapper>() {

                @Override
                public int compare(EquivalencyPlanEntryCurriculumModuleWrapper o1, EquivalencyPlanEntryCurriculumModuleWrapper o2) {
                    final DegreeModule d1 = o1.getCurriculumModule().getDegreeModule();
                    final DegreeModule d2 = o2.getCurriculumModule().getDegreeModule();
                    final int c = Collator.getInstance().compare(d1.getName(), d2.getName());
                    return c == 0 ? DomainObjectUtil.COMPARATOR_BY_ID.compare(d1, d2) : c;
                }

            };

    private final CurriculumModule curriculumModule;

    private final Set<EquivalencePlanEntry> equivalencePlanEntriesToApply = new HashSet<EquivalencePlanEntry>();

    private final Set<EquivalencePlanEntry> removedEquivalencePlanEntries = new HashSet<EquivalencePlanEntry>();

    private final Set<EquivalencyPlanEntryCurriculumModuleWrapper> children =
            new TreeSet<EquivalencyPlanEntryCurriculumModuleWrapper>(COMPARATOR_BY_DEGREE_MODULE_NAME);

    public EquivalencyPlanEntryCurriculumModuleWrapper(final CurriculumModule curriculumModule) {
        this.curriculumModule = curriculumModule;
    }

    public CurriculumModule getCurriculumModule() {
        return curriculumModule;
    }

    public Set<EquivalencePlanEntry> getEquivalencePlanEntriesToApply() {
        return equivalencePlanEntriesToApply;
    }

    public Set<EquivalencePlanEntry> getRemovedEquivalencePlanEntries() {
        return removedEquivalencePlanEntries;
    }

    public Set<EquivalencyPlanEntryCurriculumModuleWrapper> getChildren() {
        return children;
    }

    public void addEquivalencePlanEntriesToApply(final EquivalencePlanEntry equivalencePlanEntry) {
        equivalencePlanEntriesToApply.add(equivalencePlanEntry);
    }

    public void addRemovedEquivalencePlanEntries(final EquivalencePlanEntry equivalencePlanEntry) {
        removedEquivalencePlanEntries.add(equivalencePlanEntry);
    }

    public void addChildren(final EquivalencyPlanEntryCurriculumModuleWrapper curriculumModule) {
        children.add(curriculumModule);
    }

}