me.vertretungsplan.objects.SubstitutionScheduleData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parser Show documentation
Java library for parsing schools' substitution schedules. Supports multiple different systems mainly used in the German-speaking countries.
There is a newer version: 1.0.0-beta356
Show newest version
/*
 * substitution-schedule-parser - Java library for parsing schools' substitution schedules
 * Copyright (c) 2016 Johan v. Forstner
 *
 * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
 * If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package me.vertretungsplan.objects;

import me.vertretungsplan.objects.authentication.AuthenticationData;
import me.vertretungsplan.parser.CookieProvider;
import org.json.JSONObject;

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

/**
 * Contains data about a school's substitution schedule. This has to be provided to a
 * {@link me.vertretungsplan.parser.SubstitutionScheduleParser} instance so that it can parse the schedule.
 */
public class SubstitutionScheduleData {
    private SubstitutionSchedule.Type type;
    private String api;
    private List additionalInfos;
    private JSONObject data;
    private AuthenticationData authenticationData;

    public SubstitutionScheduleData() {
        additionalInfos = new ArrayList<>();
    }

    /**
     * Get the {@link SubstitutionSchedule.Type} of the substitution schedule this data represents
     * @return the type of this schedule
     */
    public SubstitutionSchedule.Type getType() {
        return type;
    }

    /**
     * Set the {@link SubstitutionSchedule.Type} of the substitution schedule this data represents
     * @param type the type of this schedule
     */
    @SuppressWarnings("SameParameterValue")
    public void setType(SubstitutionSchedule.Type type) {
        this.type = type;
    }

    /**
     * Get the type of parser to use for this schedule, as a string representation. This is used by
     * {@link me.vertretungsplan.parser.BaseParser#getInstance(SubstitutionScheduleData, CookieProvider)} to create a
     * suitable parser instance.
     *
     * @return the type of parser to use
     */
    public String getApi() {
        return api;
    }

    /**
     * Set the type of parser to use for this schedule, as a string representation. This information is used by
     * {@link me.vertretungsplan.parser.BaseParser#getInstance(SubstitutionScheduleData, CookieProvider)} to create a
     * suitable parser instance. Currently supported values are:
     * 
     *     {@code "untis-monitor"}
     *     {@code "untis-info"}
     *     {@code "untis-info-headless"}
     *     {@code "untis-subst"}
     *     {@code "dsbmobile"}
     *     {@code "svplan"}
     *     {@code "davinci"}
     *     {@code "turbovertretung"}
     *     {@code "csv"}
     *     {@code "legionboard"}
     * 
     *
     * @param api the type of parser to use
     */
    public void setApi(String api) {
        this.api = api;
    }

    /**
     * Get the types of {@link AdditionalInfo} this schedule should contain. Used by
     * {@link me.vertretungsplan.additionalinfo.BaseAdditionalInfoParser#getInstance(String)} to create a suitable
     * parser instance.
     *
     * @return the set of additional info types
     */
    public List getAdditionalInfos() {
        return additionalInfos;
    }

    /**
     * Set the types of {@link AdditionalInfo} this schedule should contain. Used by
     * {@link me.vertretungsplan.additionalinfo.BaseAdditionalInfoParser#getInstance(String)} to create a suitable
     * parser instance. Currently supported values are:
     * 
     *     {@code "winter-sh"}
     * 
     *
     * @param additionalInfos the additional info types to set
     */
    public void setAdditionalInfos(List additionalInfos) {
        this.additionalInfos = additionalInfos;
    }

    /**
     * Get additional data about this substitution schedule in form of a JSON object. What data is needed here
     * depends on the parser type, see their own documentation in the me.vertretungsplan.parser package.
     *
     * @return additional data about this substitution schedule
     */
    public JSONObject getData() {
        return data;
    }

    /**
     * Set additional data about this substitution schedule in form of a JSON object. What data is needed here
     * depends on the parser type, see their own documentation in the me.vertretungsplan.parser package.
     *
     * @param data additional data about this substitution schedule
     */
    public void setData(JSONObject data) {
        this.data = data;
    }

    /**
     * Get information about what kind of {@link me.vertretungsplan.objects.credential.Credential} is needed to parse
     * this schedule and if there are additional parameters for authentication (such as a pre-set school number with
     * only the password needing to be filled in). If no credential is needed, this should return a
     * {@link me.vertretungsplan.objects.authentication.NoAuthenticationData} instance.
     *
     * @return the authentication data
     */
    public AuthenticationData getAuthenticationData() {
        return authenticationData;
    }

    /**
     * Set information about what kind of {@link me.vertretungsplan.objects.credential.Credential} is needed to parse
     * this schedule and if there are additional parameters for authentication (such as a pre-set school number with
     * only the password needing to be filled in). If no credential is needed, set this to a
     * {@link me.vertretungsplan.objects.authentication.NoAuthenticationData} instance.
     *
     * @param authenticationData the authentication data to set
     */
    public void setAuthenticationData(AuthenticationData authenticationData) {
        this.authenticationData = authenticationData;
    }
}