me.vertretungsplan.parser

Class DSBMobileParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.UntisCommonParser

me.vertretungsplan.parser.DSBMobileParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class DSBMobileParser
extends UntisCommonParser

Parser for Untis and DaVinci substitution schedules served by DSBmobile (mobile.dsbcontrol.de).

This parser can be accessed using "dsbmobile" for SubstitutionScheduleData.setApi(String).

Configuration parameters

These parameters can be supplied in SubstitutionScheduleData.setData(JSONObject) to configure the parser:

classes (Array of Strings, required)

The list of all classes, as they can appear in the schedule

type (String, optional)

Can be set to either "untis" or "davinci" to specify which type of schedule is used. By default, the parser tries to detect this automatically, but this does not always work.

scheduleFilter (String, optional)

If this is set, only schedules whose title in DSBmobile matches this regex will be shown

encoding (String, optional)

The charset of the Untis/DaVinci schedule. DSBmobile itself always uses UTF-8, but the hosted HTML schedule can also be ISO-8859-1. Default: UTF-8

Additionally, this parser supports the parameters specified in UntisCommonParser (if it is an Untis schedule). DSBmobile schedules always need a login using a school number and a password. You have to set a SchoolNumberPasswordAuthenticationData which specifies the 6-digit school number.

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

colorProvider, cookieProvider, cookieStore, credential, debuggingDataHandler, encodingDetector, executor, PARAM_CLASS_REGEX, scheduleData

Constructor Summary

Constructors

Constructor and Description
DSBMobileParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Modifier and Type	Method and Description
List<String>	getAllTeachers() Get a list of all available teachers.
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule

Methods inherited from class me.vertretungsplan.parser.UntisCommonParser

getAllClasses, parseSubstitutionTable

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getClassesFromJson, getCredential, getInstance, getLastChange, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, isPersonal, recognizeType, setCredential, setDebuggingDataHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DSBMobileParser

public DSBMobileParser(SubstitutionScheduleData scheduleData,
                       CookieProvider cookieProvider)

Method Detail

getSubstitutionSchedule

public SubstitutionSchedule getSubstitutionSchedule()
                                             throws IOException,
                                                    org.json.JSONException,
                                                    CredentialInvalidException

Description copied from interface: SubstitutionScheduleParser

Downloads and parses the substitution schedule

Specified by:

getSubstitutionSchedule in interface SubstitutionScheduleParser

Specified by:

getSubstitutionSchedule in class BaseParser

Returns:

the parsed SubstitutionSchedule

Throws:

IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException - the supplied credential (BaseParser.setCredential(Credential) is not correct

getAllTeachers

public List<String> getAllTeachers()

Description copied from class: BaseParser

Get a list of all available teachers. Can also be null.

Specified by:

getAllTeachers in class BaseParser

Returns:

a list of all available teachers (also those not currently affected by the substitution schedule)