me.vertretungsplan.parser

Class IndiwareStundenplan24Parser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.IndiwareParser

me.vertretungsplan.parser.IndiwareStundenplan24Parser

All Implemented Interfaces:

SubstitutionScheduleParser

public class IndiwareStundenplan24Parser
extends IndiwareParser

Parser for substitution schedules in XML format created by the Indiware software and hosted on Stundenplan24.de. Schools only providing the mobile version ("Indiware mobil") of the schedule instead of the desktop version ("Vertretungsplan") are currently not supported. The parser also supports schedules in the same format hosted on different URLs.

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

Configuration parameters

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

schoolNumber (String, required if baseurl not specified)

The 8-digit school number used to access the schedule. It can be found in the URL.

baseurl (String, required if schoolNumber not specified)

Schedule hosted on a custom URL. The URL normally ends with "/vplan" (without slash at the end).

classes (Array of Strings, required)

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

When specifying schoolNumber, you have to use a UserPasswordAuthenticationData because all schedules on Stundenplan24.de seem to be protected by a login. Schedules on custom URLs may use different kinds of login, in that case the parameters from LoginHandler are supported.

Field Summary

Fields inherited from class me.vertretungsplan.parser.IndiwareParser

data

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

Constructor Summary

Constructors

Constructor and Description
IndiwareStundenplan24Parser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Methods

Modifier and Type	Method and Description
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule

Methods inherited from class me.vertretungsplan.parser.IndiwareParser

getAllClasses, getAllTeachers

Methods inherited from class me.vertretungsplan.parser.BaseParser

contains, getClassesFromJson, getCredential, getInstance, httpGet, httpGet, httpPost, httpPost, httpPost, httpPost, recognizeType, setCredential

Methods inherited from class java.lang.Object

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

Constructor Detail

IndiwareStundenplan24Parser

public IndiwareStundenplan24Parser(SubstitutionScheduleData scheduleData,
                           CookieProvider cookieProvider)

Method Detail

getSubstitutionSchedule

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

Description copied from class: BaseParser

Downloads and parses the substitution schedule

Specified by:

getSubstitutionSchedule in interface SubstitutionScheduleParser

Overrides:

getSubstitutionSchedule in class IndiwareParser

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