me.vertretungsplan.parser

Class UntisMonitorParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.UntisCommonParser

me.vertretungsplan.parser.UntisMonitorParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class UntisMonitorParser
extends UntisCommonParser

Parser for substitution schedules in HTML format created by the Untis software using the "Monitor-Vertretungsplan" layout.

Example: Lornsenschule Schleswig

This parser can be accessed using "untis-monitor" for SubstitutionScheduleData.setApi(String).

Configuration parameters

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

urls (Array of JSONObjects, required)

The URLs of the HTML files of the schedule. There is one file for each day. Each JSONObject has a url parameter specifying the URL and a following parameter to set if the parser should follow HTML meta tag redirects to load multiple pages. If you are using LoginHandler for a HTTP POST login, the url parameter can also be set to "loginResponse"

encoding (String, required)

The charset of the XML 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

website (String, recommended)

The URL of a website where the substitution schedule can be seen online

lastChangeSelector (String, optional)

When this is specified, the date of last change is read from the first HTML element that matches this CSS selector. The CSS selector syntax is supported as specified by JSoup.

embeddedContentSelector (String, optional)

When the Untis schedule is embedded in another HTML file using server-side code, you can use this to specify which HTML elements should be considered as the containers for the Untis schedule. The CSS selector syntax is supported as specified by JSoup.

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

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
UntisMonitorParser(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, 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

UntisMonitorParser

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

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)