me.vertretungsplan.parser

Class TurboVertretungParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.TurboVertretungParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class TurboVertretungParser
extends BaseParser

Parser for substitution schedules in HTML format created by the Turbo-Vertretung software.

Example: Goethe-Schule Bochum

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

Configuration parameters

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

urls (Array of Strings, required)

The URLs of the HTML files of the schedule. There is one file for each day.

encoding (String, required)

The charset of the HTML files. It's probably either UTF-8 or ISO-8859-1.

classes (Array of Strings, required)

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

Additionally, this parser supports the parameters specified in LoginHandler for login-protected schedules.

Field Summary

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

Constructor Summary

Constructors

Constructor and Description
TurboVertretungParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Modifier and Type	Method and Description
List<String>	getAllClasses() Get a list of all available classes.
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.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

TurboVertretungParser

public TurboVertretungParser(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

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

getAllClasses

public List<String> getAllClasses()
                           throws IOException,
                                  org.json.JSONException

Description copied from class: BaseParser

Get a list of all available classes.

Specified by:

getAllClasses in class BaseParser

Returns:

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

Throws:

IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

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)