org.fenixedu.qubdocs.academic.documentRequests.providers.EnrolmentsDataProvider.java Source code

Java tutorial

Introduction

Here is the source code for org.fenixedu.qubdocs.academic.documentRequests.providers.EnrolmentsDataProvider.java

Source

/**
 * This file was created by Quorum Born IT <http://www.qub-it.com/> and its 
 * copyright terms are bind to the legal agreement regulating the FenixEdu@ULisboa 
 * software development project between Quorum Born IT and Servios Partilhados da
 * Universidade de Lisboa:
 *  - Copyright  2015 Quorum Born IT (until any Go-Live phase)
 *  - Copyright  2015 Universidade de Lisboa (after any Go-Live phase)
 *
 * Contributors: anil.mamede@qub-it.com
 *
 * 
 * This file is part of FenixEdu QubDocs.
 *
 * FenixEdu QubDocs 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 QubDocs 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 QubDocs.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.fenixedu.qubdocs.academic.documentRequests.providers;

import java.util.Collection;
import java.util.HashSet;
import java.util.Locale;
import java.util.Set;
import java.util.TreeSet;

import org.fenixedu.academic.domain.Enrolment;
import org.fenixedu.academic.domain.ExecutionYear;
import org.fenixedu.academic.domain.student.Registration;
import org.fenixedu.academic.domain.student.curriculum.ICurriculumEntry;

import com.google.common.collect.Sets;
import com.qubit.terra.docs.util.IDocumentFieldsData;
import com.qubit.terra.docs.util.IFieldsExporter;
import com.qubit.terra.docs.util.IReportDataProvider;

public class EnrolmentsDataProvider implements IReportDataProvider {
    protected static final String KEY = "enrolments";
    protected static final String KEY_FOR_LIST = "enrolmentsList";
    protected static final String KEY_FOR_NORMAL_ENROLMENTS = "normalEnrolmentsList";
    protected static final String KEY_FOR_EXTRA_ENROLMENTS = "extraEnrolmentsList";
    protected static final String KEY_FOR_STANDALONE_ENROLMENTS = "standaloneEnrolmentsList";
    protected static final String KEY_HAS_EXTRA_ENROLMENTS = "hasExtraEnrolments";
    protected static final String KEY_HAS_STANDALONE_ENROLMENTS = "hasStandaloneEnrolments";

    protected Registration registration;
    protected ExecutionYear executionYear;
    protected Locale locale;
    protected TreeSet<CurriculumEntry> curriculumEntries;
    protected TreeSet<CurriculumEntry> normalCurriculumEntries;
    protected TreeSet<CurriculumEntry> extraCurriculumEntries;
    protected TreeSet<CurriculumEntry> standaloneCurriculumEntries;

    protected CurriculumEntryRemarksDataProvider remarksDataProvider = null;

    public EnrolmentsDataProvider(final Registration registration, final ExecutionYear executionYear,
            final Locale locale) {
        this.registration = registration;
        this.executionYear = executionYear;
        this.locale = locale;
        this.remarksDataProvider = new CurriculumEntryRemarksDataProvider(registration);
    }

    @Override
    public void registerFieldsAndImages(IDocumentFieldsData documentFieldsData) {
        documentFieldsData.registerCollectionAsField(KEY_FOR_LIST);
        documentFieldsData.registerCollectionAsField(KEY_FOR_NORMAL_ENROLMENTS);
        documentFieldsData.registerCollectionAsField(KEY_FOR_EXTRA_ENROLMENTS);
        documentFieldsData.registerCollectionAsField(KEY_FOR_STANDALONE_ENROLMENTS);
    }

    @Override
    public boolean handleKey(final String key) {
        return KEY.equals(key) || KEY_FOR_LIST.equals(key) || KEY_FOR_NORMAL_ENROLMENTS.equals(key)
                || KEY_FOR_EXTRA_ENROLMENTS.equals(key) || KEY_FOR_STANDALONE_ENROLMENTS.equals(key)
                || KEY_HAS_EXTRA_ENROLMENTS.equals(key) || KEY_HAS_STANDALONE_ENROLMENTS.equals(key);
    }

    @Override
    public Object valueForKey(final String key) {
        if (KEY.equals(key)) {
            return this;
        } else if (KEY_FOR_LIST.equals(key)) {
            return this.getCurriculumEntries();
        } else if (KEY_FOR_NORMAL_ENROLMENTS.equals(key)) {
            return this.getNormalCurriculumEntries();
        } else if (KEY_FOR_EXTRA_ENROLMENTS.equals(key)) {
            return this.getExtraCurriculumEntries();
        } else if (KEY_FOR_STANDALONE_ENROLMENTS.equals(key)) {
            return this.getStandaloneCurriculumEntries();
        } else if (KEY_HAS_EXTRA_ENROLMENTS.equals(key)) {
            return !this.getExtraCurriculumEntries().isEmpty();
        } else if (KEY_HAS_STANDALONE_ENROLMENTS.equals(key)) {
            return !this.getStandaloneCurriculumEntries().isEmpty();
        }

        return null;
    }

    public Set<CurriculumEntry> getCurriculumEntries() {
        if (curriculumEntries == null) {
            curriculumEntries = Sets.newTreeSet(CurriculumEntry.NAME_COMPARATOR(locale));

            Collection<? extends ICurriculumEntry> enrolments = this.registration.getEnrolments(executionYear);
            curriculumEntries.addAll(CurriculumEntry.transform(registration, enrolments, remarksDataProvider));
        }

        return curriculumEntries;
    }

    public Set<CurriculumEntry> getStandaloneCurriculumEntries() {
        if (standaloneCurriculumEntries == null) {
            standaloneCurriculumEntries = Sets.newTreeSet(CurriculumEntry.NAME_COMPARATOR(locale));

            Collection<? extends ICurriculumEntry> enrolmentsAux = this.registration.getEnrolments(executionYear);
            Set<ICurriculumEntry> enrolments = new HashSet<ICurriculumEntry>();

            for (ICurriculumEntry entry : enrolmentsAux) {
                if (((Enrolment) entry).isStandalone() && !standaloneRegistration()) {
                    enrolments.add((ICurriculumEntry) entry);
                }
            }

            standaloneCurriculumEntries
                    .addAll(CurriculumEntry.transform(registration, enrolments, remarksDataProvider));
        }

        return standaloneCurriculumEntries;
    }

    public Set<CurriculumEntry> getExtraCurriculumEntries() {
        if (extraCurriculumEntries == null) {
            extraCurriculumEntries = Sets.newTreeSet(CurriculumEntry.NAME_COMPARATOR(locale));

            Collection<? extends ICurriculumEntry> enrolmentsAux = this.registration.getEnrolments(executionYear);
            Set<ICurriculumEntry> enrolments = new HashSet<ICurriculumEntry>();

            for (ICurriculumEntry entry : enrolmentsAux) {
                if (((Enrolment) entry).isExtraCurricular()) {
                    enrolments.add((ICurriculumEntry) entry);
                }
            }

            extraCurriculumEntries.addAll(CurriculumEntry.transform(registration, enrolments, remarksDataProvider));
        }

        return extraCurriculumEntries;
    }

    public Set<CurriculumEntry> getNormalCurriculumEntries() {
        if (normalCurriculumEntries == null) {
            normalCurriculumEntries = Sets.newTreeSet(CurriculumEntry.NAME_COMPARATOR(locale));

            Collection<? extends ICurriculumEntry> enrolmentsAux = this.registration.getEnrolments(executionYear);
            Set<ICurriculumEntry> enrolments = new HashSet<ICurriculumEntry>();

            for (ICurriculumEntry entry : enrolmentsAux) {
                if (((Enrolment) entry).isExtraCurricular()) {
                    continue;
                }

                if (((Enrolment) entry).isPropaedeutic()) {
                    continue;
                }

                if (!((Enrolment) entry).isStandalone() || registration.getDegree().isEmpty()) {
                    enrolments.add((ICurriculumEntry) entry);
                }
            }

            normalCurriculumEntries
                    .addAll(CurriculumEntry.transform(registration, enrolments, remarksDataProvider));
        }

        return normalCurriculumEntries;
    }

    protected boolean standaloneRegistration() {
        return registration.getDegree().isEmpty();
    }

    @Override
    public void registerFieldsMetadata(IFieldsExporter exporter) {
        // TODO Auto-generated method stub

    }

}