me.vertretungsplan.parser

Class UntisSubstitutionParser

java.lang.Object

me.vertretungsplan.parser.BaseParser

me.vertretungsplan.parser.UntisCommonParser

me.vertretungsplan.parser.UntisSubstitutionParser

All Implemented Interfaces:

SubstitutionScheduleParser

public class UntisSubstitutionParser
extends UntisCommonParser

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

Example: JKG Stuttgart

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

Configuration parameters

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

baseurl (String, required if urls not specified)

The URL of the home page of the substitution schedule where the selection of classes is found. If the URL contains the date, you can use something like {date(yyyy-MM-dd)} in the URL. This placeholder will then be replaced with the dates of the next 7 days.

urls (Array of strings, required if baseurl not specified)

The URLs of the home pages of the substitution schedule where the selection of classes is found. If the URL contains the date, you can use something like {date(yyyy-MM-dd)} in the URL. This placeholder will then be replaced with the dates of the next 7 days.

encoding (String, required)

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

columns (Array of Strings, required)

As defined in UntisCommonParser, but additionally supports "columns" as a column type.

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

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, debuggingDataHandler, encodingDetector, executor, PARAM_CLASS_REGEX, sardine, scheduleData

Constructor Summary

Constructors

Constructor and Description
UntisSubstitutionParser(SubstitutionScheduleData scheduleData, CookieProvider cookieProvider)

Method Summary

Modifier and Type	Method and Description
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

getAllClasses, 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

Constructor Detail

UntisSubstitutionParser

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

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)