me.vertretungsplan.parser

Class UntisInfoParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.UntisCommonParser

me.vertretungsplan.parser.UntisInfoParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class UntisInfoParser
extends UntisCommonParser

Parser for substitution schedules in HTML format created by the Untis software using the "Info-Stundenplan" layout. Only substitution schedule tables (often labelled with "Ver-Kla" in the dropdown menu) are supported, not timetables.

Example: AKG Bensheim

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

Configuration parameters

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

baseurl (String, required)

The base URL under which all the HTML files (e.g. default.htm) are located, wthout a slash at the end.

encoding (String, required)

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

classes (Array of Strings, optional)

The list of all classes, as they can appear in the schedule. If this is omitted, classes are automatically determined by parsing JavaScript code in the frames/navbar.htm page.

classSelectRegex (String, optional)

RegEx to modify the classes parsed from JavaScript code in getAllClasses(). The RegEx is matched against the class using Matcher.find(). If the RegEx contains groups, the concatenation of all group results Matcher.group(int) is used as the resulting class. Otherwise, Matcher.group() is used.

removeNonMatchingClasses (Boolean, optional)

If this is set to true, classes parsed from JavaScript in getAllClasses() where classSelectRegex is not found (Matcher.find() returns false) are discarded from the list. Default: false

singleClasses (Boolean, optional)

Set this to true if there is no common substitution schedule for all classes, but separate ones for each class selectable in a dropdown instead. This of course drastically increases the number of HTTP requests needed to load the schedule. Default: "false"

website (String, optional)

The URL of a website where the substitution schedule can be seen online (defaults to baseurl + "/default.htm")

wAfterNumber (Boolean, optional)

Set this to true if the URL of the actual schedules (displayed in a frame) end with 36/w/w00000.htm instead of w/36/w00000.htm. Default: "false"

letter (String, optional, Default: w)

The letter occurring in the URL of the schedule pages. For student schedules, this is almost always a w. Teacher schedules use a v.

scheduleBaseurl (String, optional, Default: same as baseurl)

The url under which the actual schedule HTML files are hosted. In almost all cases you don't need to set it as it's the same as baseurl.

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_BASEURL
static java.lang.String	PARAM_CLASS_SELECT_REGEX
static java.lang.String	PARAM_REMOVE_NON_MATCHING_CLASSES
static java.lang.String	PARAM_W_AFTER_NUMBER

Fields inherited from class me.vertretungsplan.parser.BaseParser

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

Constructor Summary

Constructors

Constructor and Description
UntisInfoParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

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

parseSubstitutionTable, parseSubstitutionTable

Methods inherited from class me.vertretungsplan.parser.BaseParser

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

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_BASEURL

public static final java.lang.String PARAM_BASEURL

See Also:

Constant Field Values

PARAM_CLASS_SELECT_REGEX

public static final java.lang.String PARAM_CLASS_SELECT_REGEX

See Also:

Constant Field Values

PARAM_REMOVE_NON_MATCHING_CLASSES

public static final java.lang.String PARAM_REMOVE_NON_MATCHING_CLASSES

See Also:

Constant Field Values

PARAM_W_AFTER_NUMBER

public static final java.lang.String PARAM_W_AFTER_NUMBER

See Also:

Constant Field Values

Constructor Detail

UntisInfoParser

public UntisInfoParser(SubstitutionScheduleData scheduleData,
                       CookieProvider cookieProvider)

Method Detail

getSubstitutionSchedule

public SubstitutionSchedule getSubstitutionSchedule()
                                             throws java.io.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:

java.io.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 java.util.List<java.lang.String> getAllClasses()
                                               throws org.json.JSONException,
                                                      java.io.IOException,
                                                      CredentialInvalidException

Description copied from class: BaseParser

Get a list of all available classes.

Overrides:

getAllClasses in class UntisCommonParser

Returns:

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

Throws:

org.json.JSONException - Error with the JSON configuration

java.io.IOException - Connection or parsing error

CredentialInvalidException

getAllTeachers

public java.util.List<java.lang.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)